mirror of https://github.com/tLDP/LDP
fixed FIXME's, still doubting about this thing you have with upper case tags...
This commit is contained in:
tille
parent
e09a9ed163
commit
3101703151
|
|
@ -8,11 +8,11 @@
|
|||
way of embedding information about a document
|
||||
into the text of the document. SGML is not a markup language
|
||||
itself, it is a <quote>metalanguage</quote> from which other markup
|
||||
languages are created (e.g. HTML and DocBook). Documents are stored
|
||||
in SGML format using a specific Document Type Definition--a
|
||||
languages are created (for instance HTML and DocBook). Documents are stored
|
||||
in SGML format using a specific Document Type Definition or DTD, a
|
||||
controlled vocabulary. These documents may then be
|
||||
<quote>transformed</quote> into a variety of other types of documents
|
||||
such as PDFs, HTML pages, plain text (etc!). The advantage of using
|
||||
such as PDFs, HTML pages, plain text, etc. The advantage of using
|
||||
SGML means you can use an automated transformation to convert your
|
||||
document into whatever format you may need.</para>
|
||||
|
||||
|
|
@ -24,11 +24,11 @@
|
|||
of text, for example, is a paragraph. In DocBook notation I have
|
||||
wrapped the block of text with the start tag <para> and then
|
||||
the end tag </para>. In HTML, a sub-set of SGML, this would be
|
||||
done with the element <p>. Although there are many similarities
|
||||
done with the elements <p> and </p>. Although there are many similarities
|
||||
between DocBook and HTML, DocBook contains hundreds of elements and
|
||||
is considered a much more descriptive vocabulary.</para>
|
||||
|
||||
<note><para>Steve
|
||||
<note><title>Example</title><para>Steve
|
||||
Champeon does a great job of explaining this (from an HTML
|
||||
perspective but with an example of DocBook markup) in his article
|
||||
<ulink url="http://hotwired.lycos.com/webmonkey/02/42/index4a.html">The
|
||||
|
|
@ -40,14 +40,14 @@
|
|||
First there is the content. As a TLDP author it is good to remember
|
||||
that this is the most important piece. Many authors will write the
|
||||
content first and add their markup later. Content may include both
|
||||
plain text and graphics. For more information about writing your
|
||||
content read: FIXME
|
||||
plain text and graphics. See <xref linkend="write" /> for more information about writing your
|
||||
content.
|
||||
</para></listitem>
|
||||
|
||||
<listitem><para>
|
||||
To describe the structure of the content a controlled vocabulary
|
||||
To describe the structure of the content a controlled vocabulary is
|
||||
added on top of the content. It is used to distinguish different
|
||||
kinds of content: paragraphs, lists, tables, warnings (and so on).
|
||||
kinds of content: paragraphs, lists, tables, warnings and so on.
|
||||
This is also known as document <quote>markup</quote> and is typically
|
||||
what people are referring to when they talk about SGML, XML and HTML.
|
||||
</para>
|
||||
|
|
@ -61,21 +61,21 @@
|
|||
This document was written in
|
||||
DocBook version 4.2 (although that version will likely change over
|
||||
time).
|
||||
For more information about marking up your document read: FIXME
|
||||
For more information about marking up your document read <xref linkend="markup" />.
|
||||
</para></listitem>
|
||||
|
||||
<listitem><para>
|
||||
Finally the document is formatted for displayed. This is
|
||||
Finally the document is formatted for display, be it digitally or on paper. This conversion is
|
||||
controlled through the Document Style Semantics and Specification
|
||||
Language (DSSSL).
|
||||
The DSSSL tells the program doing the rendering how to convert
|
||||
the SGML into something that a human can read. It tells the
|
||||
the SGML into something humanly readable. It tells the
|
||||
renderer to convert a <sgmltag>title</sgmltag> tag into 14 point
|
||||
bold if it
|
||||
is going to RTF format, or to turn it into a <h1> tag if
|
||||
is going to RTF format, or to turn it into an <h1> tag if
|
||||
it is going to HTML.
|
||||
For more information about transforming your document to other
|
||||
document formats read: FIXME
|
||||
document formats read <xref linkend="transformations" />.
|
||||
</para></listitem>
|
||||
</itemizedlist>
|
||||
|
||||
|
|
@ -86,7 +86,7 @@
|
|||
documents must point to a DTD for the rules about a document's
|
||||
structure. DocBook is a DTD which is available in both SGML and XML
|
||||
formats. Although the element names do not change between the two
|
||||
there are slight differences between the two. The LDP has chosen
|
||||
there are slight differences. The LDP has chosen
|
||||
to store its documents in XML format using the DocBook DTD. (Other
|
||||
markup languages are accepted--this is covered later in the
|
||||
document.)
|
||||
|
|
@ -97,9 +97,9 @@
|
|||
<title>Why DocBook instead of HTML or other formats?</title>
|
||||
<para>DocBook provides for more than just formatting. You can
|
||||
automatically build indexes, tables of contents, and links within
|
||||
the document or to outside. The Jade and OpenJade packages also
|
||||
the document or to outside references. The Jade and OpenJade packages also
|
||||
let you transform DocBook to LaTeX,
|
||||
info, text, HTML, and RTF. From these basic formats, you can
|
||||
info, text, HTML, and RTF. From these basic formats you can
|
||||
then create other formats such as MS Word, PostScript, PDF and
|
||||
so on. Programs like LyX allow you to write in TeX format, then
|
||||
export it as DocBook SGML and transform from SGML to whatever you
|
||||
|
|
@ -117,30 +117,14 @@
|
|||
DocBook are far more developed than others. DocBook support is
|
||||
included in most Linux distributions, allowing you to send raw
|
||||
files to be processed at the receiver's end. And finally,
|
||||
while DocBook has an extensive set of tags (over 300 in all), a
|
||||
majority of them do not need to be used for simple
|
||||
while DocBook has an extensive set of tags (over 300 in all), the
|
||||
majority does not need to be used for simple
|
||||
documentation. Starting with one of the available templates
|
||||
will allow you to quickly start writing DocBook with minimal
|
||||
experience. To get started using an LDP template read
|
||||
<xref linkend="templates"/></para>
|
||||
</section>
|
||||
|
||||
LINKS OF INTEREST:
|
||||
The Secret Life of Markup
|
||||
http://hotwired.lycos.com/webmonkey/02/42/index4a.html
|
||||
|
||||
XML Matters: Getting started with the DocBook XML dialect
|
||||
http://www-106.ibm.com/developerworks/xml/library/xml-matters3.html
|
||||
|
||||
FAQ for DocBook markup
|
||||
http://www.dpawson.co.uk/docbook/markup.html
|
||||
|
||||
Where we are now. Part of "Progressive Enhancement and the Future of Web Design".
|
||||
http://hotwired.lycos.com/webmonkey/03/21/index3a_page2.html
|
||||
|
||||
SGML
|
||||
http://www.w3.org/MarkUp/SGML/
|
||||
|
||||
<section id="docbookxml">
|
||||
<title>Writing in DocBook XML</title>
|
||||
<para>
|
||||
|
|
@ -222,6 +206,7 @@
|
|||
<para>
|
||||
The above being said, most XML-specific tags (like entity)
|
||||
have to be in all capital letters (ENTITY).
|
||||
<!--I still have this aching feeling that tags should be in lower cases for XML. Look at this entire doc?!? -->
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue