KDocumentEditor
はじめに
KDEのヘルプセンター用のドキュメントを追加します。
ただし、勉強不足のため、詳しい説明は書けないと思います。
KI18NEditorをベースに、アプリケーション名はKDocumentEditorとします。
準備
pics、poディレクトリがあるディレクトリにdocディレクトリを作成。
以下の内容でMakefile.amを作成。
KDE_DOCS = kdocumenteditor
SUBDIRS = $(AUTODIRS)
docディレクトリにjaディレクトリを作成。
以下の内容でMakefile.amを作成。
KDE_DOCS = kdocumenteditor
ドキュメントの作成
KDEヘルプセンター用のドキュメントはDocBookという形式で書かれるのが一般的なようです。
とりあえずKDevelopでデフォルトで作成される雛型で以下のようなindex.docbookをjaディレクトリに作成。
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.0//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&kdocumenteditor;">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
<!-- Important note: please use template.docbook instead of this file.
This is only the conversion of app.sgml into DocBook SGML.
template.docbook gives you more information on what you can and
should do.Thanks. -->
<book lang="&language;">
<bookinfo>
<title>The KDocumentEditor Handbook</title>
<authorgroup>
<author>
<firstname></firstname>
<surname>Tasuku Suzuki</surname>
<affiliation><address><email>tasuku@linux-life.net</email></address></affiliation>
</author>
</authorgroup>
<date>2003/10/02</date>
<releaseinfo>0.1</releaseinfo>
<abstract>
<para>SHORT DESCRIPTION GOES HERE</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KDocumentEditor</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<sect1 id="features">
<title>Features</title>
<para></para>
</sect1>
</chapter>
<chapter id="installation">
<title>Installation</title>
<sect1 id="how-to-obtain-kdocumenteditor">
<title>How to obtain kdocumenteditor</title>
<para></para>
</sect1>
<sect1 id="requirements">
<title>Requirements</title>
<para></para>
</sect1>
<sect1 id="compilation-and-installation">
<title>Compilation and Installation</title>
<para>Compiling kdocumenteditor is very easy.The following should do it:
<screen>
<prompt>%</prompt> <userinput><command>./configure</command></userinput>
<prompt>%</prompt> <userinput><command>make</command></userinput>
<prompt>%</prompt> <userinput><command>make</command> install</userinput>
</screen>
</para>
<para>
That should do it! Should you run into any problems, please report them to the
<ulink url="mailto:tasuku@linux-life.net">author</ulink>
</para>
</sect1>
</chapter>
<chapter id="using-kdocumenteditor">
<title>Using kdocumenteditor</title>
<para></para>
</chapter>
<chapter id="questionsanswersandtips">
<title>Questions, Answers, and Tips</title>
<qandaset id="faq">
<title>Frequently asked questions</title>
<qandaentry>
<question>
<para>Question 1</para>
</question>
<answer>
<para>The answer</para>
</answer>
</qandaentry>
</qandaset>
</chapter>
</book>
<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
sgml-general-insert-case: lower
End:
-->
あとはこれを適当に書き換えてください。 ヘルプファイル および ドキュメントの翻訳...が参考になります。
日本語を使う場合は文字コードをUTF-8にします。
ただし、<title>を日本語にするとヘルプセンターのツリーメニューに現れないようです。
おわりに
今回作成した全てのファイルはkdocumenteditor.tar.gzからダウンロードすることができます。