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

Latest revision as of 17:46, 28 July 2011

Вступ

Так, поточна процедура доволі кострубата, код скрипту не дуже-то і красивий, скрипт недостатньо «розумний» тощо. Єдиним виправданням може слугувати те, що цей спосіб якось працює

.

Якщо ви бажаєте удосконалити процедуру, маєте добрі навички з програмування мовою Python, добре знайомі з принципами створення підручників у форматі docbook, ви можете докласти власних зусиль до покращення процесу. Будь ласка, зв’яжіться з користувачем Yurchor, якщо ви бажаєте допомогти.

Приготування сторінок до перетворення

Переконайтеся, що всі сторінки вашого підручника відповідають настановам для авторів UserBase та настановам з форматування.

Переконайтеся, що кожна зі сторінок має заголовок, відповідно до її місця у змісті підручника.

Довідкова таблиця
UserBase	Docbook	Коментар
==Розділ==	<chapter>
===Розділ===	<sect1>
====Розділ====	<sect2>
=====Розділ=====	<sect3>
======Розділ======	<sect4>	Намагайтеся уникати використання цього рівні.

Переконайтеся, що у всіх комірках таблиць після символу «|» стоїть пробіл. Це правило узгоджується з традиційним форматуванням у вікі.

Використовуйте однорідне форматування назви програми (не використовуйте форми Amaroks, скористайтеся записом Amarok's).

Перетворіть всі зображення у формат PNG.

Вилучіть всі не-ASCII символи з назв зображень.

Експортування

Підготуйте список сторінок (без частин адрес UserBase, http://userbase.kde.org). Приклад для 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

Підказка

Отримати повний список сторінок вашої програми можна за допомогою такого скрипту:

<DPL>
  nottitlematch = %/__|%/zh-%|%(%)
  titlematch = Amarok%
  namespace = Main
  columns = 1
  format = ,\n* [[%PAGE%|%TITLE%]],,
</DPL>

Змініть Amarok на назву вашої програми, розмістіть скрипт на вашій сторінці користувача і натисніть кнопку Переглянути. Впорядкуйте отриманий список відповідно до змісту вашого підручника.

Перейдіть на сторінку експортування.

Вставте список сторінок до більшого поля для введення тексту.

Натисніть кнопку Експортувати.

Збережіть файл. У подальшому ми використовуватимемо для файла назву Manual.xml.

Перетворення

Встановіть пакунок Subversion.

Отримайте найсвіжішу версію скрипту перетворення:
```
svn checkout --depth=files svn://anonsvn.kde.org/home/kde/branches/work/doc/
```

Скопіюйте Manual.xml до теки скрипту.

Віддайте команду
```
python wiki2docbook.py Manual.xml
```
якщо потрібно звантажити ілюстрації до підручника (звантаження всіх ілюстрацій може тривати декілька хвилин UserBase, у системі має бути встановлено grep та wget) або командою
```
python wiki2docbook.py -s Manual.xml
```
якщо вам не потрібні ілюстрації.

Остаточна обробка

Перейменуйте Manual.xml.docbook на index.docbook.

Переконайтеся, що перетворення виконано без помилок:
```
checkXML index.docbook
```

Виправте помилки форматування (краще на сторінках UserBase).

Перетворіть документ у формат HTML:
```
meinproc4 index.docbook
```

Переконайтеся, що сторінки HTML буде показано правильно (всі зображення має бути показано, посилання мають працювати).

Замініть великі зображення на зменшені варіанти за допомогою програми convert з пакунка ImageMagick.

Виправте посилання у docbook так, щоб перехід за ними здійснювався до розділів docbook, а не до сторінок UserBase, якщо це можливо.

Виправте записи назви програми відповідно до списку записів (entity) KDE.

Скопіюйте index.docbook та зображення до вашої теки /doc, а потім надішліть їх до сховища коду.

@@ Line 1: / Line 1: @@
 <languages />
-== Preface ==
+==Вступ==
-The current process is not polished, the script code is ugly, not intelligent enough, etc.. The only excuse is that it works somehow {{Smiley}}.
+Так, поточна процедура доволі кострубата, код скрипту не дуже-то і красивий, скрипт недостатньо «розумний» тощо. Єдиним виправданням може слугувати те, що цей спосіб якось працює {{Smiley}}.
-If you want to improve the process, have good Python skills, and know the docbook authoring principles, you can improve the procedure.  Please contact [[User_talk:Yurchor|Yurchor]] if you are able to help.
+Якщо ви бажаєте удосконалити процедуру, маєте добрі навички з програмування мовою Python, добре знайомі з принципами створення підручників у форматі docbook, ви можете докласти власних зусиль до покращення процесу. Будь ласка, зв’яжіться з користувачем [[User_talk:Yurchor|Yurchor]], якщо ви бажаєте допомогти.
-== Preparing Pages for Conversion ==
+==Приготування сторінок до перетворення==
-* Check that the pages of your manual follow the [[Special:myLanguage/Tasks_and_Tools|author guidelines of UserBase]] and [[Special:myLanguage/Typographical_Guidelines|typographical guidelines]].
+* Переконайтеся, що всі сторінки вашого підручника відповідають [[Special:myLanguage/Tasks_and_Tools|настановам для авторів UserBase]] та [[Special:myLanguage/Typographical_Guidelines|настановам з форматування]].
-* Check if every page has its header according to the level of this page in table of contents.
+* Переконайтеся, що кожна зі сторінок має заголовок, відповідно до її місця у змісті підручника.
 :{|
-|+Reference table
+|+Довідкова таблиця
 |-
 ! UserBase
 ! Docbook
-! Comment
+! Коментар
 |-
-| ==Section==
+| ==Розділ==
 | <chapter>
 |-
-| ===Section===
+| ===Розділ===
 | <sect1>
 |-
-| ====Section====
+| ====Розділ====
 | <sect2>
 |-
-| =====Section=====
+| =====Розділ=====
 | <sect3>
 |-
-| ======Section======
+| ======Розділ======
 | <sect4>
-| ''Avoid using this last level if possible''
+| ''Намагайтеся уникати використання цього рівні.''
 |}
-* Check if all table cells have space after the pipe character. This rule conforms with [http://en.wikipedia.org/wiki/Help:Table traditional wiki formatting].
+* Переконайтеся, що у всіх комірках таблиць після символу «|» стоїть пробіл. Це правило узгоджується з [http://en.wikipedia.org/wiki/Help:Table традиційним форматуванням у вікі].
-* Make application name formatting consistent (avoid using '''Amarok'''s, do use '''Amarok's''').
+* Використовуйте однорідне форматування назви програми (не використовуйте форми '''Amarok'''s, скористайтеся записом '''Amarok's''').
-* Ensure that ''all'' images are in PNG format.
+* Перетворіть ''всі'' зображення у формат PNG.
-* Remove all non-printable characters from image names.
+* Вилучіть всі не-ASCII символи з назв зображень.
-===Export===
+===Експортування===
-* Prepare the page list (strip from UserBase addresses <nowiki>http://userbase.kde.org</nowiki>). Example for '''Amarok''':
+* Підготуйте список сторінок (без частин адрес UserBase, <nowiki>http://userbase.kde.org</nowiki>). Приклад для '''Amarok''':
 {{Input|1=Amarok
@@ Line 101: / Line 101: @@
 Amarok/Manual/Credits_and_License}}
-{{Tip|1=You can obtain the full list of pages for your application with the following script:<!--}}-->
+{{Tip_(uk)|1=Отримати повний список сторінок вашої програми можна за допомогою такого скрипту:<!--}}-->
 {{Input|1=<nowiki><DPL>
@@ Line 111: / Line 111: @@
 </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.
+<!--{{-->Змініть '''''Amarok''''' на назву вашої програми, розмістіть скрипт на вашій сторінці користувача і натисніть кнопку <menuchoice>Переглянути</menuchoice>. Впорядкуйте отриманий список відповідно до змісту вашого підручника.
 }}
-* Go to the [[Special:Export|export page]].
+* Перейдіть на [[Special:Export|сторінку експортування]].
-* Paste the page list into the <menuchoice>bigger</menuchoice> text field.
+* Вставте список сторінок до <menuchoice>більшого</menuchoice> поля для введення тексту.
-* Click on <menuchoice>Export</menuchoice>.
+* Натисніть кнопку <menuchoice>Експортувати</menuchoice>.
-[[File:XML_export.png|350px|center|thumb|Export of Amarok manual pages]]
+[[File:XML_export.png|350px|center|thumb|Експортуванян сторінок підручника з Amarok]]
-* Save the file. The saved file will be called <tt>Manual.xml</tt> in what follows.
+* Збережіть файл. У подальшому ми використовуватимемо для файла назву <tt>Manual.xml</tt>.
-===Conversion===
+===Перетворення===
-* Install Subversion package for your system.
+* Встановіть пакунок Subversion.
-* Checkout the latest version of conversion script: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
+* Отримайте найсвіжішу версію скрипту перетворення: {{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.
+* Скопіюйте <tt>Manual.xml</tt> до теки скрипту.
-* 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.
+* Віддайте команду {{Input|1=python wiki2docbook.py Manual.xml}} якщо потрібно звантажити ілюстрації до підручника (звантаження всіх ілюстрацій може тривати декілька хвилин UserBase, у системі має бути встановлено grep та wget) або командою {{Input|1=python wiki2docbook.py -s Manual.xml}} якщо вам не потрібні ілюстрації.
-===Post-processing===
+===Остаточна обробка===
-* Rename <tt>Manual.xml.docbook</tt> to <tt>index.docbook</tt>.
+* Перейменуйте <tt>Manual.xml.docbook</tt> на <tt>index.docbook</tt>.
-* Check if conversion was done correctly: {{Input|1=checkXML index.docbook}}
+* Переконайтеся, що перетворення виконано без помилок: {{Input|1=checkXML index.docbook}}
-* Fix the errors (better on UserBase pages).
+* Виправте помилки форматування (краще на сторінках UserBase).
-* Convert docbook to HTML: {{Input|1=meinproc4 index.docbook}}
+* Перетворіть документ у формат HTML: {{Input|1=meinproc4 index.docbook}}
-* Check HTML pages (all images should be visible, links should not lead to 404-pages).
+* Переконайтеся, що сторінки HTML буде показано правильно (всі зображення має бути показано, посилання мають працювати).
-* Replace big images by thumbnails using '''convert''' from '''ImageMagick'''
+* Замініть великі зображення на зменшені варіанти за допомогою програми '''convert''' з пакунка '''ImageMagick'''.
-* Fix links in docbook, so they lead to docbook section, not UserBase pages.
+* Виправте посилання у docbook так, щоб перехід за ними здійснювався до розділів docbook, а не до сторінок UserBase, якщо це можливо.
-* Fix application name according to KDE entity list.
+* Виправте записи назви програми відповідно до списку записів (entity) KDE.
-* Copy <tt>index.docbook</tt> and images to your <tt>/doc</tt> folder and commit them to repository.
+* Скопіюйте <tt>index.docbook</tt> та зображення до вашої теки <tt>/doc</tt>, а потім надішліть їх до сховища коду.
-[[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|Документація з K3b на UserBase у Opera та перетворена сторінка у Konqueror.]]
-[[Category:Translator_Help]]
+[[Category:Довідка для перекладачів/uk]]