mirror of https://github.com/tLDP/LDP
New template packages, renamed the old files (included for editing
purposes, only the .zip files are linked to) and made some minor tweaks to the templates.
This commit is contained in:
emmajane
parent
211c724cbe
commit
c888f321bf
|
|
@ -100,17 +100,17 @@
|
|||
url="http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation
|
||||
License (GFDL)</ulink>, one of the <ulink
|
||||
url="http://www.creativecommons.org/license">Creative Commons
|
||||
Licenses</ulink>, or the LDP license (currently under review). The
|
||||
Licenses</ulink> (<ulink url="http://creativecommons.org/licenses/sa/1.0/">Share-Alike</ulink>, or <ulink url="http://creativecommons.org/licenses/by-sa/2.0/">Attribution-Share-Alike</ulink>), or the LDP license (currently under review). The
|
||||
full text of the license must be included in your document, including
|
||||
the title and version of the license you are using. The LDP will not
|
||||
accept new documents that do not meet licensing requirements.</para>
|
||||
|
||||
<warning>
|
||||
<title>Debian-compatible licenses</title>
|
||||
<para>Debian has branched the LDP documents into those with a <quote>free</quote> license and those with a <quote>non-free</quote> license. For a summary of this list, please read <ulink url="http://www.debian.org/legal/licenses/byname">Debian License Summaries</ulink>. Currently the Artistic License, BSD License and the GNU General Public License are listed as <quote>free</quote>. These licenses will also be accepted by the LDP.</para>
|
||||
</warning>
|
||||
|
||||
<para>You can get DocBook markups of both the GNU GPL
|
||||
and the GNU FDL from <ulink url="http://developer.gnome.org/projects/gdp/licenses.html">
|
||||
the GNOME Documentation Project</ulink>. You can then merely
|
||||
include the license in its entirety in your document. A
|
||||
DocBook-formatted copy of the license is available in
|
||||
<xref linkend="templates"/>.
|
||||
<para>You can get DocBook markups of both the GNU GPL and the GNU FDL from <ulink url="http://developer.gnome.org/projects/gdp/licenses.html"> the GNOME Documentation Project</ulink>. You can then merely include the license in its entirety in your document. A DocBook-formatted copy of the license is available in <xref linkend="templates"/>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -7,27 +7,13 @@
|
|||
|
||||
&ldp-markup;
|
||||
|
||||
<para>
|
||||
Most of the templates are available from the <ulink
|
||||
url="http://www.tldp.org/authors/index.html#resources">Author
|
||||
Resources</ulink> page. There are a few, additional, templates listed
|
||||
here.
|
||||
</para>
|
||||
|
||||
<section id="templates-book">
|
||||
<title>Book Templates</title>
|
||||
<para>
|
||||
The following templates may be downloaded and used to create your
|
||||
documents. Documents that are prefixed with a t- were provided by <ulink
|
||||
url="http://tille.soti.org/">Machtelt Garrels</ulink> (also known as
|
||||
Tille, which is pronounced Tilly by the anglophiles). Thanks Tille!
|
||||
</para>
|
||||
|
||||
<title>Document Templates</title>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>Article <ulink
|
||||
url="http://tldp.org/authors/template/Sample-HOWTO.xml" /></title>
|
||||
<title>HOWTO (Article) <ulink
|
||||
url="templates/ldp-howto.zip" /></title>
|
||||
<para>
|
||||
Most HOWTO documents will use this template.
|
||||
</para>
|
||||
|
|
@ -35,50 +21,25 @@
|
|||
</listitem>
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>Book <ulink url="t-book.xml" /></title>
|
||||
<title>Guide (Book) <ulink url="templates/ldp-guide.zip" /></title>
|
||||
<para>
|
||||
Use this template to create a full book (like this Author Guide,
|
||||
for instance).
|
||||
for instance). Templates provided by Tille Garrels.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>Appendix <ulink url="t-appendix.xml" /></title>
|
||||
<para>
|
||||
Use this template to create an appendix. This list of templates
|
||||
is an example of an appendix. Note the letters instead of the
|
||||
numbers which are used to distinguish sections.
|
||||
</para>
|
||||
<title>FAQ <ulink url="templates/ldp-faq.zip" /></title>
|
||||
<para>A standard article for writing a FAQ (Frequently Asked Questions) list.</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>Chapters <ulink url="t-chap1.xml" /> and <ulink
|
||||
url="t-chap2.xml" /></title>
|
||||
<para>
|
||||
Two sample chapters for <quote>book</quote> documents. This template
|
||||
is not required if you are using the <quote>article</quote> template.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>Glossary <ulink url="t-glossary.xml" /></title>
|
||||
<para>
|
||||
For making glossaries.
|
||||
</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<formalpara>
|
||||
<title>FAQ <ulink url="t-faq.xml" /></title>
|
||||
<para>
|
||||
A standard article for writing a FAQ (Frequently Asked Questions) list.
|
||||
</para>
|
||||
<title>LinuxDoc<ulink url="templates/ldp-linuxdoc.zip" /></title>
|
||||
<para>A standard template both in HOWTO length and Guide length.</para>
|
||||
</formalpara>
|
||||
</listitem>
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
The Linux Documentation Project :: Guide Template
|
||||
-------------------------------------------------
|
||||
The following documents are provided as templates for your own Guide
|
||||
(book-length document). You are not required to use all of the templates
|
||||
provided in this package for your document. They are only a suggestion of
|
||||
what you might need based on the many documents we have reviewed and
|
||||
accepted in our collection over the years. We hope you find them useful.
|
||||
|
||||
These files are all in DocBook XML version 4.2. If you would prefer to use
|
||||
LinuxDoc, please download the LinuxDoc templates. If you are writing your
|
||||
document in a different format, please follow the instructions in the
|
||||
Author Guide on how to transform your document into DocBook before
|
||||
submitting it to the collection.
|
||||
http://www.tldp.org/LDP/LDP-Author-Guide/html/x2docbook.html
|
||||
|
||||
Please send suggestions to: feedback@tldp.org.
|
||||
|
||||
ldp-appendix.xml
|
||||
A sample appendix. Typically used for the full text of your document's
|
||||
license and additional instructions that are not part of the "core" of
|
||||
your document.
|
||||
|
||||
ldp-bibliography.xml
|
||||
A sample bibliography with sections.
|
||||
|
||||
ldp-glossary.xml
|
||||
A sample glossary.
|
||||
|
||||
ldp-guide-chap1.xml and ldp-guide-chap2.xml
|
||||
Two sample chapters with common DocBook markup.
|
||||
|
||||
ldp-guide-main.xml
|
||||
The main file that refers to each of the additional XML files. When the
|
||||
file is transformed from XML to another format, this file is the master
|
||||
outline that informs the processing tool where each of the components
|
||||
are.
|
||||
|
||||
If you are writing a shorter HOWTO, please use the ldp-howto.zip package
|
||||
instead.
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
The Linux Documentation Project :: HOWTO Template
|
||||
-------------------------------------------------
|
||||
The following documents are provided as templates for your own HOWTO
|
||||
(typically documents shorter than 20 pages). You are not required to use
|
||||
all of the templates provided in this package for your document. They are
|
||||
only a suggestion of what you might need based on the many documents we
|
||||
have reviewed and accepted in our collection over the years. We hope you
|
||||
find this template useful.
|
||||
|
||||
These files are all in DocBook XML version 4.2. If you would prefer to use
|
||||
LinuxDoc, please download the LinuxDoc templates. If you are writing your
|
||||
document in a different format, please follow the instructions in the
|
||||
Author Guide on how to transform your document into DocBook before
|
||||
submitting it to the collection.
|
||||
http://www.tldp.org/LDP/LDP-Author-Guide/html/x2docbook.html
|
||||
|
||||
Please send suggestions to: feedback@tldp.org.
|
||||
|
||||
ldp-appendix.xml
|
||||
A sample appendix. Typically used for the full text of your document's
|
||||
license and additional instructions that are not part of the "core" of
|
||||
your document.
|
||||
|
||||
ldp-bibliography.xml
|
||||
A sample bibliography with sections.
|
||||
|
||||
ldp-glossary.xml
|
||||
A sample glossary.
|
||||
|
||||
ldp-howto.xml
|
||||
The master file. You may either include each of the external files
|
||||
listed above into this document, or call them with XML entities. There
|
||||
are instructions for both methods inside the template.
|
||||
|
||||
If you are writing a longer GUIDE, please use the ldp-guide.zip package
|
||||
instead.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
The Linux Documentation Project :: LinuxDoc Templates
|
||||
-----------------------------------------------------
|
||||
The following documents are provided as templates for your own HOWTO
|
||||
(article-length document) or Guide (book-length document). We hope you
|
||||
find them useful.
|
||||
|
||||
Please send suggestions to: feedback@tldp.org.
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
<bibliography id="bibliography">
|
||||
<?dbhtml filename="bibliography.html"?>
|
||||
<title>References and Resources</title>
|
||||
<!-- these are just examples...you do not need to use these sections. -->
|
||||
|
||||
<!-- A full bibliography entry would use the following template. -->
|
||||
<!--
|
||||
<biblioentry>
|
||||
<title>
|
||||
</title>
|
||||
<bibliosource><ulink url="" /></bibliosource>
|
||||
<author><firstname></firstname><surname></surname></author>
|
||||
<copyright><year></year>
|
||||
<holder></holder></copyright>
|
||||
<editor><firstname></firstname><surname></surname></editor>
|
||||
<isbn></isbn>
|
||||
<publisher>
|
||||
<publishername></publishername>
|
||||
</publisher>
|
||||
</biblioentry>
|
||||
-->
|
||||
|
||||
<bibliodiv id="ref-howto" xreflabel="HOWTOs">
|
||||
<title>HOWTOs</title>
|
||||
|
||||
<biblioentry>
|
||||
<title>Document Title</title>
|
||||
<bibliosource><ulink url="URL" /></bibliosource>
|
||||
</biblioentry>
|
||||
|
||||
<biblioentry>
|
||||
<title>Document Title 2</title>
|
||||
<bibliosource><ulink url="URL 2" /></bibliosource>
|
||||
</biblioentry>
|
||||
</bibliodiv>
|
||||
|
||||
<bibliodiv id="ref-installreports" xreflabel="Hardware-specific Install Reports and Info">
|
||||
<title>Hardware-specific Install Reports and Info</title>
|
||||
|
||||
<biblioentry>
|
||||
<title>Installation Reports</title>
|
||||
<bibliosource><ulink url="URL 3"/></bibliosource>
|
||||
</biblioentry>
|
||||
|
||||
<biblioentry>
|
||||
<title>Blacklist</title>
|
||||
<bibliosource><ulink url="URL 4"/></bibliosource>
|
||||
</biblioentry>
|
||||
</bibliodiv>
|
||||
|
||||
<bibliodiv id="ref-mailinglist" xreflabel="Mailing List Threads">
|
||||
<title>Mailing List Threads</title>
|
||||
<biblioentry>
|
||||
<title>mailing_list_name thread: subject line</title>
|
||||
<bibliosource><ulink url="URL 5" /></bibliosource>
|
||||
</biblioentry>
|
||||
|
||||
<bibliodiv id="ref-software" xreflabel="Packages and related software">
|
||||
<title>Packages and related software</title>
|
||||
<biblioentry>
|
||||
<title>The Kernel</title>
|
||||
<bibliosource><ulink url="http://www.kernel.org" /></bibliosource>
|
||||
<abstract><para>Remember to choose "F" for full when you download your
|
||||
kernel source.</para></abstract>
|
||||
</biblioentry>
|
||||
</bibliodiv>
|
||||
|
||||
</bibliography>
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
|
@ -2,14 +2,11 @@
|
|||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
|
||||
|
||||
<!ENTITY chap1 SYSTEM "chap1.xml">
|
||||
<!ENTITY chap2 SYSTEM "chap2.xml">
|
||||
<!ENTITY chap3 SYSTEM "chap3.xml">
|
||||
<!ENTITY chap4 SYSTEM "chap4.xml">
|
||||
<!ENTITY chap5 SYSTEM "chap5.xml">
|
||||
<!ENTITY app1 SYSTEM "app1.xml">
|
||||
<!ENTITY app2 SYSTEM "app2.xml">
|
||||
<!ENTITY gloss SYSTEM "gloss.xml">
|
||||
<!ENTITY chap1 SYSTEM "ldp-guide-chap1.xml">
|
||||
<!ENTITY chap2 SYSTEM "ldp-guide-chap2.xml">
|
||||
<!-- and so on for each of your chapters -->
|
||||
<!ENTITY app1 SYSTEM "ldp-appendix.xml">
|
||||
<!ENTITY gloss SYSTEM "ldp-glossary.xml">
|
||||
]>
|
||||
|
||||
<book>
|
||||
|
|
@ -115,9 +112,8 @@ maintainer of this document: <address><email>you@your.domain</email></address>
|
|||
</para>
|
||||
<para> Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.1 or any later
|
||||
version published by the Free Software Foundation; with the Invariant Sections
|
||||
being the <quote>Copyright information</quote> and <quote>Feedback</quote>
|
||||
sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the
|
||||
version published by the Free Software Foundation; with no Invariant
|
||||
Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the
|
||||
license is included in <xref linkend="app4" /> entitled <quote>GNU Free
|
||||
Documentation License</quote>.
|
||||
</para>
|
||||
|
|
@ -252,10 +248,6 @@ within this guide.</entry>
|
|||
|
||||
&chap1;
|
||||
&chap2;
|
||||
&chap3;
|
||||
&chap4;
|
||||
&chap5;
|
||||
&app1;
|
||||
&app2;
|
||||
&gloss;
|
||||
</book>
|
||||
Binary file not shown.
|
|
@ -0,0 +1,200 @@
|
|||
<!doctype linuxdoc system>
|
||||
|
||||
<!--
|
||||
The line above starts a comments section
|
||||
|
||||
|
||||
A changelog is useful if you don't use cvs etc.
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
Changelog:
|
||||
291000: Created this minimal Template for small HOWTOs
|
||||
311000: Fixed a typo and folded "News" into "Intro" and deleted "Translations"
|
||||
|
||||
The line below ends the comments section.
|
||||
-->
|
||||
|
||||
|
||||
<article>
|
||||
|
||||
|
||||
<title>HOWTO-template for small HOWTOs <!-- insert your title here -->
|
||||
<author>Stein Gjoen, <tt/sgjoen@nyx.net/ <!-- insert your name here -->
|
||||
<date>v0.03, 20 May 2002 <!-- always have a version number and a date -->
|
||||
<abstract> <!-- the abstract: a short and precise description -->
|
||||
<nidx>(your index root)</nidx> <!-- add indexing keywords as you go along -->
|
||||
<!-- nidx means the indexed word is not in output of main text, only in the index -->
|
||||
This is a fully working template for small HOWTOs. The source contains
|
||||
fully described slots to make a convenient framework for you to fill in
|
||||
for making your own HOWTO, suggesting some names, conventions and contents
|
||||
for the chapters.
|
||||
|
||||
While derived from the Template for big HOWTOs this
|
||||
is a minimalistic Template that only lists the
|
||||
minimal requirements to fit into the
|
||||
Linux Documentation Project archives
|
||||
</abstract>
|
||||
|
||||
|
||||
|
||||
<!-- Table of contents -->
|
||||
<toc>
|
||||
|
||||
<!-- Begin the document -->
|
||||
|
||||
|
||||
<sect>Introduction
|
||||
|
||||
<p> <!-- always use a p tag (paragraph) immediately after a sect tag -->
|
||||
<nidx>(your index root)!introduction</nidx> <!-- here introduction is a sub entry of template, exclamationmark is separator -->
|
||||
<em>My comments to the reader is in this style (emphasized)</em>.
|
||||
Example lines are in plain roman style.
|
||||
<em>Note that extra comments and advice is found in comments
|
||||
within the SGML source.</em> <!-- such as this comment -->
|
||||
|
||||
For various reasons this brand new release is codenamed
|
||||
the <bf/unleash/ release.
|
||||
|
||||
New code names will appear as per industry standard guidelines
|
||||
to emphasize the state-of-the-art-ness of this document.
|
||||
|
||||
<p>
|
||||
<em>This Template is a suggestion and a starting point, a check list
|
||||
for minimum features and also examples for authors.
|
||||
Over time HOWTOs will outgrow any template since
|
||||
in the end the goal is to inform readers efficiently.</em>
|
||||
|
||||
Stating the background is a simple way to getting started
|
||||
writing the intro.
|
||||
|
||||
<em>This is where you make a summary of what it news. When a HOWTO exceeds
|
||||
20 pages it takes more than a casual read to find the updates. This is
|
||||
where you help your readers with that, alerting them to specific and
|
||||
important news.</em>
|
||||
|
||||
This is the first update featuring an improved structure.
|
||||
<!-- Note that you might wish to keep old news commented out for reference
|
||||
and perhaps state news as latest and next to latest update. -->
|
||||
|
||||
<em>Tell people where the document home page is so the very newest
|
||||
release could be found in case of problems with the main
|
||||
<url url="http://www.linuxdoc.org/"
|
||||
name="Linux Documentation Project">
|
||||
homepage.
|
||||
</em>
|
||||
|
||||
The latest version number of this document can be gleaned from my
|
||||
plan entry if you <!-- do "finger sgjoen@nox.nyx.net" -->
|
||||
<url url="http://www.cs.indiana.edu/finger/nox.nyx.net/sgjoen"
|
||||
name="finger"> my Nyx account.
|
||||
|
||||
First of all we need a bit of legalese. Recent development shows it is
|
||||
quite important.
|
||||
|
||||
<sect1>Copyright
|
||||
<p>
|
||||
<em>Copyright is a source of much and continuous debate on the
|
||||
LDP mailing list. For more in depth information please consult
|
||||
the Manifesto at the </em>
|
||||
<url url="http://www.LinuxDoc.org/"
|
||||
name="LinuxDoc">
|
||||
site.
|
||||
<em>
|
||||
The purpose of having a license is to allow appropriate distribution.
|
||||
You can use any license that meets the Manifesto.
|
||||
What follows is a boilerplate licence.
|
||||
</em>
|
||||
|
||||
This document is Copyright 2000 by John Doe (change to your name).
|
||||
Permission is granted to
|
||||
copy, distribute and/or modify this document under the terms of the
|
||||
GNU Free Documentation License, Version 1.1 or any later version
|
||||
published by the Free Software Foundation with no Invariant Sections,
|
||||
no Front-Cover Texts, and no Back-Cover Texts. A copy of the license
|
||||
can be found in Appendix A.
|
||||
|
||||
<em>Replace with your name, or
|
||||
supply a new license, when you use this template for a new HOWTO.</em>
|
||||
|
||||
<sect1>Disclaimer
|
||||
<p>
|
||||
Use the information in this document at your own risk. I disavow any
|
||||
potential liability for the contents of this document. Use of the
|
||||
concepts, examples, and/or other content of this document is entirely
|
||||
at your own risk.
|
||||
|
||||
All copyrights are owned by their owners, unless specifically noted
|
||||
otherwise. Use of a term in this document should not be regarded as
|
||||
affecting the validity of any trademark or service mark.
|
||||
|
||||
Naming of particular products or brands should not be seen as endorsements.
|
||||
|
||||
You are strongly recommended to take a backup of your system before
|
||||
major installation and backups at regular intervals.
|
||||
|
||||
|
||||
|
||||
<em>If you have the capacity it would be nice to make the HOWTO
|
||||
available in a number of formats.</em>
|
||||
|
||||
Also, the latest version of the Template will be available on
|
||||
my web space on Nyx in a number of formats:
|
||||
<itemize>
|
||||
<item>
|
||||
<url url="http://www.nyx.net/˜sgjoen/mintplt.html"
|
||||
name="HTML">.
|
||||
|
||||
<item>
|
||||
<url url="http://www.nyx.net/˜sgjoen/mintplt.txt"
|
||||
name="plain ASCII text">.
|
||||
|
||||
<item>
|
||||
<url url="http://www.nyx.net/˜sgjoen/mintplt.sgml"
|
||||
name="SGML source">.
|
||||
</itemize>
|
||||
|
||||
<sect1>Credits
|
||||
<p>
|
||||
<em>It is always nice to acknowledge people who help you with inputs, it
|
||||
is also regarded by many as important in the Linux world new economy</em>
|
||||
|
||||
In this version I have the pleasure of acknowledging
|
||||
<tscreen><verb>
|
||||
corff (at) ZEDAT.FU-Berlin.DE
|
||||
dwood (at) plugged.net.au
|
||||
lcl (at) spiretech.com
|
||||
kgh12351 (at) nifty.ne.jp
|
||||
dave (at) lafn.org
|
||||
gferg (at) hoop.timonium.sgi.com
|
||||
name (at) site.org
|
||||
</verb></tscreen>
|
||||
|
||||
<em>Scramble the addresses so email harvesters cannot get
|
||||
addresses from your HOWTO and then spam people. That has
|
||||
happened in the past.</em>
|
||||
|
||||
|
||||
Also Somecompany is acknowledged for sending me documentation
|
||||
on their gizmos as well as permission to quote from the material.
|
||||
These quotes have been approved before appearing here and will
|
||||
be clearly labelled.
|
||||
|
||||
Any comments or suggestions can be mailed to my mail address on Nyx:
|
||||
<htmlurl url="mailto:sgjoen@nyx.net/"
|
||||
name="sgjoen@nyx.net">
|
||||
(replace with your own address.)
|
||||
<p>
|
||||
|
||||
|
||||
<!--
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
-->
|
||||
|
||||
|
||||
<sect>The Main Text
|
||||
<p>
|
||||
<em>Here comes the documentation itself.</em>
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
|
@ -0,0 +1,722 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
||||
[
|
||||
<!--
|
||||
This is where we will call the external files that we would like to
|
||||
include in our document. Uncomment each line if you wish to call the
|
||||
corresponding external file. At the end of the document you will
|
||||
also need to uncomment the corresponding entity.
|
||||
-->
|
||||
<!-- Appendix -->
|
||||
<!-- <!ENTITY appendix SYSTEM "ldp-appendix.xml"> -->
|
||||
<!-- Remember to uncomment &appendix; in the document body as well. -->
|
||||
|
||||
<!-- Glossary -->
|
||||
<!-- <!ENTITY glossary SYSTEM "ldp-glossary.xml"> -->
|
||||
<!-- Remember to uncomment &glossary; in the document body as well. -->
|
||||
|
||||
<!-- Bibliography -->
|
||||
<!-- <!ENTITY bibliography SYSTEM "ldp-bibliography.xml"> -->
|
||||
<!-- Remember to uncomment &bibliography; in the document body as well. -->
|
||||
]>
|
||||
|
||||
<article id="index">
|
||||
<articleinfo>
|
||||
<title>Sample XML HOWTO</title>
|
||||
|
||||
<author>
|
||||
<firstname>Your Given Name</firstname>
|
||||
<surname>Your Family Name (Surname)</surname>
|
||||
<authorblurb><para>A short sentence about who you are.</para></authorblurb>
|
||||
<affiliation>
|
||||
<!-- The name of your organization is optional. -->
|
||||
<orgname>
|
||||
<ulink url="http://www.URL.com">company name</ulink>
|
||||
</orgname>
|
||||
|
||||
<!-- A valid email is required. You may add a spam blocker, or get a Yahoo/Gmail/etc account. -->
|
||||
<address>
|
||||
<email>youremail@domain.NOSPAM.org</email>
|
||||
</address>
|
||||
</affiliation>
|
||||
</author>
|
||||
|
||||
<!-- The date of publication. -->
|
||||
<pubdate>YYYY-MM-DD</pubdate>
|
||||
|
||||
<!-- A short description of what is contained in this document. -->
|
||||
<abstract>
|
||||
<para>This is a sample DocBook XML HOWTO which you may use as a document template.</para>
|
||||
</abstract>
|
||||
|
||||
<!-- A summary of the revisions to date. The latest revision should be at the top. -->
|
||||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>1.1</revnumber>
|
||||
<date>2005-03-04</date>
|
||||
<authorinitials>ME</authorinitials>
|
||||
<revremark>A short note about what you have changed.</revremark>
|
||||
</revision>
|
||||
<revision>
|
||||
<revnumber>1.0</revnumber>
|
||||
<date>YYYY-MM-DD</date>
|
||||
<authorinitials>ME</authorinitials>
|
||||
<revremark>First official release.</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
</articleinfo>
|
||||
|
||||
<!--
|
||||
A little about file names...
|
||||
If you would like, you can add an "id" to each of your sections.
|
||||
The id will be used as the file name when output to HTML. Make sure
|
||||
it is:
|
||||
1) all one word
|
||||
2) contains no spaces
|
||||
As of March 2005, the LDP is using DSSSL processing tools. The
|
||||
<?dbhtml filename="file.html" ?>
|
||||
should match the id so that the file names are the same regardless of
|
||||
processing tools.
|
||||
-->
|
||||
<sect1 id="about">
|
||||
<?dbhtml filename="about.html"?>
|
||||
<title>About this document</title>
|
||||
|
||||
<sect2 id="copyright">
|
||||
<?dbhtml filename="copyright.html"?>
|
||||
<title>Copyright and License</title>
|
||||
<para>
|
||||
Copyright (c) YEAR by YOUR NAME.</para>
|
||||
<para>Permission is granted to copy, distribute and/or modify this
|
||||
document under the terms of the GNU Free Documentation License, Version
|
||||
1.1 or any later version published by the Free Software Foundation;
|
||||
with no Invariant Sections, no Front-Cover Texts, and with no Back-Cover
|
||||
Texts.
|
||||
A copy of the license is included in <xref linkend="gfdl"/>.
|
||||
<!-- The LDP requires you to include the full text of the license. -->
|
||||
</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="translations">
|
||||
<?dbhtml filename="translations.html"?>
|
||||
<title>Translations</title>
|
||||
|
||||
<!--
|
||||
Probably your document will not have a translation to start.
|
||||
Uncomment the following section when there are translations ready.
|
||||
-->
|
||||
<!--
|
||||
<para>This document is also available in the following languages:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><ulink url="URL">LANGUAGE</ulink>. Include a note of thanks to your translation team.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
-->
|
||||
|
||||
<para>If you know of any translations for this document, or you are interested in translating it, please email me <email>YOUR EMAIL</email>.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="preface">
|
||||
<title>Preface</title>
|
||||
<para>Tell us why you decided to write this document.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="thanks">
|
||||
<title>Acknowledgments</title>
|
||||
<para>No one ever writes documentation by themselves. Please take the time to thank the people who have helped you.</para>
|
||||
|
||||
<!-- If it is a long list of people, you may want to use a bullet list: -->
|
||||
<!--
|
||||
<itemizedlist>
|
||||
<listitem><para></para></listitem>
|
||||
<listitem><para></para></listitem>
|
||||
<listitem><para></para></listitem>
|
||||
</itemizedlist>
|
||||
-->
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2 id="feedback">
|
||||
<title>Feedback</title>
|
||||
<para>Find something wrong with this document? (Or perhaps something right?) I would love to hear from you. Please email me at <email>YOUR EMAIL</email>.</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="conventions">
|
||||
<title>Conventions used in this document</title>
|
||||
<!--
|
||||
This section was provided by Machtelt Garrels.
|
||||
You do not need to include it in your document, especially if your HOWTO is
|
||||
very short.
|
||||
-->
|
||||
<para>The following typographic and usage conventions occur in this text:
|
||||
</para>
|
||||
|
||||
<table id="table-conventions" frame="all">
|
||||
<title>Typographic and usage conventions</title>
|
||||
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
||||
|
||||
<thead>
|
||||
<row><entry>Text type</entry><entry>Meaning</entry></row>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><quote>Quoted text</quote></entry>
|
||||
<entry>Quotes from people, quoted computer output.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><screen>terminal view</screen></entry>
|
||||
<entry>Literal computer input and output captured from the terminal.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><command>command</command></entry>
|
||||
<entry>Name of a command that can be entered on the command line.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><option>option</option></entry>
|
||||
<entry>Option to a command, as in <quote>the <option>-a</option> option to the
|
||||
<command>ls</command> command</quote>.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><parameter>parameter</parameter></entry>
|
||||
<entry>Parameter to a command, as in <quote>read
|
||||
<command>man <parameter>ls</parameter></command></quote>.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><cmdsynopsis><command>command <option>options</option>
|
||||
<parameter>arguments</parameter></command></cmdsynopsis></entry>
|
||||
<entry>Command synopsis or general usage, on a separated line.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><filename>filename</filename></entry>
|
||||
<entry>Name of a file or directory, for example <quote>Change to the
|
||||
<filename class="directory">/usr/bin</filename> directory.</quote></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><menuchoice><guimenu>Menu</guimenu><guimenuitem>Choice</guimenuitem>
|
||||
</menuchoice></entry>
|
||||
<entry>Choice to select from a graphical menu, for instance: <quote>Select
|
||||
<menuchoice><guimenu>Help</guimenu><guimenuitem>About Mozilla</guimenuitem>
|
||||
</menuchoice> in your browser.</quote></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><ulink url="http://www.xtrinsic.com">The author</ulink></entry>
|
||||
<entry>Click-able link to an external web resource.</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
|
||||
</tgroup>
|
||||
</table>
|
||||
|
||||
<para>Thanks to Machtelt <quote>Tille</quote> Garrels for this list of conventions.</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="about">
|
||||
<?dbhtml filename="about.html"?>
|
||||
<title>About My Topic</title>
|
||||
|
||||
<para>Start by explaining the basics of your topic. Is a brief history lesson in order?</para>
|
||||
|
||||
<sect2 id="distro-news">
|
||||
<title>Distribution News</title>
|
||||
<para>If there is any news specific to each of the distrobutions of Linux, you can include it here.</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="install">
|
||||
<?dbhtml filename="install.html"?>
|
||||
<title>Installing from scratch</title>
|
||||
<para>Write down each of the steps on how to install any necessary packages/software/etc. Do you need to recompile the kernel to activate new options?</para>
|
||||
|
||||
<para>If there are any step-by-step instructions, you may want to include them in an example so that they can be easily referred to later.</para>
|
||||
|
||||
<example id="ex-install" xreflabel="Installation Instructions">
|
||||
<title>Installation Instructions</title>
|
||||
<orderedlist>
|
||||
<listitem><para>Step One.</para></listitem>
|
||||
<listitem><para>Step Two.</para></listitem>
|
||||
<listitem><para>Step Three.</para></listitem>
|
||||
</orderedlist>
|
||||
</example>
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1 id="using-softwarepackage" xreflabel="Using SOFTWARE">
|
||||
<?dbhtml filename="using-softwarepackage.html"?>
|
||||
<title>Using SOFTWARE</title>
|
||||
<para>Finally! Now you can describe how to use your system/software/package.</para>
|
||||
</sect1>
|
||||
|
||||
<!-- If you had a second appendix in an external file, you would call it
|
||||
here with the following: -->
|
||||
&appendix;
|
||||
<!-- This exactly matches the word you used at the very top of the
|
||||
document. Use whatever word makes sense to you so long as it only uses
|
||||
letters, underscores and hyphens. -->
|
||||
|
||||
<appendix id="gfdl">
|
||||
<title>GNU Free Documentation License</title>
|
||||
<!-- - GNU Project - Free Software Foundation (FSF) -->
|
||||
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
|
||||
<!-- http://www.gnu.org/copyleft/fdl.html -->
|
||||
|
||||
<sect1>
|
||||
<title>GNU Free Documentation License</title>
|
||||
|
||||
<para>Version 1.1, March 2000</para>
|
||||
|
||||
<blockquote>
|
||||
<para>Copyright (C) 2000 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.</para>
|
||||
</blockquote>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-0">
|
||||
<title>PREAMBLE</title>
|
||||
|
||||
<para>The purpose of this License is to make a manual, textbook,
|
||||
or other written document "free" in the sense of freedom: to
|
||||
assure everyone the effective freedom to copy and redistribute it,
|
||||
with or without modifying it, either commercially or
|
||||
noncommercially. Secondarily, this License preserves for the
|
||||
author and publisher a way to get credit for their work, while not
|
||||
being considered responsible for modifications made by
|
||||
others.</para>
|
||||
|
||||
<para>This License is a kind of "copyleft", which means that
|
||||
derivative works of the document must themselves be free in the
|
||||
same sense. It complements the GNU General Public License, which
|
||||
is a copyleft license designed for free software.</para>
|
||||
|
||||
<para>We have designed this License in order to use it for manuals
|
||||
for free software, because free software needs free documentation:
|
||||
a free program should come with manuals providing the same
|
||||
freedoms that the software does. But this License is not limited
|
||||
to software manuals; it can be used for any textual work,
|
||||
regardless of subject matter or whether it is published as a
|
||||
printed book. We recommend this License principally for works
|
||||
whose purpose is instruction or reference.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-1">
|
||||
<title>APPLICABILITY AND DEFINITIONS</title>
|
||||
|
||||
<para>This License applies to any manual or other work that
|
||||
contains a notice placed by the copyright holder saying it can be
|
||||
distributed under the terms of this License. The "Document",
|
||||
below, refers to any such manual or work. Any member of the
|
||||
public is a licensee, and is addressed as "you".</para>
|
||||
|
||||
<para>A "Modified Version" of the Document means any work
|
||||
containing the Document or a portion of it, either copied
|
||||
verbatim, or with modifications and/or translated into another
|
||||
language.</para>
|
||||
|
||||
<para>A "Secondary Section" is a named appendix or a front-matter
|
||||
section of the Document that deals exclusively with the
|
||||
relationship of the publishers or authors of the Document to the
|
||||
Document's overall subject (or to related matters) and contains
|
||||
nothing that could fall directly within that overall subject.
|
||||
(For example, if the Document is in part a textbook of
|
||||
mathematics, a Secondary Section may not explain any mathematics.)
|
||||
The relationship could be a matter of historical connection with
|
||||
the subject or with related matters, or of legal, commercial,
|
||||
philosophical, ethical or political position regarding
|
||||
them.</para>
|
||||
|
||||
<para>The "Invariant Sections" are certain Secondary Sections
|
||||
whose titles are designated, as being those of Invariant Sections,
|
||||
in the notice that says that the Document is released under this
|
||||
License.</para>
|
||||
|
||||
<para>The "Cover Texts" are certain short passages of text that
|
||||
are listed, as Front-Cover Texts or Back-Cover Texts, in the
|
||||
notice that says that the Document is released under this
|
||||
License.</para>
|
||||
|
||||
<para>A "Transparent" copy of the Document means a
|
||||
machine-readable copy, represented in a format whose specification
|
||||
is available to the general public, whose contents can be viewed
|
||||
and edited directly and straightforwardly with generic text
|
||||
editors or (for images composed of pixels) generic paint programs
|
||||
or (for drawings) some widely available drawing editor, and that
|
||||
is suitable for input to text formatters or for automatic
|
||||
translation to a variety of formats suitable for input to text
|
||||
formatters. A copy made in an otherwise Transparent file format
|
||||
whose markup has been designed to thwart or discourage subsequent
|
||||
modification by readers is not Transparent. A copy that is not
|
||||
"Transparent" is called "Opaque".</para>
|
||||
|
||||
<para>Examples of suitable formats for Transparent copies include
|
||||
plain ASCII without markup, Texinfo input format, LaTeX input
|
||||
format, SGML or XML using a publicly available DTD, and
|
||||
standard-conforming simple HTML designed for human modification.
|
||||
Opaque formats include PostScript, PDF, proprietary formats that
|
||||
can be read and edited only by proprietary word processors, SGML
|
||||
or XML for which the DTD and/or processing tools are not generally
|
||||
available, and the machine-generated HTML produced by some word
|
||||
processors for output purposes only.</para>
|
||||
|
||||
<para>The "Title Page" means, for a printed book, the title page
|
||||
itself, plus such following pages as are needed to hold, legibly,
|
||||
the material this License requires to appear in the title page.
|
||||
For works in formats which do not have any title page as such,
|
||||
"Title Page" means the text near the most prominent appearance of
|
||||
the work's title, preceding the beginning of the body of the
|
||||
text.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-2">
|
||||
<title>VERBATIM COPYING</title>
|
||||
|
||||
<para>You may copy and distribute the Document in any medium,
|
||||
either commercially or noncommercially, provided that this
|
||||
License, the copyright notices, and the license notice saying this
|
||||
License applies to the Document are reproduced in all copies, and
|
||||
that you add no other conditions whatsoever to those of this
|
||||
License. You may not use technical measures to obstruct or
|
||||
control the reading or further copying of the copies you make or
|
||||
distribute. However, you may accept compensation in exchange for
|
||||
copies. If you distribute a large enough number of copies you
|
||||
must also follow the conditions in section 3.</para>
|
||||
|
||||
<para>You may also lend copies, under the same conditions stated
|
||||
above, and you may publicly display copies.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-3">
|
||||
<title>COPYING IN QUANTITY</title>
|
||||
|
||||
<para>If you publish printed copies of the Document numbering more
|
||||
than 100, and the Document's license notice requires Cover Texts,
|
||||
you must enclose the copies in covers that carry, clearly and
|
||||
legibly, all these Cover Texts: Front-Cover Texts on the front
|
||||
cover, and Back-Cover Texts on the back cover. Both covers must
|
||||
also clearly and legibly identify you as the publisher of these
|
||||
copies. The front cover must present the full title with all
|
||||
words of the title equally prominent and visible. You may add
|
||||
other material on the covers in addition. Copying with changes
|
||||
limited to the covers, as long as they preserve the title of the
|
||||
Document and satisfy these conditions, can be treated as verbatim
|
||||
copying in other respects.</para>
|
||||
|
||||
<para>If the required texts for either cover are too voluminous to
|
||||
fit legibly, you should put the first ones listed (as many as fit
|
||||
reasonably) on the actual cover, and continue the rest onto
|
||||
adjacent pages.</para>
|
||||
|
||||
<para>If you publish or distribute Opaque copies of the Document
|
||||
numbering more than 100, you must either include a
|
||||
machine-readable Transparent copy along with each Opaque copy, or
|
||||
state in or with each Opaque copy a publicly-accessible
|
||||
computer-network location containing a complete Transparent copy
|
||||
of the Document, free of added material, which the general
|
||||
network-using public has access to download anonymously at no
|
||||
charge using public-standard network protocols. If you use the
|
||||
latter option, you must take reasonably prudent steps, when you
|
||||
begin distribution of Opaque copies in quantity, to ensure that
|
||||
this Transparent copy will remain thus accessible at the stated
|
||||
location until at least one year after the last time you
|
||||
distribute an Opaque copy (directly or through your agents or
|
||||
retailers) of that edition to the public.</para>
|
||||
|
||||
<para>It is requested, but not required, that you contact the
|
||||
authors of the Document well before redistributing any large
|
||||
number of copies, to give them a chance to provide you with an
|
||||
updated version of the Document.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-4">
|
||||
<title>MODIFICATIONS</title>
|
||||
|
||||
<para>You may copy and distribute a Modified Version of the
|
||||
Document under the conditions of sections 2 and 3 above, provided
|
||||
that you release the Modified Version under precisely this
|
||||
License, with the Modified Version filling the role of the
|
||||
Document, thus licensing distribution and modification of the
|
||||
Modified Version to whoever possesses a copy of it. In addition,
|
||||
you must do these things in the Modified Version:</para>
|
||||
|
||||
<orderedlist numeration="upperalpha">
|
||||
<listitem><para>Use in the Title Page
|
||||
(and on the covers, if any) a title distinct from that of the
|
||||
Document, and from those of previous versions (which should, if
|
||||
there were any, be listed in the History section of the
|
||||
Document). You may use the same title as a previous version if
|
||||
the original publisher of that version gives permission.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>List on the Title Page,
|
||||
as authors, one or more persons or entities responsible for
|
||||
authorship of the modifications in the Modified Version,
|
||||
together with at least five of the principal authors of the
|
||||
Document (all of its principal authors, if it has less than
|
||||
five).</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>State on the Title page
|
||||
the name of the publisher of the Modified Version, as the
|
||||
publisher.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Preserve all the
|
||||
copyright notices of the Document.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Add an appropriate
|
||||
copyright notice for your modifications adjacent to the other
|
||||
copyright notices.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Include, immediately
|
||||
after the copyright notices, a license notice giving the public
|
||||
permission to use the Modified Version under the terms of this
|
||||
License, in the form shown in the Addendum below.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Preserve in that license
|
||||
notice the full lists of Invariant Sections and required Cover
|
||||
Texts given in the Document's license notice.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Include an unaltered
|
||||
copy of this License.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Preserve the section
|
||||
entitled "History", and its title, and add to it an item stating
|
||||
at least the title, year, new authors, and publisher of the
|
||||
Modified Version as given on the Title Page. If there is no
|
||||
section entitled "History" in the Document, create one stating
|
||||
the title, year, authors, and publisher of the Document as given
|
||||
on its Title Page, then add an item describing the Modified
|
||||
Version as stated in the previous sentence.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Preserve the network
|
||||
location, if any, given in the Document for public access to a
|
||||
Transparent copy of the Document, and likewise the network
|
||||
locations given in the Document for previous versions it was
|
||||
based on. These may be placed in the "History" section. You
|
||||
may omit a network location for a work that was published at
|
||||
least four years before the Document itself, or if the original
|
||||
publisher of the version it refers to gives permission.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>In any section entitled
|
||||
"Acknowledgements" or "Dedications", preserve the section's
|
||||
title, and preserve in the section all the substance and tone of
|
||||
each of the contributor acknowledgements and/or dedications
|
||||
given therein.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Preserve all the
|
||||
Invariant Sections of the Document, unaltered in their text and
|
||||
in their titles. Section numbers or the equivalent are not
|
||||
considered part of the section titles.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Delete any section
|
||||
entitled "Endorsements". Such a section may not be included in
|
||||
the Modified Version.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem><para>Do not retitle any
|
||||
existing section as "Endorsements" or to conflict in title with
|
||||
any Invariant Section.</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
|
||||
<para>If the Modified Version includes new front-matter sections
|
||||
or appendices that qualify as Secondary Sections and contain no
|
||||
material copied from the Document, you may at your option
|
||||
designate some or all of these sections as invariant. To do this,
|
||||
add their titles to the list of Invariant Sections in the Modified
|
||||
Version's license notice. These titles must be distinct from any
|
||||
other section titles.</para>
|
||||
|
||||
<para>You may add a section entitled "Endorsements", provided it
|
||||
contains nothing but endorsements of your Modified Version by
|
||||
various parties--for example, statements of peer review or that
|
||||
the text has been approved by an organization as the authoritative
|
||||
definition of a standard.</para>
|
||||
|
||||
<para>You may add a passage of up to five words as a Front-Cover
|
||||
Text, and a passage of up to 25 words as a Back-Cover Text, to the
|
||||
end of the list of Cover Texts in the Modified Version. Only one
|
||||
passage of Front-Cover Text and one of Back-Cover Text may be
|
||||
added by (or through arrangements made by) any one entity. If the
|
||||
Document already includes a cover text for the same cover,
|
||||
previously added by you or by arrangement made by the same entity
|
||||
you are acting on behalf of, you may not add another; but you may
|
||||
replace the old one, on explicit permission from the previous
|
||||
publisher that added the old one.</para>
|
||||
|
||||
<para>The author(s) and publisher(s) of the Document do not by
|
||||
this License give permission to use their names for publicity for
|
||||
or to assert or imply endorsement of any Modified Version.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-5">
|
||||
<title>COMBINING DOCUMENTS</title>
|
||||
|
||||
<para>You may combine the Document with other documents released
|
||||
under this License, under the terms defined in section 4 above for
|
||||
modified versions, provided that you include in the combination
|
||||
all of the Invariant Sections of all of the original documents,
|
||||
unmodified, and list them all as Invariant Sections of your
|
||||
combined work in its license notice.</para>
|
||||
|
||||
<para>The combined work need only contain one copy of this
|
||||
License, and multiple identical Invariant Sections may be replaced
|
||||
with a single copy. If there are multiple Invariant Sections with
|
||||
the same name but different contents, make the title of each such
|
||||
section unique by adding at the end of it, in parentheses, the
|
||||
name of the original author or publisher of that section if known,
|
||||
or else a unique number. Make the same adjustment to the section
|
||||
titles in the list of Invariant Sections in the license notice of
|
||||
the combined work.</para>
|
||||
|
||||
<para>In the combination, you must combine any sections entitled
|
||||
"History" in the various original documents, forming one section
|
||||
entitled "History"; likewise combine any sections entitled
|
||||
"Acknowledgements", and any sections entitled "Dedications". You
|
||||
must delete all sections entitled "Endorsements."</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-6">
|
||||
<title>COLLECTIONS OF DOCUMENTS</title>
|
||||
|
||||
<para>You may make a collection consisting of the Document and
|
||||
other documents released under this License, and replace the
|
||||
individual copies of this License in the various documents with a
|
||||
single copy that is included in the collection, provided that you
|
||||
follow the rules of this License for verbatim copying of each of
|
||||
the documents in all other respects.</para>
|
||||
|
||||
<para>You may extract a single document from such a collection,
|
||||
and distribute it individually under this License, provided you
|
||||
insert a copy of this License into the extracted document, and
|
||||
follow this License in all other respects regarding verbatim
|
||||
copying of that document.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-7">
|
||||
<title>AGGREGATION WITH INDEPENDENT WORKS</title>
|
||||
|
||||
<para>A compilation of the Document or its derivatives with other
|
||||
separate and independent documents or works, in or on a volume of
|
||||
a storage or distribution medium, does not as a whole count as a
|
||||
Modified Version of the Document, provided no compilation
|
||||
copyright is claimed for the compilation. Such a compilation is
|
||||
called an "aggregate", and this License does not apply to the
|
||||
other self-contained works thus compiled with the Document, on
|
||||
account of their being thus compiled, if they are not themselves
|
||||
derivative works of the Document.</para>
|
||||
|
||||
<para>If the Cover Text requirement of section 3 is applicable to
|
||||
these copies of the Document, then if the Document is less than
|
||||
one quarter of the entire aggregate, the Document's Cover Texts
|
||||
may be placed on covers that surround only the Document within the
|
||||
aggregate. Otherwise they must appear on covers around the whole
|
||||
aggregate.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-8">
|
||||
<title>TRANSLATION</title>
|
||||
|
||||
<para>Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section
|
||||
4. Replacing Invariant Sections with translations requires
|
||||
special permission from their copyright holders, but you may
|
||||
include translations of some or all Invariant Sections in addition
|
||||
to the original versions of these Invariant Sections. You may
|
||||
include a translation of this License provided that you also
|
||||
include the original English version of this License. In case of
|
||||
a disagreement between the translation and the original English
|
||||
version of this License, the original English version will
|
||||
prevail.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-9">
|
||||
<title>TERMINATION</title>
|
||||
|
||||
<para>You may not copy, modify, sublicense, or distribute the
|
||||
Document except as expressly provided for under this License. Any
|
||||
other attempt to copy, modify, sublicense or distribute the
|
||||
Document is void, and will automatically terminate your rights
|
||||
under this License. However, parties who have received copies, or
|
||||
rights, from you under this License will not have their licenses
|
||||
terminated so long as such parties remain in full
|
||||
compliance.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-10">
|
||||
<title>FUTURE REVISIONS OF THIS LICENSE</title>
|
||||
|
||||
<para>The Free Software Foundation may publish new, revised
|
||||
versions of the GNU Free Documentation License from time to time.
|
||||
Such new versions will be similar in spirit to the present
|
||||
version, but may differ in detail to address new problems or
|
||||
concerns. See <ulink
|
||||
url="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</ulink>.</para>
|
||||
|
||||
<para>Each version of the License is given a distinguishing
|
||||
version number. If the Document specifies that a particular
|
||||
numbered version of this License "or any later version" applies to
|
||||
it, you have the option of following the terms and conditions
|
||||
either of that specified version or of any later version that has
|
||||
been published (not as a draft) by the Free Software Foundation.
|
||||
If the Document does not specify a version number of this License,
|
||||
you may choose any version ever published (not as a draft) by the
|
||||
Free Software Foundation.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="gfdl-11">
|
||||
<title>How to use this License for your documents</title>
|
||||
|
||||
<para>To use this License in a document you have written, include
|
||||
a copy of the License in the document and put the following
|
||||
copyright and license notices just after the title page:</para>
|
||||
|
||||
<blockquote><para>
|
||||
Copyright (c) YEAR YOUR NAME.
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.1
|
||||
or any later version published by the Free Software Foundation;
|
||||
with the Invariant Sections being LIST THEIR TITLES, with the
|
||||
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
|
||||
A copy of the license is included in the section entitled "GNU
|
||||
Free Documentation License".
|
||||
</para></blockquote>
|
||||
|
||||
<para>If you have no Invariant Sections, write "with no Invariant
|
||||
Sections" instead of saying which ones are invariant. If you have
|
||||
no Front-Cover Texts, write "no Front-Cover Texts" instead of
|
||||
"Front-Cover Texts being LIST"; likewise for Back-Cover
|
||||
Texts.</para>
|
||||
|
||||
<para>If your document contains nontrivial examples of program
|
||||
code, we recommend releasing these examples in parallel under your
|
||||
choice of free software license, such as the GNU General Public
|
||||
License, to permit their use in free software.</para>
|
||||
</sect1>
|
||||
</appendix>
|
||||
|
||||
<!-- Uncomment the following line if you are using an external file for
|
||||
your glossary. You may also paste the contents of that file into the
|
||||
template at this point if you prefer having a single, longer file. -->
|
||||
<!-- &glossary; -->
|
||||
|
||||
<!-- Uncomment the following line if you are using an external file for
|
||||
your bibliography. You may also paste the contents of that file into the
|
||||
template at this point if you prefer having a single, longer file. -->
|
||||
<!-- &bibliography; -->
|
||||
|
||||
</article>
|
||||
Binary file not shown.
Binary file not shown.
Loading…
Reference in New Issue