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

From KDE Wiki Sandbox
(Created page with "===Перетворення===")
(Created page with "{{Warning|1=З якогось часу стало потрібним додавати рядок <br /><code>144.76.227.197 userbase.kde.org</code><br /> to <tt>/etc/hosts</tt...")
 
(67 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages />
<languages />
==Вступ==
==Вступ==


Line 8: Line 9:
==Приготування сторінок до перетворення==
==Приготування сторінок до перетворення==


* 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.
* Переконайтеся, що кожна зі сторінок має заголовок, відповідно до її місця у змісті підручника.


:{|
:{|
Line 36: Line 37:
|}
|}


* 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''').


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


* Вилучіть всі не-ASCII символи з назв зображень.
* Вилучіть всі не-ASCII символи з назв зображень.
 
<span id="Export"></span>
===Експортування===
===Експортування===


* Підготуйте список сторінок (без частин адрес UserBase, <nowiki>http://userbase.kde.org</nowiki>). Приклад для '''Amarok''':
* Підготуйте список сторінок (без частин адрес UserBase, <nowiki>http://userbase.kde.org</nowiki>). Приклад для '''Amarok''':


{{Input|1=Amarok
{{Input|1=Amarok/Manual/Introduction
Amarok/QuickStartGuide
Amarok/QuickStartGuide
Amarok/QuickStartGuide/GettingStarted
Amarok/QuickStartGuide/GettingStarted
Line 63: Line 64:
Amarok/Manual/AmarokWindow/PlaylistPane
Amarok/Manual/AmarokWindow/PlaylistPane
Amarok/Manual/ConfiguringAmarok
Amarok/Manual/ConfiguringAmarok
Amarok/Manual/AdvancedFeatures
Amarok/Manual/ConfiguringAmarok/ChangingLayout
Amarok/Manual/AdvancedFeatures/CollectionScanning
Amarok/Manual/Organization
Amarok/Manual/AdvancedFeatures/CoverManager
Amarok/Manual/Organization/Collection
Amarok/Manual/AdvancedFeatures/DynamicPlaylists
Amarok/Manual/Organization/CollectionScanning
Amarok/Manual/AdvancedFeatures/AutomaticPlaylistGenerator
Amarok/Manual/Organization/Collection/SearchInCollection
Amarok/Manual/AdvancedFeatures/ExternalDatabase
Amarok/Manual/Organization/Collection/OrganizeCollection
Amarok/Manual/AdvancedFeatures/AFT
Amarok/Manual/Organization/Collection/RemoteCollections
Amarok/Manual/AdvancedFeatures/Moodbar
Amarok/Manual/Organization/Collection/RemoteCollections/Ampache
Amarok/Manual/AdvancedFeatures/WorkingWithMediaDevices
Amarok/Manual/Organization/Collection/RemoteCollections/DAAP
Amarok/Manual/AdvancedFeatures/SavedPlaylists
Amarok/Manual/Organization/Collection/RemoteCollections/Samba
Amarok/Manual/AdvancedFeatures/PlaylistFiltering
Amarok/Manual/Organization/Collection/RemoteCollections/UPnP
Amarok/Manual/AdvancedFeatures/QueueManager
Amarok/Manual/Organization/Collection/ExternalDatabase
Amarok/Manual/AdvancedFeatures/SearchInCollection
Amarok/Manual/Organization/Collection/WorkingWithMediaDevices
Amarok/Manual/AdvancedFeatures/TagEditor
Amarok/Manual/Organization/CoverManager
Amarok/Manual/AdvancedFeatures/OrganizeCollection
Amarok/Manual/Organization/TagEditor
Amarok/Manual/AdvancedFeatures/Transcoding
Amarok/Manual/Organization/Transcoding
Amarok/Manual/AdvancedFeatures/ScriptManager
Amarok/Manual/Organization/ScriptManager
Amarok/Manual/AdvancedFeatures/RemoteCollections
Amarok/Manual/Playlist
Amarok/Manual/AdvancedFeatures/RemoteCollections/Ampache
Amarok/Manual/Playlist/SavedPlaylists
Amarok/Manual/AdvancedFeatures/RemoteCollections/DAAP
Amarok/Manual/Playlist/PlaylistFiltering
Amarok/Manual/AdvancedFeatures/RemoteCollections/Samba
Amarok/Manual/Playlist/QueueManager
Amarok/Manual/AdvancedFeatures/RemoteCollections/UPnP
Amarok/Manual/Playlist/DynamicPlaylists
Amarok/Manual/MenuAndCommandReference/AmarokMenu
Amarok/Manual/Playlist/AutomaticPlaylistGenerator
Amarok/Manual/MenuAndCommandReference/ViewMenu
Amarok/Manual/Various
Amarok/Manual/MenuAndCommandReference/Playlist
Amarok/Manual/Various/Moodbar
Amarok/Manual/MenuAndCommandReference/Tools
Amarok/Manual/Various/AmarokOnOtherPlatforms
Amarok/Manual/MenuAndCommandReference/Settings
Amarok/Manual/Various/AmarokOnOtherPlatforms/NonKDE Desktops
Amarok/Manual/MenuAndCommandReference/Help
Amarok/Manual/Various/AmarokOnOtherPlatforms/Windows
Amarok/Manual/KeybindingReference
Amarok/Manual/Various/AmarokOnOtherPlatforms/OSX
Amarok/Manual/KeybindingReference/GlobalShortcuts
Amarok/Manual/Various/TroubleshootingAndCommonProblems
Amarok/Manual/KeybindingReference/AmarokShortcuts
Amarok/Manual/Various/FAQ
Amarok/Manual/TroubleshootingAndCommonProblems
Amarok/Manual/References
Amarok/Manual/AmarokOnOtherPlatforms/Non-KDE Desktops
Amarok/Manual/References/MenuAndCommandReference
Amarok/Manual/AmarokOnOtherPlatforms/Windows
Amarok/Manual/References/MenuAndCommandReference/AmarokMenu
Amarok/Manual/AmarokOnOtherPlatforms/OSX
Amarok/Manual/References/MenuAndCommandReference/ViewMenu
Amarok/Manual/FAQ
Amarok/Manual/References/MenuAndCommandReference/Playlist
Amarok/Manual/Credits_and_License}}
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}}


{{Tip_(uk)|1=Отримати повний список сторінок вашої програми можна за допомогою такого скрипту:<!--}}-->
{{Tip_(uk)|1=Отримати повний список сторінок вашої програми можна за допомогою такого скрипту:<!--}}-->


{{Input|1=<nowiki><DPL>
{{Input|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 112: Line 119:


<!--{{-->Змініть '''''Amarok''''' на назву вашої програми, розмістіть скрипт на вашій сторінці користувача і натисніть кнопку <menuchoice>Переглянути</menuchoice>. Впорядкуйте отриманий список відповідно до змісту вашого підручника.
<!--{{-->Змініть '''''Amarok''''' на назву вашої програми, розмістіть скрипт на вашій сторінці користувача і натисніть кнопку <menuchoice>Переглянути</menuchoice>. Впорядкуйте отриманий список відповідно до змісту вашого підручника.
}}
{{Note_(uk)|1=Якщо ви працюєте з підручником із Amarok, зважайте на те, що сторінки підручника названо не у повній відповідності із правилами. Можете скористатися
{{Input|1= titlematch = Amarok/Manual%{{!}}Amarok/QuickStartGuide%}}
(Зауваження: у взірці немає символів пробілів!)
}}
}}


Line 125: Line 137:
===Перетворення===
===Перетворення===


* Install Subversion package for your system.
* Встановіть пакунок Subversion.
 
* Отримайте найсвіжішу версію скрипту перетворення: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}


* Checkout the latest version of conversion script: {{Input|1=svn checkout --depth=files <nowiki>svn://anonsvn.kde.org/home/kde/branches/work/doc/</nowiki>}}
* Скопіюйте <tt>Manual.xml</tt> до теки скрипту.


* Copy <tt>Manual.xml</tt> to the script folder.
* Віддайте команду {{Input|1=python wiki2docbook.py Manual.xml}} якщо потрібно звантажити ілюстрації до підручника (звантаження всіх ілюстрацій може тривати декілька хвилин UserBase, у системі має бути встановлено grep та wget) або командою {{Input|1=python wiki2docbook.py -s Manual.xml}} якщо вам не потрібні ілюстрації.


* 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|1=З якогось часу стало потрібним додавати рядок <br /><code>144.76.227.197 userbase.kde.org</code><br /> to <tt>/etc/hosts</tt>, щоб можна було отримати доступ до UserBase зі скрипту. Зараз цього робити не потрібно. Якщо ви вже додали цей рядок до вашого файла <tt>/etc/hosts</tt>, можете його вилучити.}}


===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, якщо це можливо.


* Виправте записи назви програми відповідно до списку записів (entity) KDE.
* Виправте записи назви програми відповідно до списку записів (entity) KDE.
Line 153: Line 167:
* Скопіюйте <tt>index.docbook</tt> та зображення до вашої теки <tt>/doc</tt>, а потім надішліть їх до сховища коду.
* Скопіюйте <tt>index.docbook</tt> та зображення до вашої теки <tt>/doc</tt>, а потім надішліть їх до сховища коду.
[[File:K3b_docs.png|350px|center|thumb|Документація з K3b на UserBase у Opera та перетворена сторінка у Konqueror.]]
[[File:K3b_docs.png|350px|center|thumb|Документація з K3b на UserBase у Opera та перетворена сторінка у Konqueror.]]
== Оновлення вашого підручника у форматі DocBook з UserBase ==
Щоб оновити перетворений вами підручник у форматі docbook, будь ласка, виконайте такі дії:
* Повторно експортуйте дані у форматі XML з UserBase. Докладніший опис експорутвання наведено у розділі [[Special:myLanguage/How_To_Convert_a_UserBase_Manual_to_Docbook#Export|Експортування]].
* Скористайтеся скриптом для оновлення вмісту (заголовок з резюме та ключовими словами, а також завершальний розділ буде збережено): {{Input|1= python wiki2docbook.py -r index.docbook Manual.xml}}
* Перевірте docbook, перейменуйте файл на index.docbook і надішліть його разом з новими знімками вікон до вашого сховища коду.
== Перетворення даних у форматі DocBook на дані у інших форматах ==
=== Перетворення на дані у форматі PDF===
Зазвичай, перетворювати DocBook вручну не потрібно. Перетворені у автоматичному режимі PDF можна знайти на сайті [http://docs.kde.org/ документації до KDE].
Якщо ви бажаєте виконати додаткове налаштування, будь ласка, скористайтеся такою послідовністю дій:
* Встановіть один з дистрибутивів '''LaTeX''' (наприклад TeXLive).
* Створіть файл скрипту (з назвою <tt>buildpdf.sh</tt>) у каталозі з вашими даними DocBook:
{{Input|1=
<syntaxhighlight lang="bash">#!/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</syntaxhighlight>}}
* Отримайте стилі KDE:
{{Input|1=<nowiki>git clone git://anongit.kde.org/websites/docs-kde-org.git</nowiki>}}
* Внесіть зміни до <tt>dblatex-cvs-install/bin/dblatex</tt> так, щоб вміст файла набув вигляду:
<!--}}-->{{Input|1=
<syntaxhighlight lang="bash">#!/bin/sh
TEXINPUTS=:/path/to/your/dblatex-cvs-install/share/dblatex/latex//:$TEXINPUTS
export TEXINPUTS
/шлях/до/вашого/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*</syntaxhighlight>}}<!--{{-->
(Замініть '''''/шлях/до/вашого/''''' на адресу відповідного каталогу)
* Скопіюйте стилі KDE (/dblatex-cvs-install/share/dblatex/latex/contrib/) до якогось з каталогів TeX, де їх зможе виявити система '''LaTeX''' (наприклад, до <tt>/usr/share/texmf-dist/tex/latex/kde</tt>).
* Оновіть дані за допомогою команди <code>mktexlsr</code>, відданої від імені користувача root.
* Віддайте команду <code>./buildpdf.sh index.docbook</code>. У результаті має бути створено готовий до використання файл PDF. Ви можете зупинитися на цьому кроці, якщо не хочете у подальшому поліпшити результат перетворення.
* Скопіюйте всі файли з <tt>/tmp/tpb-'''''ваш-користувач'''''-'''''цифри'''''</tt> до вашого робочого каталогу.
* Внесіть потрібні зміни до файла <tt>tex</tt> за допомогою [[Special:MyLanguage/Kile|Kile]].
* Зберіть файл PDF натисканням комбінації клавіш <keycap>Alt + 6</keycap>.
=== Перетворення даних у формат EPUB ===
* Встановіть у вашій системі пакунок програми '''Calibre'''.
* Спочатку перетворіть DocBook на дані у форматі HTML. Скористайтеся для цього командою <code>meinproc4 index.docbook</code>.
* Запустіть '''Calibre''' і виберіть пункт <menuchoice>Додати книги</menuchoice>.
* Виберіть файл <tt>index.html</tt> у теці вашої DocBook. Зачекайте, доки книгу буде завантажено.
* Виберіть пункт <menuchoice>Перетворити книги</menuchoice>.
* Заповніть поля метаданих.
[[File:calibre.png|350px|center|thumb|Сторінка налаштування перетворення Calibre.]]
* Натисніть <menuchoice>Гаразд</menuchoice> і зачекайте, доки роботу буде виконано.
* Скопіюйте книгу з <tt>~/Calibre Library</tt> на ваш пристрій для читання електронних книжок.


[[Category:Власний внесок/uk]]
[[Category:Власний внесок/uk]]

Latest revision as of 09:20, 17 October 2019

Other languages:

Вступ

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

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

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

  • Переконайтеся, що кожна зі сторінок має заголовок, відповідно до її місця у змісті підручника.
Довідкова таблиця
UserBase Docbook Коментар
==Розділ== <chapter>
===Розділ=== <sect1>
====Розділ==== <sect2>
=====Розділ===== <sect3>
======Розділ====== <sect4> Намагайтеся уникати використання цього рівні.
  • Використовуйте однорідне форматування назви програми (не використовуйте форми Amaroks, скористайтеся записом Amarok's).
  • Перетворіть всі зображення у формат PNG.
  • Вилучіть всі не-ASCII символи з назв зображень.

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

  • Підготуйте список сторінок (без частин адрес UserBase, http://userbase.kde.org). Приклад для 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
Підказка
Отримати повний список сторінок вашої програми можна за допомогою такого скрипту:
<DPL>
  nottitlematch = %/__|%/zh-%|%pt-%|%(%)
  titlematch = Appname/Manual%
  namespace = 
  columns = 1
  format = ,\n* [[%PAGE%|%TITLE%]],,
</DPL>
Змініть Amarok на назву вашої програми, розмістіть скрипт на вашій сторінці користувача і натисніть кнопку Переглянути. Впорядкуйте отриманий список відповідно до змісту вашого підручника.


Зауваження
Якщо ви працюєте з підручником із Amarok, зважайте на те, що сторінки підручника названо не у повній відповідності із правилами. Можете скористатися
titlematch = Amarok/Manual%|Amarok/QuickStartGuide%
(Зауваження: у взірці немає символів пробілів!)


  • Вставте список сторінок до більшого поля для введення тексту.
  • Натисніть кнопку Експортувати.
Експортуванян сторінок підручника з 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
    якщо вам не потрібні ілюстрації.
Warning
З якогось часу стало потрібним додавати рядок
144.76.227.197 userbase.kde.org
to /etc/hosts, щоб можна було отримати доступ до UserBase зі скрипту. Зараз цього робити не потрібно. Якщо ви вже додали цей рядок до вашого файла /etc/hosts, можете його вилучити.


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

  • Перейменуйте Manual.xml.docbook на index.docbook.
  • Переконайтеся, що перетворення виконано без помилок:
    checkXML index.docbook
  • Виправте помилки форматування (краще на сторінках UserBase).
  • Перетворіть документ у формат HTML:
    meinproc4 index.docbook
  • Переконайтеся, що сторінки HTML буде показано правильно (всі зображення має бути показано, посилання мають працювати).
  • Замініть великі зображення на зменшені варіанти за допомогою програми convert з пакунка ImageMagick.
  • Виправте посилання у docbook так, щоб перехід за ними здійснювався до розділів docbook, а не до сторінок UserBase, якщо це можливо.
  • Виправте записи назви програми відповідно до списку записів (entity) KDE.
  • Скопіюйте index.docbook та зображення до вашої теки /doc, а потім надішліть їх до сховища коду.
Документація з K3b на UserBase у Opera та перетворена сторінка у Konqueror.

Оновлення вашого підручника у форматі DocBook з UserBase

Щоб оновити перетворений вами підручник у форматі docbook, будь ласка, виконайте такі дії:

  • Повторно експортуйте дані у форматі XML з UserBase. Докладніший опис експорутвання наведено у розділі Експортування.
  • Скористайтеся скриптом для оновлення вмісту (заголовок з резюме та ключовими словами, а також завершальний розділ буде збережено):
    python wiki2docbook.py -r index.docbook Manual.xml
  • Перевірте docbook, перейменуйте файл на index.docbook і надішліть його разом з новими знімками вікон до вашого сховища коду.

Перетворення даних у форматі DocBook на дані у інших форматах

Перетворення на дані у форматі PDF

Зазвичай, перетворювати DocBook вручну не потрібно. Перетворені у автоматичному режимі PDF можна знайти на сайті документації до KDE.

Якщо ви бажаєте виконати додаткове налаштування, будь ласка, скористайтеся такою послідовністю дій:

  • Встановіть один з дистрибутивів LaTeX (наприклад TeXLive).
  • Створіть файл скрипту (з назвою buildpdf.sh) у каталозі з вашими даними 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
  • Отримайте стилі KDE:
git clone git://anongit.kde.org/websites/docs-kde-org.git
  • Внесіть зміни до dblatex-cvs-install/bin/dblatex так, щоб вміст файла набув вигляду:
#!/bin/sh

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

/шлях/до/вашого/dblatex-cvs-install/share/dblatex/scripts/dblatex  $*

(Замініть /шлях/до/вашого/ на адресу відповідного каталогу)

  • Скопіюйте стилі KDE (/dblatex-cvs-install/share/dblatex/latex/contrib/) до якогось з каталогів TeX, де їх зможе виявити система LaTeX (наприклад, до /usr/share/texmf-dist/tex/latex/kde).
  • Оновіть дані за допомогою команди mktexlsr, відданої від імені користувача root.
  • Віддайте команду ./buildpdf.sh index.docbook. У результаті має бути створено готовий до використання файл PDF. Ви можете зупинитися на цьому кроці, якщо не хочете у подальшому поліпшити результат перетворення.
  • Скопіюйте всі файли з /tmp/tpb-ваш-користувач-цифри до вашого робочого каталогу.
  • Внесіть потрібні зміни до файла tex за допомогою Kile.
  • Зберіть файл PDF натисканням комбінації клавіш Alt + 6.

Перетворення даних у формат EPUB

  • Встановіть у вашій системі пакунок програми Calibre.
  • Спочатку перетворіть DocBook на дані у форматі HTML. Скористайтеся для цього командою meinproc4 index.docbook.
  • Запустіть Calibre і виберіть пункт Додати книги.
  • Виберіть файл index.html у теці вашої DocBook. Зачекайте, доки книгу буде завантажено.
  • Виберіть пункт Перетворити книги.
  • Заповніть поля метаданих.
Сторінка налаштування перетворення Calibre.
  • Натисніть Гаразд і зачекайте, доки роботу буде виконано.
  • Скопіюйте книгу з ~/Calibre Library на ваш пристрій для читання електронних книжок.