summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSlávek Banko <slavek.banko@axis.cz>2019-01-05 13:52:00 +0100
committerSlávek Banko <slavek.banko@axis.cz>2019-01-05 13:52:07 +0100
commitbd2ad7db31cc6bdf0ab30d658f9bbca57ece3ed8 (patch)
tree9e2feb63016d06e9aa096c3d0bdeabc1bcb43a58 /doc
parent851cb9c0321d23e28145c795ace887d339d1c391 (diff)
downloadknights-bd2ad7db31cc6bdf0ab30d658f9bbca57ece3ed8.tar.gz
knights-bd2ad7db31cc6bdf0ab30d658f9bbca57ece3ed8.zip
Update build rules for documentation:
+ Removed French documentation because it contains nothing. + Modified automake rules for documentation in subdirectories. + Added cmake rule for installing documentation. Signed-off-by: Slávek Banko <slavek.banko@axis.cz>
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am62
-rw-r--r--doc/en/CMakeLists.txt1
-rw-r--r--doc/en/Makefile.am2
-rw-r--r--doc/en/index.docbook8
-rw-r--r--doc/fr/index.docbook662
5 files changed, 10 insertions, 725 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 411115c..23a795e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,58 +1,6 @@
-####### tdevelop will overwrite this part!!! (begin)##########
+# the SUBDIRS is filled automatically by am_edit. If files are
+# in this directory they are installed into the english dir
-
-EXTRA_DIST = help_en.docbook help_fr.docbook
-
-####### tdevelop will overwrite this part!!! (end)############
-
-MAINTAINERCLEANFILES = ./*.html
-CLEANFILES = core *~ .deps/* doc/*~ *.orig changes.docbook
-DISTCLEANFILES = Makefile.in Makefile
-
-LANGUAGES = en fr
-SUFFIXES = .docbook .po .pot
-SGMLDIR=$(kde_datadir)/ksgmltools2
-DOCDIR = $(DESTDIR)${kde_htmldir}
-XML2POT = xml2pot
-PO2XML = po2xml
-MSGMERGE = msgmerge
-
-
-help_en.pot: help_en.docbook
- $(XML2POT) help_en.docbook > help_en.pot
-
-# --- translated docbook online help ---
-
-help_fr.po: help_en.pot
- $(MSGMERGE) -o help_fr.po help_fr.po help_en.pot
-
-help_fr.docbook: help_en.docbook help_en.pot
- ${MAKE} help_fr.po
- @echo "converting french help"
- @ $(PO2XML) help_en.docbook help_fr.po | \
- sed s/^\ \ \<\!ENTITY\ %\ English\ /\ \ \<\!ENTITY\ %\ French\ /g \
- > help_fr.docbook
-
-# --- ---
-
-install-data-local:
- echo installing docs in $(DOCDIR)
- for lang in ${LANGUAGES}; do \
- { \
- $(mkinstalldirs) ${DOCDIR}/$${lang}/$(PACKAGE); \
- $(INSTALL_DATA) help_$${lang}.docbook ${DOCDIR}/$${lang}/$(PACKAGE)/index.docbook; \
- if test ! -e ${DOCDIR}/$${lang}/$(PACKAGE)/common ; then \
- rm -f ${DOCDIR}/$${lang}/$(PACKAGE)/common ; fi ; \
- ( cd ${DOCDIR}/$${lang}/${PACKAGE} ; ln -sf ../common . ) ; \
- }; done
- cd ${DOCDIR} ; \
- if test ! -e default/$(PACKAGE) -a -e default ; then ln -sf ../en/$(PACKAGE) default; fi;
-
-uninstall-local:
- for lang in ${LANGUAGES}; do { \
- rm -R -f ${DOCDIR}/$${lang}/${PACKAGE} ; \
- rmdir -p --ignore-fail-on-non-empty $(DOCDIR)/$$lang >/dev/null 2>&1; \
- if test -L ${DOCDIR}/default/$(PACKAGE); then rm -f ${DOCDIR}/default/$(PACKAGE); fi; \
- }; done
-
-all:
+KDE_LANG = en
+KDE_DOCS = knights
+SUBDIRS = $(AUTODIRS)
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
new file mode 100644
index 0000000..ba3ef3e
--- /dev/null
+++ b/doc/en/CMakeLists.txt
@@ -0,0 +1 @@
+tde_create_handbook( DESTINATION ${PROJECT_NAME} )
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
new file mode 100644
index 0000000..20beda9
--- /dev/null
+++ b/doc/en/Makefile.am
@@ -0,0 +1,2 @@
+KDE_DOCS = knights
+KDE_LANG = en
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
index 6bc3be7..99b75a3 100644
--- a/doc/en/index.docbook
+++ b/doc/en/index.docbook
@@ -15,18 +15,14 @@
<firstname>Troy</firstname>
<surname>Corbin Jr.</surname>
<affiliation>
- <address>
- <email>tcorbin@users.sf.net</email>
- </address>
+ <address><email>tcorbin@users.sf.net</email></address>
</affiliation>
</author>
<othercredit role="developer">
<firstname>Troy</firstname>
<surname>Corbin Jr.</surname>
<affiliation>
- <address>
- <email>tcorbin@users.sf.net</email>
- </address>
+ <address><email>tcorbin@users.sf.net</email></address>
</affiliation>
<contrib>Developer</contrib>
</othercredit>
diff --git a/doc/fr/index.docbook b/doc/fr/index.docbook
deleted file mode 100644
index 274c59a..0000000
--- a/doc/fr/index.docbook
+++ /dev/null
@@ -1,662 +0,0 @@
-<?xml version="1.0" ?>
-<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY kappname "Knights">
- <!ENTITY % addindex "IGNORE">
- <!ENTITY % French "INCLUDE"
-> <!-- change language only here -->
-]>
-
-<book lang="&language;">
- <bookinfo>
- <title>
- The Knights Handbook
- </title>
- <authorgroup>
- <author>
- <firstname>Troy</firstname>
- <surname>Corbin Jr.</surname>
- <affiliation>
- <address>
- <email>tcorbin@users.sf.net</email>
- </address>
- </affiliation>
- </author>
- <othercredit role="developer">
- <firstname>Troy</firstname>
- <surname>Corbin Jr.</surname>
- <affiliation>
- <address>
- <email>tcorbin@users.sf.net</email>
- </address>
- </affiliation>
- <contrib>Developer</contrib>
- </othercredit>
- </authorgroup>
- <!-- TRANS:ROLES_OF_TRANSLATORS -->
- <copyright>
- <year
->2001, 2002</year>
- <holder
-></holder>
- </copyright>
- <legalnotice>
- &FDLNotice;
- </legalnotice>
- <date>
- 2003-05-17
- </date>
- <releaseinfo>
- 0.6
- </releaseinfo>
- <abstract>
- <para
-> </para>
- </abstract>
- <keywordset>
- <keyword
-></keyword>
-
- <keyword
-></keyword>
- <keyword
-></keyword>
- <keyword
-></keyword>
- <keyword
-></keyword>
-
-
-
- </keywordset>
- </bookinfo>
-
- <chapter id="introduction">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- </chapter>
-
- <chapter id="getting-started">
- <title
-></title>
- <para
-> </para>
- <sect1 id="interface-chessboard">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <sect2 id="interface-chessboard-move">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- </sect2>
- <sect2 id="interface-chessboard-preview">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <tip
-> <para
-> </para
-> </tip>
- </sect2>
- <sect2 id="interface-chessboard-notation">
- <title
-></title>
- <para
-> </para>
- <note
-> <para
-> </para
-> </note>
- </sect2>
- </sect1>
- <sect1 id="new-match">
- <title
-></title>
- <para
-> </para>
- <sect2 id="new-match-dialog">
- <title
-></title>
- <para
-> </para>
- <note
-> <para
-> </para
-> </note>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- </sect2>
- </sect1>
- </chapter>
-
- <chapter id="online">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <sect1 id="getting-started-online">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <sect2 id="getting-started-online-connecting">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- </sect2>
- </sect1>
- <sect1 id="online-tools">
- <title
-></title>
- <para
-> </para>
- <sect2 id="online-tools-console">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- </sect2>
- <sect2 id="online-tools-sought-list">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <itemizedlist
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> </itemizedlist>
- </sect2>
- <sect2 id="online-tools-sought-graph">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <itemizedlist
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> </itemizedlist>
- </sect2>
- </sect1>
- </chapter>
-
- <chapter id="organizing-tabs">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <note
-> <para
-> </para
-> </note>
- </chapter>
-
- <chapter id="configure">
- <title
-></title>
- <para
-> </para>
- <sect1 id="configure-general">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <note
-> <para
-> </para
-> </note>
- <para
-> </para>
- <para
-> </para>
- </sect1>
- <sect1 id="configure-display">
- <title
-></title>
- <sect2 id="configure-display-general">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- </sect2>
- <sect2 id="configure-display-console">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- </sect2>
- </sect1>
- <sect1 id="configure-audio">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <note
-> <para
-> </para
-> </note>
- <para
-> </para>
- </sect1>
- <sect1 id="configure-engines">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <note
-> <para
-> </para
-> </note>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- </sect1>
- <sect1 id="configure-servers">
- <title
-></title>
- <para
-> </para>
- <sect2 id="configure-servers-servers">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- </sect2>
- <sect2 id="configure-servers-options">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- </sect2>
- </sect1>
- </chapter>
-
- <chapter id="key-bindings">
- <title
-></title>
- <itemizedlist
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> <listitem
-> <para
-> </para
-> </listitem
-> </itemizedlist>
- </chapter>
-
- <chapter id="credits">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
- &underFDL;
- &underGPL;
- </chapter>
-
- <appendix id="installation">
- <title
-></title>
- <sect1 id="installation-obtain-knights">
- <title
-></title>
- <para
-> </para>
- <note
-> <para
-> </para
-> </note>
- </sect1>
- <sect1 id="installation-requirements">
- <title
-></title>
- <para
-> </para>
- </sect1>
- <sect1 id="installation-compilation">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> <userinput
-><command
-></command
-></userinput
-> </para>
- <para
-> </para>
- <para
-> </para>
-<informalexample
-> <screen width="40">
-
-</screen
-> </informalexample>
- <para
-> </para>
- </sect1>
- </appendix>
-
- <appendix id="command-line">
- <title
-></title>
- <para
-> </para>
-<screen width="40">
-
-</screen>
- <para
-> </para>
-<screen width="40">
-
-</screen>
- <para
-> </para>
- </appendix>
-
- <appendix id="kml">
- <title
-></title>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- <para
-> </para>
- </appendix>
-</book>
-<!--
-Local Variables:
-mode: sgml
-sgml-omittag: nil
-sgml-shorttag: t
-End:
--->
-
-
-