View View source History

Difference between revisions of "How To Convert a UserBase Manual to Docbook/pt-br"

Jump to: navigation, search
(Created page with "===Exportar===")
(Created page with "* Copie <tt>index.docbook</tt> e imagens para sua pasta <tt>/doc</tt> e faça o commit deles para o repositório. [[File:K3b_docs.png|350px|center|thumb|Os documentos do K3b no U...")
 
(24 intermediate revisions by the same user not shown)
Line 46: Line 46:
 
===Exportar===  
 
===Exportar===  
  
−
* Prepare the page list (strip from UserBase addresses <nowiki>http://userbase.kde.org</nowiki>). Example for '''Amarok''':
+
* Prepare a lista da página (lista de endereço do UserBase <nowiki>http://userbase.kde.org</nowiki>). Exemplo para '''Amarok''':
  
 
{{Input|1=Amarok
 
{{Input|1=Amarok
Line 101: Line 101:
 
Amarok/Manual/Credits_and_License}}
 
Amarok/Manual/Credits_and_License}}
  
−
{{Tip|1=You can obtain the full list of pages for your application with the following script:<!--}}-->
+
{{Tip|1=Você pode obter a lista completa de páginas para seu aplicativo com o seguinte script:<!--}}-->
  
 
{{Input|1=<nowiki><DPL>
 
{{Input|1=<nowiki><DPL>
Line 111: Line 111:
 
</DPL></nowiki>}}
 
</DPL></nowiki>}}
  
−
<!--{{-->Replace '''''Amarok''''' with the name of your application, put it on your user page, and click on <menuchoice>Preview</menuchoice>. Rearrange the list according to the ToC of your manual.
+
<!--{{-->Substitua '''''Amarok''''' pelo nome de seu aplicativo, coloque na sua página de usuário e clique em <menuchoice>Preview</menuchoice>. Reorganize a lista de acordo com o ToC de seu manual.
 
}}
 
}}
  
−
* Go to the [[Special:Export|export page]].
+
* Vá para [[Special:Export|página de exportação]].
  
−
* Paste the page list into the <menuchoice>bigger</menuchoice> text field.
+
* Cole a lista de página dentro do campo de texto <menuchoice>maior</menuchoice>.
  
−
* Click on <menuchoice>Export</menuchoice>.
+
* Clique em <menuchoice>Export</menuchoice>.
−
[[File:XML_export.png|350px|center|thumb|Export of Amarok manual pages]]
+
[[File:XML_export.png|350px|center|thumb|Exportação manual de páginas do Amarok]]
  
−
* Save the file. The saved file will be called <tt>Manual.xml</tt> in what follows.
+
* Salve o arquivo. O arquivo salvo será chamado no <tt>Manual.xml</tt> que se segue.
  
−
===Conversion===  
+
===Conversão===  
  
−
* Install Subversion package for your system.
+
* Instale o pacote Subversion para seu sistema.
  
−
* Checkout the latest version of conversion script: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
+
* Faça o checkout da última versão do script de conversão: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
  
−
* Copy <tt>Manual.xml</tt> to the script folder.
+
* Copie <tt>Manual.xml</tt> para a pasta de script.
  
−
* 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.
+
* Execute {{Input|1=python wiki2docbook.py Manual.xml}} se você deseja baixar todos os screenshots (leva algum tempo para baixar todas as imagens do UserBase, grep e wget devem estar instalados) ou execute {{Input|1=python wiki2docbook.py -s Manual.xml}} se você não precisa baixar as imagens.
  
−
===Post-processing===  
+
===Pós-processamento===  
  
−
* Rename <tt>Manual.xml.docbook</tt> to <tt>index.docbook</tt>.
+
* Renomeie <tt>Manual.xml.docbook</tt> para <tt>index.docbook</tt>.
  
−
* Check if conversion was done correctly: {{Input|1=checkXML index.docbook}}
+
* Verifique se a conversão foi feita corretamente: {{Input|1=checkXML index.docbook}}
  
−
* Fix the errors (better on UserBase pages).
+
* Corrija os erros (melhor em páginas do UserBase).
  
−
* Convert docbook to HTML: {{Input|1=meinproc4 index.docbook}}
+
* Converta docbook para HTML: {{Input|1=meinproc4 index.docbook}}
  
−
* Check HTML pages (all images should be visible, links should not lead to 404-pages).
+
* Verifique as páginas HTML (todas as imagens deve ser visíveis, links não devem levar a páginas 404).
  
−
* Replace big images by thumbnails using '''convert''' from '''ImageMagick'''
+
* Substitua imagens grandes por miniaturas usando o '''convert''' do '''ImageMagick'''
  
−
* Fix links in docbook, so they lead to docbook section, not UserBase pages.
+
* Corrija os links no docbook, assim eles levarão à seção do docbook, não a páginas do UserBase.
  
−
* Fix application name according to KDE entity list.
+
* Corrija o nome dos aplicativos de acordo com a lista do KDE.
  
−
* Copy <tt>index.docbook</tt> and images to your <tt>/doc</tt> folder and commit them to repository.
+
* Copie <tt>index.docbook</tt> e imagens para sua pasta <tt>/doc</tt> e faça o commit deles para o repositório.
−
[[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|Os documentos do K3b no UserBase no Opera e a página convertida no Konqueror.]]
  
 
[[Category:Translator_Help]]
 
[[Category:Translator_Help]]

Latest revision as of 14:04, 29 April 2012

Other languages:
English • ‎suomi • ‎Nederlands • ‎português do Brasil • ‎українська

Prefácio

O processo atual não é refinado, o código do script é feio, não inteligente o suficiente, etc... A única desculpa é que de algum modo ele funciona Face-smile.png

.

Se você deseja melhorar o processo, tem bons conhecimentos de Python e sabe os princípios de criação do docbook, você pode melhorar o procedimento. Por favor, entre em contato com Yurchor se você puder ajudar.

Preparando páginas para a conversão

  • Verifique se cada página tem seu título de acordo com o nível da página na tabela de conteúdo.
Reference table
UserBase Docbook Comment
==Section== <chapter>
===Section=== <sect1>
====Section==== <sect2>
=====Section===== <sect3>
======Section====== <sect4> Evite usar esse último nível se possível
  • Faça uma formatação consistente do nome do aplicativo (evite usar Amaroks, use Amarok's).
  • Se certifique para que todas as imagens estejam no formato PNG.
  • Remover todos os caracteres não imprimíveis dos nomes da imagem.

Exportar

  • Prepare a lista da página (lista de endereço do UserBase http://userbase.kde.org). Exemplo para Amarok:
Amarok
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/AdvancedFeatures
Amarok/Manual/AdvancedFeatures/CollectionScanning
Amarok/Manual/AdvancedFeatures/CoverManager
Amarok/Manual/AdvancedFeatures/DynamicPlaylists
Amarok/Manual/AdvancedFeatures/AutomaticPlaylistGenerator
Amarok/Manual/AdvancedFeatures/ExternalDatabase
Amarok/Manual/AdvancedFeatures/AFT
Amarok/Manual/AdvancedFeatures/Moodbar
Amarok/Manual/AdvancedFeatures/WorkingWithMediaDevices
Amarok/Manual/AdvancedFeatures/SavedPlaylists
Amarok/Manual/AdvancedFeatures/PlaylistFiltering
Amarok/Manual/AdvancedFeatures/QueueManager
Amarok/Manual/AdvancedFeatures/SearchInCollection
Amarok/Manual/AdvancedFeatures/TagEditor
Amarok/Manual/AdvancedFeatures/OrganizeCollection
Amarok/Manual/AdvancedFeatures/Transcoding
Amarok/Manual/AdvancedFeatures/ScriptManager
Amarok/Manual/AdvancedFeatures/RemoteCollections
Amarok/Manual/AdvancedFeatures/RemoteCollections/Ampache
Amarok/Manual/AdvancedFeatures/RemoteCollections/DAAP
Amarok/Manual/AdvancedFeatures/RemoteCollections/Samba
Amarok/Manual/AdvancedFeatures/RemoteCollections/UPnP
Amarok/Manual/MenuAndCommandReference/AmarokMenu
Amarok/Manual/MenuAndCommandReference/ViewMenu
Amarok/Manual/MenuAndCommandReference/Playlist
Amarok/Manual/MenuAndCommandReference/Tools
Amarok/Manual/MenuAndCommandReference/Settings
Amarok/Manual/MenuAndCommandReference/Help
Amarok/Manual/KeybindingReference
Amarok/Manual/KeybindingReference/GlobalShortcuts
Amarok/Manual/KeybindingReference/AmarokShortcuts
Amarok/Manual/TroubleshootingAndCommonProblems
Amarok/Manual/AmarokOnOtherPlatforms/Non-KDE Desktops
Amarok/Manual/AmarokOnOtherPlatforms/Windows
Amarok/Manual/AmarokOnOtherPlatforms/OSX
Amarok/Manual/FAQ
Amarok/Manual/Credits_and_License
Ktip.png
 
Tip
Você pode obter a lista completa de páginas para seu aplicativo com o seguinte script: 
<DPL>
  nottitlematch = %/__|%/zh-%|%(%)
  titlematch = Amarok%
  namespace = Main
  columns = 1
  format = ,\n* [[%PAGE%|%TITLE%]],,
</DPL>
Substitua Amarok pelo nome de seu aplicativo, coloque na sua página de usuário e clique em Preview. Reorganize a lista de acordo com o ToC de seu manual.


  • Cole a lista de página dentro do campo de texto maior.
  • Clique em Export.
Exportação manual de páginas do Amarok
  • Salve o arquivo. O arquivo salvo será chamado no Manual.xml que se segue.

Conversão

  • Instale o pacote Subversion para seu sistema.
  • Faça o checkout da última versão do script de conversão: 
    svn checkout --depth=files svn://anonsvn.kde.org/home/kde/branches/work/doc/
  • Copie Manual.xml para a pasta de script.
  • Execute 
    python wiki2docbook.py Manual.xml
    se você deseja baixar todos os screenshots (leva algum tempo para baixar todas as imagens do UserBase, grep e wget devem estar instalados) ou execute 
    python wiki2docbook.py -s Manual.xml
    se você não precisa baixar as imagens.

Pós-processamento

  • Renomeie Manual.xml.docbook para index.docbook.
  • Verifique se a conversão foi feita corretamente: 
    checkXML index.docbook
  • Corrija os erros (melhor em páginas do UserBase).
  • Converta docbook para HTML: 
    meinproc4 index.docbook
  • Verifique as páginas HTML (todas as imagens deve ser visíveis, links não devem levar a páginas 404).
  • Substitua imagens grandes por miniaturas usando o convert do ImageMagick
  • Corrija os links no docbook, assim eles levarão à seção do docbook, não a páginas do UserBase.
  • Corrija o nome dos aplicativos de acordo com a lista do KDE.
  • Copie index.docbook e imagens para sua pasta /doc e faça o commit deles para o repositório.
Os documentos do K3b no UserBase no Opera e a página convertida no Konqueror.
Retrieved from ‘https://techbase.kde.org/index.php?title=How_To_Convert_a_UserBase_Manual_to_Docbook/pt-br&oldid=70836’

This page was last modified on 29 April 2012, at 14:04. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2 unless otherwise noted.