LDP
/
LDP
mirror of https://github.com/tLDP/LDP
0
1
Fork 0
Code Releases Activity

XML now accepted. revision updated to 3.1

This commit is contained in:
markk 2000-10-10 15:40:03 +00:00
parent 01dc0d2c74
commit aba4025dce
1 changed files with 65 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
LDP/guide/docbook/LDP-Author-Guide/LDP-Author-Guide.sgml
View File

@ -28,7 +28,7 @@
<book>
<bookinfo>
<title>LDP Author Guide</title>
<pubdate>v3.0 24 Aug, 2000</pubdate>
<pubdate>v3.1 10 Oct, 2000</pubdate>
<author>
<firstname>Mark</firstname>
<othername>F.</othername>
@ -61,6 +61,15 @@
up to speed and writing. </para>
</abstract>
<revhistory>
<revision>
<revnumber>3.1</revnumber>
<date>Oct 10, 2000</date>
<authorinitials>mfk</authorinitials>
<revremark>Spelling changes, changed list of LDP policies to now
accept DocBook XML. More information about how to use *jade
with XML will follow.
</revremark>
</revision>
<revision>
<revnumber>3.0</revnumber>
<date>Aug 24, 2000</date>
@ -105,11 +114,12 @@
F. Komarinski after two day's worth of frustration getting tools
to work. If even one LDP author is helped by this, then I did my
job.</para>
<para>The newest version of this can be found on my homepage <ulink
url="http://www.cgipc.com/~markk">http://www.cgipc.com/~markk</ulink>
in its SGML source. Other versions may be found in different
formats at the LDP homepage <ulink
url="http://www.linuxdoc.org/">http://www.linuxdoc.org</ulink>.</para>
<para>
The newest version of this document can be found at the LDP
homepage
<ulink url="http://www.linuxdoc.org/">http://www.linuxdoc.org</ulink>.
The original DocBook SGML, HTML, and other formats can be found there.
</para>
<para>There are many ways to contribute to the Linux movement
without actually writing code. One of the most important is
writing documentation, allowing each person to share their
@ -271,10 +281,35 @@
<para>There has been a lot of press recently about XML, and DocBook
support for XML. DocBook is a collection of markup tags that follow
a specified hierarchy.
XML tools for authors are not quite as far advanced
as their SGML counterparts, so the LDP is refraining from using XML
markups. At this time, only SGML is accepted by the LDP.
XML DocBook v4.1.2 is now officially supported by the LDP. If you're
familiar with SGML and want to convert to XML, please keep the following
in mind (list borrowed from DocBook: The Definitive Guide):
</para>
<itemizedlist>
<listitem>
<para>All XML markup is case sensitive. All element, attribute,
and entity names have to be in lowercase. SGML is not case
sensitive.
</para>
</listitem>
<listitem>
<para>
All attributes have to be quotes using either straight (') or
double (") quotes.
</para>
</listitem>
<listitem>
<para>
Empty elements (like xref) have to end with a /: &lt;xref/&gt;.
</para>
</listitem>
<listitem>
<para>
Tag minimizations (&lt;/&gt;) are not supported. The LDP
discourages their use in SGML as well.
</para>
</listitem>
</itemizedlist>
</section>
<section id="newauthors">
@ -1016,12 +1051,28 @@ $_toolroot/dsssl/docbook/catalog:$_toolroot/jade-1.2.1/dsssl/catalog</command>
slightly better pictures than <filename>.jpg</filename>. </para>
</section>
<section id="acceptedversion">
<section id="acceptedversions">
<title>DocBook Versions</title>
<para>DocBook versions 4.1, 4.0 and 3.1 are supported by the
LDP at this time. DocBook XML is under consideration. Many
Many 3.1 documents can be converted to 4.1 easily by avoiding
the use of depreciated tags.</para>
<para>
The LDP supports and accepts documentation in the following formats:
</para>
<itemizedlist>
<listitem>
<para>
SGML DocBook versions 4.x and 3.1
</para>
</listitem>
<listitem>
<para>
SGML LinuxDoc
</para>
</listitem>
<listitem>
<para>
XML DocBook version 4.1.2
</para>
</listitem>
</itemizedlist>
<para>When writing your DocBook header, it should look like
this:</para>
<programlisting format="linespecific">