Added a beginning of user manual

This commit is contained in:
Pierre Pronchery 2013-04-11 03:17:02 +02:00
parent d85f50273e
commit b56798df8c
5 changed files with 40 additions and 4 deletions

View File

@ -59,6 +59,8 @@ dist:
$(PACKAGE)-$(VERSION)/data/48x48/project.conf \
$(PACKAGE)-$(VERSION)/doc/Makefile \
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
$(PACKAGE)-$(VERSION)/doc/index.xml \
$(PACKAGE)-$(VERSION)/doc/index.xsl \
$(PACKAGE)-$(VERSION)/doc/phone.xml \
$(PACKAGE)-$(VERSION)/doc/phonectl.xml \
$(PACKAGE)-$(VERSION)/doc/pppd-ip-down \

View File

@ -1,4 +1,4 @@
TARGETS = phone.1 phone.html phonectl.1 phonectl.html
TARGETS = index.html phone.1 phone.html phonectl.1 phonectl.html
PREFIX = /usr/local
DESTDIR =
RM = rm -f
@ -9,6 +9,9 @@ INSTALL = install
all: $(TARGETS)
index.html: index.xml index.xsl phone.xml phonectl.xml
./docbook.sh -P "$(PREFIX)" -- "index.html"
phone.1: phone.xml
./docbook.sh -P "$(PREFIX)" -- "phone.1"
@ -22,7 +25,7 @@ phonectl.html: phonectl.xml
./docbook.sh -P "$(PREFIX)" -- "phonectl.html"
clean:
$(RM) -- $(phone.1_OBJS) $(phone.html_OBJS) $(phonectl.1_OBJS) $(phonectl.html_OBJS)
$(RM) -- $(index.html_OBJS) $(phone.1_OBJS) $(phone.html_OBJS) $(phonectl.1_OBJS) $(phonectl.html_OBJS)
./docbook.sh -c -P "$(PREFIX)" -- "phonectl.html"
distclean: clean

22
doc/index.xml Normal file
View File

@ -0,0 +1,22 @@
<?xml version="1.0"?>
<!-- $Id$ -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY phone1 "phone.xml">
<!ENTITY phonectl1 "phonectl.xml">
]>
<book><?dbhtml filename="index.html"?>
<title>DeforaOS Phone</title>
<para>Telephony application for the DeforaOS desktop environment.</para>
<chapter>
<title>User manual</title>
</chapter>
<chapter>
<title>Manual pages</title>
<section>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="&phone1;"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="&phonectl1;"/>
</section>
</chapter>
</book>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->

4
doc/index.xsl Normal file
View File

@ -0,0 +1,4 @@
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/chunk.xsl"/>
</xsl:stylesheet>

View File

@ -1,5 +1,10 @@
dist=Makefile,docbook.sh,phone.xml,phonectl.xml,pppd-ip-down,pppd-ip-up,pppd-peers_phone
targets=phone.1,phone.html,phonectl.1,phonectl.html
dist=Makefile,docbook.sh,index.xml,index.xsl,phone.xml,phonectl.xml,pppd-ip-down,pppd-ip-up,pppd-peers_phone
targets=index.html,phone.1,phone.html,phonectl.1,phonectl.html
[index.html]
type=script
script=./docbook.sh
depends=index.xml,index.xsl,phone.xml,phonectl.xml
[phone.1]
type=script