Browse Source

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>
pull/2/head
Slávek Banko 10 months ago
parent
commit
bd2ad7db31
Signed by: Slávek Banko <slavek.banko@axis.cz> GPG Key ID: 608F5293A04BE668
5 changed files with 10 additions and 725 deletions
  1. 5
    57
      doc/Makefile.am
  2. 1
    0
      doc/en/CMakeLists.txt
  3. 2
    0
      doc/en/Makefile.am
  4. 2
    6
      doc/en/index.docbook
  5. 0
    662
      doc/fr/index.docbook

+ 5
- 57
doc/Makefile.am View File

@@ -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)

+ 1
- 0
doc/en/CMakeLists.txt View File

@@ -0,0 +1 @@
tde_create_handbook( DESTINATION ${PROJECT_NAME} )

+ 2
- 0
doc/en/Makefile.am View File

@@ -0,0 +1,2 @@
KDE_DOCS = knights
KDE_LANG = en

+ 2
- 6
doc/en/index.docbook View File

@@ -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>

+ 0
- 662
doc/fr/index.docbook View File

@@ -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:
-->




Loading…
Cancel
Save