Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2.3] docs: manual XML source improvements, backported from main #753

Merged
merged 1 commit into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/html.xsl.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<xsl:param name="chunk.section.depth" select="0"/>
<xsl:param name="chunk.separate.lots" select="1"/>
<xsl:param name="html.stylesheet" select="'https://netatalk.io/css/netatalk.css'"/>
<xsl:param name="toc.max.depth" select="2"/>

<xsl:template name="user.header.navigation">
<xsl:variable name="codefile" select="document('netatalk.html',/)"/>
Expand Down
2 changes: 1 addition & 1 deletion doc/manpages/man8/cnid_metad.8.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<refnamediv>
<refname>cnid_metad</refname>

<refpurpose>daemon for starting cnid_dbd daemons on demand</refpurpose>
<refpurpose>daemon for starting <command>cnid_dbd</command>(8) daemons on demand</refpurpose>
</refnamediv>

<refsynopsisdiv>
Expand Down
17 changes: 9 additions & 8 deletions doc/manual/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@ HTML_STYLESHEET=$(top_srcdir)/doc/html.xsl
CLEANFILES =

XML_PAGES = \
manual.xml \
configuration.xml \
gpl.xml \
install.xml \
intro.xml \
manual.xml \
upgrade.xml

EXTRA_DIST = \
manual.xml.in \
configuration.xml \
gpl.xml \
install.xml \
intro.xml \
upgrade.xml \
netatalk.html.in
manual.xml.in \
netatalk.html.in \
upgrade.xml

HTML_PAGES = \
a2boot.8.html \
Expand All @@ -29,13 +31,13 @@ HTML_PAGES = \
afpd.conf.5.html \
afpldaptest.1.html \
afppasswd.1.html \
AppleVolumes.default.5.html \
apple_dump.1.html \
AppleVolumes.default.5.html \
asip-status.1.html \
atalk.4.html \
atalkd.8.html \
atalkd.conf.5.html \
atalk_aton.3.html \
atalkd.conf.5.html \
cnid_dbd.8.html \
cnid_metad.8.html \
cnid2_create.1.html \
Expand All @@ -47,17 +49,16 @@ HTML_PAGES = \
installation.html \
intro.html \
macusers.1.html \
megatron.1.html \
man-pages.html \
manual-index.html \
megatron.1.html \
nbp.1.html \
nbp_name.3.html \
netatalk.conf.5.html \
netatalk-config.1.html \
pap.1.html \
papd.8.html \
papstatus.8.html \
pr01.html \
psf.8.html \
psorder.1.html \
showppd.1.html \
Expand Down
365 changes: 365 additions & 0 deletions doc/manual/gpl.xml

Large diffs are not rendered by default.

17 changes: 16 additions & 1 deletion doc/manual/intro.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="intro">
<title>Introduction to Netatalk</title>
<title>Introduction</title>

<sect1>
<title>Legal Notice</title>

<para>
This documentation is distributed under the GNU General Public License (GPL) version 2.
A copy of the license is included in this documentation, as well as within the Netatalk source
distribution. An on-line copy can be found at <ulink
url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt</ulink>
</para>
</sect1>

<sect1>
<title>Overview of Netatalk</title>

<para>Netatalk is an Open Source software package that can be used to turn
a *NIX machine into an extremely light-weight and
Expand All @@ -21,4 +35,5 @@
<para>Additionally, Netatalk can be used to act as an AppleTalk router,
providing both segmentation and zone names in traditional Macintosh networks.
</para>
</sect1>
</chapter>
27 changes: 9 additions & 18 deletions doc/manual/manual.xml.in
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!ENTITY Configuration SYSTEM "configuration.xml">
<!ENTITY Intro SYSTEM "intro.xml">
<!ENTITY Install SYSTEM "install.xml">
<!ENTITY License SYSTEM "gpl.xml">
<!ENTITY Upgrade SYSTEM "upgrade.xml">
<!ENTITY Configuration SYSTEM "configuration.xml">

<!ENTITY a2boot.8 SYSTEM "../manpages/man8/a2boot.8.xml">
<!ENTITY ad.1 SYSTEM "../manpages/man1/ad.1.xml">
Expand Down Expand Up @@ -52,18 +53,8 @@
<subtitle>Version @NETATALK_VERSION@</subtitle>
</bookinfo>

<?latex \setcounter{page}{3} ?>
<preface>
<title>Legal Notice</title>
<para>
This documentation is distributed under the GNU General Public License (GPL) version 2.
A copy of the license is included in this documentation, as well as within the Netatalk source
distribution. An on-line copy can be found at <ulink
url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt</ulink>
</para>
</preface>
<?latex \setcounter{page}{3} ?>

<?latex \cleardoublepage ?>
<!-- Contents -->
<toc/>
<?latex \cleardoublepage ?>
Expand All @@ -84,7 +75,7 @@ url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">http://www.gnu.org/li
<chapter id="man-pages">
<title>Manual Pages</title>

<para>This is a collection of the man pages delivered with Netatalk.</para>
<para>This is a collection of manual pages for Netatalk components.</para>

&a2boot.8;

Expand All @@ -106,10 +97,10 @@ url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">http://www.gnu.org/li

&afppasswd.1;

&AppleVolumes.default.5;

&apple_dump.1;

&AppleVolumes.default.5;

&asip-status.1;

&atalk.4;
Expand Down Expand Up @@ -162,7 +153,7 @@ url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">http://www.gnu.org/li
</chapter>
<?latex \cleardoublepage ?>

<?latex \include{gpl}?>
&License;
<?latex \cleardoublepage ?>

<index id="manual-index"><title>Index</title></index>
Expand Down
2 changes: 1 addition & 1 deletion doc/manual/netatalk.html.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@
<img src="/gfx/end.gif" alt="" width="125" height="7" />
</div>
</div>
<div class="navheader" align="center">@NETATALK_VERSION@</div>
<div class="navheader" align="center">Netatalk @NETATALK_VERSION@</div>
</html>
Loading