How To Convert a UserBase Manual to Docbook/fr: Difference between revisions

From KDE UserBase Wiki
(Created page with "* Renommer <tt>Manual.xml.docbook</tt> en <tt>index.docbook</tt>.")
(Created page with "{{Warning/fr|1=A un certain moment du passé, il fût nécessaire d'ajouter une ligne contenant <br /><code>144.76.227.197 userbase.kde.org</code><br /> à <tt>/etc/hosts</tt...")
 
(41 intermediate revisions by 2 users not shown)
Line 110: Line 110:
{{Tip/fr|1=Vous pouvez obtenir la liste complète des pages pour votre application à l'aide du script suivant :<!--}}-->
{{Tip/fr|1=Vous pouvez obtenir la liste complète des pages pour votre application à l'aide du script suivant :<!--}}-->


{{Input|1=<nowiki><DPL>
{{Input/fr|1=<nowiki><DPL>
  nottitlematch = %/__|%/zh-%|%(%)
  nottitlematch = %/__|%/zh-%|%pt-%|%(%)
   titlematch = Amarok%
   titlematch = Appname/Manual%
   namespace = Main
   namespace =  
   columns = 1
   columns = 1
   format = ,\n* [[%PAGE%|%TITLE%]],,
   format = ,\n* [[%PAGE%|%TITLE%]],,
Line 120: Line 120:
<!--{{-->Remplacez '''''Amarok''''' par le nom de votre application, mettez le sur votre page utilisateur, et cliquez sur   
<!--{{-->Remplacez '''''Amarok''''' par le nom de votre application, mettez le sur votre page utilisateur, et cliquez sur   
<menuchoice>Aperçu</menuchoice>. Réordonnez la liste en fonction de la table des matières de votre manuel.
<menuchoice>Aperçu</menuchoice>. Réordonnez la liste en fonction de la table des matières de votre manuel.
}}
{{Note/fr|1=Si vous travaillez avec la manuel Amarok, soyez conscient qu'il ne se conforme pas complètement aux conventions de nommage des pages du manuel. Vous pouvez utiliser
{{Input/fr|1= titlematch = Amarok/Manual%{{!}}Amarok/QuickStartGuide%}}
(Note: aucun espace dans l'expression du titre!)
}}
}}


Line 139: Line 144:
* Copier <tt>Manual.xml</tt> dans le répertooire du script.
* Copier <tt>Manual.xml</tt> dans le répertooire du script.


* Ajouter une ligne contenant {{Input/fr|1=144.76.227.197 userbase.kde.org}} dans le fichier <tt>/etc/hosts</tt> (il vous faudra des droits root pour cela - à ne faire qu'une fois -).  
* Lancez {{Input/fr|1=python wiki2docbook.py Manual.xml}} si vous voulez télécharger toutes les captures d'écran (cela prend du temps de ramener toutes les images de UserBase, grep et wget doivent être installés), ou {{Input/fr|1=python wiki2docbook.py -s Manual.xml}} si vous avez seulement besoin de ramener les images.


* Run {{Input|1=python wiki2docbook.py Manual.xml}} if you want to download all screenshots (it takes some time to download all images from UserBase, grep and wget should be installed), or {{Input|1=python wiki2docbook.py -s Manual.xml}} if you need not to download images.
{{Warning/fr|1=A un certain moment du passé, il fût nécessaire d'ajouter une ligne contenant <br /><code>144.76.227.197 userbase.kde.org</code><br /> à  <tt>/etc/hosts</tt> pour accéder à UserBase à partir de scripts. Ce n'est plus le cas. Si vous avez déjà ajouté une telle ligne à votre <tt>/etc/hosts</tt>, alors il faudra l'enlever de nouveau.}}


=== Post-traitement ===
=== Post-traitement ===
Line 147: Line 152:
* Renommer <tt>Manual.xml.docbook</tt> en <tt>index.docbook</tt>.
* Renommer <tt>Manual.xml.docbook</tt> en <tt>index.docbook</tt>.


* Check if conversion was done correctly: {{Input|1=checkXML index.docbook}}
* Vérifiez si la conversion s'est bien déroulée : {{Input/fr|1=checkXML index.docbook}}


* Corrigez les erreurs (mieux sur les pages UserBase).
* Corrigez les erreurs (mieux sur les pages UserBase).
Line 153: Line 158:
* Convertissez le docbook en HTML: {{Input/fr|1=meinproc4 index.docbook}}
* Convertissez le docbook en HTML: {{Input/fr|1=meinproc4 index.docbook}}


* Check HTML pages (all images should be visible, links should not lead to 404-pages).
* Vérifiez les pages HTML (toutes les images doivent être visibles, les liens ne doivent pas vers des pages 404).


* Replace big images by thumbnails using '''convert''' from '''ImageMagick'''
* Remplacer les grandes images par des vignettes en utilisant '''convert''' de '''ImageMagick'''


* Fix links in docbook, so they lead to docbook section, not UserBase pages.
* Corriger les liens dans le docbook, de sorte à ce qu'ils conduisent vers des sections du docbook, et non pas vers des pages de UserBase.


* Fix application name according to KDE entity list.
* Corriger le nom de l'application en fonction de la liste des entités KDE.


* Copy <tt>index.docbook</tt> and images to your <tt>/doc</tt> folder and commit them to repository.
* Copiez <tt>index.docbook</tt> et les images dans votre répertoire <tt>/doc</tt> et validez les dans le dépôt.
[[File:K3b_docs.png|350px|center|thumb|K3b docs on UserBase in Opera and converted page in Konqueror.]]
[[File:K3b_docs.png|350px|center|thumb|Documents K3b de UserBase dans Opera et la page convertie dans Konqueror.]]


== Updating Your DocBook from UserBase ==
== Mettre à jour votre DocBook à partir de UserBase ==


To update your converted docbook please use the following procedure:
Pour mettre à jour votre docbook converti, veuillez utiliser la procédure suivante :


* Re-export XML from UserBase. See [[Special:myLanguage/How_To_Convert_a_UserBase_Manual_to_Docbook#Export|Export]] section.
* Réexportez le XML de UserBase. Voir la section [[Special:myLanguage/How_To_Convert_a_UserBase_Manual_to_Docbook#Export|Export]] .


* Use the script to update the content (headers with abstract and keywords and footer will be kept): {{Input|1= python wiki2docbook.py -r index.docbook Manual.xml}}
* Utilisez le script pour mettre à jour le contenu (les entêtes avec le résumé, les mots-clé et les pieds de page seront conservés) : {{Input/fr |1= python wiki2docbook.py -r index.docbook Manual.xml}}


* Check the docbook, rename the file into index.docbook and commit it with screenshots into your repository.
* Vérifiez le docbook, renommez le fichier en index.docbook et validez le avec les captures d'écran dans votre dépôt.


== Convertir le DocBook vers un autre format ==
== Convertir le DocBook vers un autre format ==
Line 178: Line 183:
=== Convertir en PDF ===
=== Convertir en PDF ===


Usually, there is no need to convert DocBook manually. You can download the converted PDFs from [http://docs.kde.org/ KDE Documentation] site.
Habituellement, il n'y a pas besoin de convertir le DocBook manuellement. Vous pouvez télécharger les PDF convertis à partir du site de [http://docs.kde.org/ Documentation KDE] .
 
Should you need additional customization please do as follows:


* Make sure that you have some '''LaTeX''' distribution installed (usually, TeXLive).
Si vous avez besoin d'adaptations supplémentaires, voici comment faire :


* Create the following script file (named <tt>buildpdf.sh</tt>) in your DocBook directory:
* Assurez-vous qu'il y ait une distribution '''LaTeX''' d'installée (d'ordinaire, TeXLive).


<!--}}-->{{Input|1=
* Créez le fichier script suivant (nommé <tt>buildpdf.sh</tt>) dans votre répertoire DocBook :
{{Input|1=
<syntaxhighlight lang="bash">#!/bin/bash
<syntaxhighlight lang="bash">#!/bin/bash


export SGML_CATALOG_FILES=/usr/share/sgml/docbook/sqml-dtd-4.2/catalog:/usr/share/apps/ksgmltools2/customization/catalog.xml:/usr/share/sgml/docbook/xml-dtd-4.2/docbook
export SGML_CATALOG_FILES=/usr/share/sgml/docbook/sqml-dtd-4.5/catalog:/usr/share/kf5/kdoctools/customization/catalog.xml:/usr/share/sgml/docbook/xml-dtd-4.5/docbook
 
# add -d to command below to keep the /tmp folder, so you can examine the generated tex.
# add -d to command below to keep the /tmp folder, so you can examine the generated tex.
./dblatex-cvs-install/bin/dblatex -d -b pdftex --style \
./dblatex-cvs-install/bin/dblatex -d -b pdftex --style \
Line 200: Line 203:
-I $KDEDIR/share/doc/HTML/en/ \
-I $KDEDIR/share/doc/HTML/en/ \
-X \
-X \
         $1</syntaxhighlight>}}<!--{{-->
         $1</syntaxhighlight>}}
 
* Téléchargez les styles KDE :
* Download KDE styles:
{{Input/fr|1=<nowiki>git clone git://anongit.kde.org/websites/docs-kde-org.git</nowiki>}}
{{Input|1=<nowiki>git clone git://anongit.kde.org/websites/docs-kde-org.git</nowiki>}}


* Tweak <tt>dblatex-cvs-install/bin/dblatex</tt> in like this
* Ajustez <tt>dblatex-cvs-install/bin/dblatex</tt> ainsi


<!--}}-->{{Input|1=
<!--}}-->{{Input|1=
Line 215: Line 217:
/path/to/your/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*</syntaxhighlight>}}<!--{{-->
/path/to/your/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*</syntaxhighlight>}}<!--{{-->


(Change '''''/path/to/your/''''' as appropriate)
(adaptez '''''/path/to/your/''''' à la réalité)


* Copy KDE styles (/dblatex-cvs-install/share/dblatex/latex/contrib/) to some TeX dir where it can be found by '''LaTeX''' installation (I have copied them to <tt>/usr/share/texmf-dist/tex/latex/kde</tt>).
* Copiez les styles KDE (/dblatex-cvs-install/share/dblatex/latex/contrib/) vers un répertoire TeX quelconque où il pourra être vu par l'installation de '''LaTeX''' (personnellement, je les ai copiés dans <tt>/usr/share/texmf-dist/tex/latex/kde</tt>).


* Update paths with <code>mktexlsr</code> from root.
* Mettez à jour les chemins avec <code>mktexlsr</code> à partir de la racine.


* Run <code>./buildpdf.sh index.docbook</code>. This should create ready-to-use PDF file for you. You can stop on this step if you do not want to tweak it.  
* Lancez <code>./buildpdf.sh index.docbook</code>. Ceci doit créer pour vous, un fichier PDF prêt à l'usage. Vous pouvez arrêter à cette étape si vous ne voulez pas le refaire.  


* Copy all files from <tt>/tmp/tpb-'''''your_user'''''-'''''digits'''''</tt> to the work directory.
* Copiez tous les fichier de <tt>/tmp/tpb-'''''nom_utilisateur'''''-'''''chiffres'''''</tt> vers le répertoire de travail.


* Customize and edit <tt>tex</tt> file in [[Special:MyLanguage/Kile|Kile]] as appropriate.
* Adaptez et modifiez le fichier <tt>tex</tt> dans [[Special:MyLanguage/Kile|Kile]] de manière adéquate.


* Compile PDF file with <keycap>Alt + 6</keycap>.
* Compilez le fichier PDF avec <keycap>Alt + 6</keycap>.


=== Conversion en EPUB ===
=== Conversion en EPUB ===


* Make sure that '''Calibre''' is installed in your system.
* Assurez-vous que '''Calibre''' est installé sur votre système.


* Convert your DocBook into HTML first. Use <code>meinproc4 index.docbook</code> for this.
* Convertissez votre DocBook en HTML d'abord. Utilisez <code>meinproc4 index.docbook</code> pour cela.


* Start '''Calibre''' and choose <menuchoice>Add books</menuchoice>.
* Démarrez '''Calibre''' et choisissez <menuchoice>Ajouter des livres</menuchoice>.


* Select <tt>index.html</tt> in your DocBook folder. Wait until the book is loaded.
* Choisissez <tt>index.html</tt> dans votre répertoire DocBook . Attendez le chargement du livre.


* Choisissez <menuchoice>Convertir les livres</menuchoice>.
* Choisissez <menuchoice>Convertir les livres</menuchoice>.
Line 243: Line 245:
* Remplissez les champs métadata de manière adéquate.
* Remplissez les champs métadata de manière adéquate.


[[File:calibre.png|350px|center|thumb|Calibre conversion configuration page.]]
[[File:calibre.png|350px|center|thumb|Page de configuration de la conversion Calibre.]]


* Press <menuchoice>OK</menuchoice> and wait until the work is done.
* Cliquez sur <menuchoice>OK</menuchoice> et attendez la fin d'exécution.


* Copiez le livre de <tt>~/Calibre Library</tt> vers votre lecteur de livres électroniques.
* Copiez le livre de <tt>~/Calibre Library</tt> vers votre lecteur de livres électroniques.


[[Category:Contribuer/fr]]
[[Category:Contribuer/fr]]

Latest revision as of 16:40, 24 October 2019

Other languages:

Préface

Le processus actuel n'est pas encore peaufiné, le code du script est sale, pas assez intelligent, etc ... La seule excuse est qu'il fonctionne quand même .

Si vous voulez améliorer le processus, que vous avez une bonne expérience de Python, et que vous connaissez les principes du maniement de docbook, vous pouvez améliorer la procédure. Veuillez contacter Yurchor si vous vous sentez en mesure d'apporter votre aide.

Préparer les pages pour la conversion

  • Vérifiez dans la table des matières, que chaque page a son titre indenté conformément au niveau qu'elle doit avoir.
Tableau de référence
UserBase Docbook Commentaire
==Section== <chapter>
===Section=== <sect1>
====Section==== <sect2>
=====Section===== <sect3>
======Section====== <sect4> Ne pas utiliser ce dernier niveau dans la mesure du possible
  • Vérifiez que toutes les cellules des tableaux on un espace après la barre verticale de séparation '|' . Cette règle est conforme au formatage usuel du wiki.
  • Utilisez des noms d'application qui ont un format cohérent (évitez Amaroks, mais utilisez Amarok's).
  • Vérifiez que toutes les images sont au format PNG.
  • Enlevez tous les caractères non imprimables présents dans le nom des images.

Exporter

  • Préparer la liste des pages (extrait des adresses UserBase http://userbase.kde.org). Exemple pour Amarok :
Amarok/Manual/Introduction
Amarok/QuickStartGuide
Amarok/QuickStartGuide/GettingStarted
Amarok/QuickStartGuide/TheAmarokWindow
Amarok/QuickStartGuide/TheMusicCollection
Amarok/QuickStartGuide/Playlists
Amarok/QuickStartGuide/TheContextView
Amarok/QuickStartGuide/HowToDealWithProblems
Amarok/QuickStartGuide/Glossary
Amarok/Manual/AmarokWindow
Amarok/Manual/AmarokWindow/Toolbar
Amarok/Manual/AmarokWindow/MediaSources
Amarok/Manual/AmarokWindow/ContextPane
Amarok/Manual/AmarokWindow/PlaylistPane
Amarok/Manual/ConfiguringAmarok
Amarok/Manual/ConfiguringAmarok/ChangingLayout
Amarok/Manual/Organization
Amarok/Manual/Organization/Collection
Amarok/Manual/Organization/CollectionScanning
Amarok/Manual/Organization/Collection/SearchInCollection
Amarok/Manual/Organization/Collection/OrganizeCollection
Amarok/Manual/Organization/Collection/RemoteCollections
Amarok/Manual/Organization/Collection/RemoteCollections/Ampache
Amarok/Manual/Organization/Collection/RemoteCollections/DAAP
Amarok/Manual/Organization/Collection/RemoteCollections/Samba
Amarok/Manual/Organization/Collection/RemoteCollections/UPnP
Amarok/Manual/Organization/Collection/ExternalDatabase
Amarok/Manual/Organization/Collection/WorkingWithMediaDevices
Amarok/Manual/Organization/CoverManager
Amarok/Manual/Organization/TagEditor
Amarok/Manual/Organization/Transcoding
Amarok/Manual/Organization/ScriptManager
Amarok/Manual/Playlist
Amarok/Manual/Playlist/SavedPlaylists
Amarok/Manual/Playlist/PlaylistFiltering
Amarok/Manual/Playlist/QueueManager
Amarok/Manual/Playlist/DynamicPlaylists
Amarok/Manual/Playlist/AutomaticPlaylistGenerator
Amarok/Manual/Various
Amarok/Manual/Various/Moodbar
Amarok/Manual/Various/AmarokOnOtherPlatforms
Amarok/Manual/Various/AmarokOnOtherPlatforms/NonKDE Desktops
Amarok/Manual/Various/AmarokOnOtherPlatforms/Windows
Amarok/Manual/Various/AmarokOnOtherPlatforms/OSX
Amarok/Manual/Various/TroubleshootingAndCommonProblems
Amarok/Manual/Various/FAQ
Amarok/Manual/References
Amarok/Manual/References/MenuAndCommandReference
Amarok/Manual/References/MenuAndCommandReference/AmarokMenu
Amarok/Manual/References/MenuAndCommandReference/ViewMenu
Amarok/Manual/References/MenuAndCommandReference/Playlist
Amarok/Manual/References/MenuAndCommandReference/Tools
Amarok/Manual/References/MenuAndCommandReference/Settings
Amarok/Manual/References/MenuAndCommandReference/Help
Amarok/Manual/References/KeybindingReference
Amarok/Manual/References/KeybindingReference/GlobalShortcuts
Amarok/Manual/References/KeybindingReference/AmarokShortcuts
Amarok/Manual/References/Credits and License

Astuce

Vous pouvez obtenir la liste complète des pages pour votre application à l'aide du script suivant : 
<DPL>
   nottitlematch = %/__|%/zh-%|%pt-%|%(%)
  titlematch = Appname/Manual%
  namespace = 
  columns = 1
  format = ,\n* [[%PAGE%|%TITLE%]],,
</DPL>

Remplacez Amarok par le nom de votre application, mettez le sur votre page utilisateur, et cliquez sur

Aperçu. Réordonnez la liste en fonction de la table des matières de votre manuel.


Remarque

Si vous travaillez avec la manuel Amarok, soyez conscient qu'il ne se conforme pas complètement aux conventions de nommage des pages du manuel. Vous pouvez utiliser 
titlematch = Amarok/Manual%|Amarok/QuickStartGuide%
(Note: aucun espace dans l'expression du titre!)


  • Incluez la liste des pages dans le champ texte plus grand .
  • Cliquez sur Exporter.
Export des pages du manuel Amarok
  • Sauvegardez le fichier. Dans ce qui suit, le fichier sauvegardé sera appelé Manual.xml .

Conversion

  • Installer le package Subversion pour votre système .
  • Extrayez la dernière version du script de conversion : 
    svn checkout --depth=files svn://anonsvn.kde.org/home/kde/branches/work/doc/
  • Copier Manual.xml dans le répertooire du script.
  • Lancez 
    python wiki2docbook.py Manual.xml
    si vous voulez télécharger toutes les captures d'écran (cela prend du temps de ramener toutes les images de UserBase, grep et wget doivent être installés), ou 
    python wiki2docbook.py -s Manual.xml
    si vous avez seulement besoin de ramener les images.

Attention

A un certain moment du passé, il fût nécessaire d'ajouter une ligne contenant
144.76.227.197 userbase.kde.org
à /etc/hosts pour accéder à UserBase à partir de scripts. Ce n'est plus le cas. Si vous avez déjà ajouté une telle ligne à votre /etc/hosts, alors il faudra l'enlever de nouveau.


Post-traitement

  • Renommer Manual.xml.docbook en index.docbook.
  • Vérifiez si la conversion s'est bien déroulée : 
    checkXML index.docbook
  • Corrigez les erreurs (mieux sur les pages UserBase).
  • Convertissez le docbook en HTML: 
    meinproc4 index.docbook
  • Vérifiez les pages HTML (toutes les images doivent être visibles, les liens ne doivent pas vers des pages 404).
  • Remplacer les grandes images par des vignettes en utilisant convert de ImageMagick
  • Corriger les liens dans le docbook, de sorte à ce qu'ils conduisent vers des sections du docbook, et non pas vers des pages de UserBase.
  • Corriger le nom de l'application en fonction de la liste des entités KDE.
  • Copiez index.docbook et les images dans votre répertoire /doc et validez les dans le dépôt.
Documents K3b de UserBase dans Opera et la page convertie dans Konqueror.

Mettre à jour votre DocBook à partir de UserBase

Pour mettre à jour votre docbook converti, veuillez utiliser la procédure suivante :

  • Réexportez le XML de UserBase. Voir la section Export .
  • Utilisez le script pour mettre à jour le contenu (les entêtes avec le résumé, les mots-clé et les pieds de page seront conservés) : 
    python wiki2docbook.py -r index.docbook Manual.xml
  • Vérifiez le docbook, renommez le fichier en index.docbook et validez le avec les captures d'écran dans votre dépôt.

Convertir le DocBook vers un autre format

Convertir en PDF

Habituellement, il n'y a pas besoin de convertir le DocBook manuellement. Vous pouvez télécharger les PDF convertis à partir du site de Documentation KDE .

Si vous avez besoin d'adaptations supplémentaires, voici comment faire :

  • Assurez-vous qu'il y ait une distribution LaTeX d'installée (d'ordinaire, TeXLive).
  • Créez le fichier script suivant (nommé buildpdf.sh) dans votre répertoire DocBook :
#!/bin/bash

export SGML_CATALOG_FILES=/usr/share/sgml/docbook/sqml-dtd-4.5/catalog:/usr/share/kf5/kdoctools/customization/catalog.xml:/usr/share/sgml/docbook/xml-dtd-4.5/docbook
# add -d to command below to keep the /tmp folder, so you can examine the generated tex.
./dblatex-cvs-install/bin/dblatex -d -b pdftex --style \
	kdestyle\
	-o $(pwd | awk -F/ '{ print $NF }').pdf \
	-P latex.output.revhistory=0  -P newtbl.use=1 \
	-P imagedata.default.scale=pagebound \
	-P literal.width.ignore=1 \
	-I $KDEDIR/share/doc/HTML/en/ \
	-X \
        $1
  • Téléchargez les styles KDE :
git clone git://anongit.kde.org/websites/docs-kde-org.git
  • Ajustez dblatex-cvs-install/bin/dblatex ainsi
#!/bin/sh

TEXINPUTS=:/path/to/your/dblatex-cvs-install/share/dblatex/latex//:$TEXINPUTS
export TEXINPUTS

/path/to/your/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*

(adaptez /path/to/your/ à la réalité)

  • Copiez les styles KDE (/dblatex-cvs-install/share/dblatex/latex/contrib/) vers un répertoire TeX quelconque où il pourra être vu par l'installation de LaTeX (personnellement, je les ai copiés dans /usr/share/texmf-dist/tex/latex/kde).
  • Mettez à jour les chemins avec mktexlsr à partir de la racine.
  • Lancez ./buildpdf.sh index.docbook. Ceci doit créer pour vous, un fichier PDF prêt à l'usage. Vous pouvez arrêter à cette étape si vous ne voulez pas le refaire.
  • Copiez tous les fichier de /tmp/tpb-nom_utilisateur-chiffres vers le répertoire de travail.
  • Adaptez et modifiez le fichier tex dans Kile de manière adéquate.
  • Compilez le fichier PDF avec Alt + 6.

Conversion en EPUB

  • Assurez-vous que Calibre est installé sur votre système.
  • Convertissez votre DocBook en HTML d'abord. Utilisez meinproc4 index.docbook pour cela.
  • Démarrez Calibre et choisissez Ajouter des livres.
  • Choisissez index.html dans votre répertoire DocBook . Attendez le chargement du livre.
  • Choisissez Convertir les livres.
  • Remplissez les champs métadata de manière adéquate.
Page de configuration de la conversion Calibre.
  • Cliquez sur OK et attendez la fin d'exécution.
  • Copiez le livre de ~/Calibre Library vers votre lecteur de livres électroniques.
Retrieved from "https://userbase.kde.org/index.php?title=How_To_Convert_a_UserBase_Manual_to_Docbook/fr&oldid=442280"