850 lines
14 KiB
HTML
850 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<HTML
|
|
><HEAD
|
|
><TITLE
|
|
>Glossary</TITLE
|
|
><META
|
|
NAME="GENERATOR"
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
|
|
REL="HOME"
|
|
TITLE="LDP Author Guide"
|
|
HREF="index.html"><LINK
|
|
REL="PREVIOUS"
|
|
TITLE="DocBook to DocBook Transformations"
|
|
HREF="docbook2docbook.html"><LINK
|
|
REL="NEXT"
|
|
TITLE="GNU Free Documentation License"
|
|
HREF="fdl.html"></HEAD
|
|
><BODY
|
|
CLASS="glossary"
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#840084"
|
|
ALINK="#0000FF"
|
|
><DIV
|
|
CLASS="NAVHEADER"
|
|
><TABLE
|
|
SUMMARY="Header navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TH
|
|
COLSPAN="3"
|
|
ALIGN="center"
|
|
>LDP Author Guide</TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="left"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="docbook2docbook.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="80%"
|
|
ALIGN="center"
|
|
VALIGN="bottom"
|
|
></TD
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="right"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="fdl.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"></DIV
|
|
><DIV
|
|
CLASS="GLOSSARY"
|
|
><H1
|
|
><A
|
|
NAME="glossary"
|
|
></A
|
|
>Glossary</H1
|
|
><DL
|
|
><DT
|
|
><B
|
|
>Abiword</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Open Source word processor.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>aspell</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Spell check program.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>attribute</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An attribute makes available extra information regarding the
|
|
element on which it appears. The attributes always appear as a
|
|
name-value pair on the initialization pointers
|
|
(i.e. the <SPAN
|
|
CLASS="QUOTE"
|
|
>"start tag"</SPAN
|
|
>). Example of an
|
|
attribute is <TT
|
|
CLASS="parameter"
|
|
><I
|
|
>id="identification"</I
|
|
></TT
|
|
>, which gives the
|
|
attribute <TT
|
|
CLASS="parameter"
|
|
><I
|
|
>id</I
|
|
></TT
|
|
> the value
|
|
<TT
|
|
CLASS="parameter"
|
|
><I
|
|
>identification</I
|
|
></TT
|
|
>.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Cascading Style Sheet
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>CSS</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Set of overlay rules that are read by your HTML browser, which uses these rules for doing the display, layout and formatting of the XML-generated HTML file(s). <SPAN
|
|
CLASS="acronym"
|
|
>CSS</SPAN
|
|
> allows for fast changes in look and feel without having to plunge in the HTML file(s).
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Catalog</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Helper file for the display and transformation tools, which
|
|
maps public identifiers and URLs to the local file system.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Concurrent Versions System
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>CVS</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>A common document management system used by the LDP.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>DocBook</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An SGML (and XML) application, describing a document format
|
|
that allows easy management of documentation.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>docbook-utils</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Software package easing XML conversions.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Document Type Definition
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>DTD</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>A group of statements that define element names and their attributes
|
|
specifying the rules for combinations and sequences. It's the
|
|
<SPAN
|
|
CLASS="acronym"
|
|
>DTD</SPAN
|
|
> that defines which elements can or cannot
|
|
be inserted in the given context.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
><SPAN
|
|
CLASS="acronym"
|
|
>DSSSL</SPAN
|
|
></B
|
|
></DT
|
|
><DD
|
|
><P
|
|
><SPAN
|
|
CLASS="acronym"
|
|
>DSSSL</SPAN
|
|
> stands for Document Style Semantics and
|
|
Specification Language. It's an <SPAN
|
|
CLASS="acronym"
|
|
>ISO</SPAN
|
|
> standard
|
|
(ISO/IEC 10179:1996). The <SPAN
|
|
CLASS="acronym"
|
|
>DSSSL</SPAN
|
|
> standard is
|
|
internationally used as a language for documents style sheets pages for
|
|
<SPAN
|
|
CLASS="acronym"
|
|
>SGML</SPAN
|
|
>.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>element</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
> The elements describe the content's structure in a document.
|
|
Most elements contain a start tag, content and a closing tag. For
|
|
example a paragraph element includes all of the following <TT
|
|
CLASS="sgmltag"
|
|
><para></TT
|
|
>This is the paragraph.<TT
|
|
CLASS="sgmltag"
|
|
></para></TT
|
|
>. Some elements are <SPAN
|
|
CLASS="QUOTE"
|
|
>"empty"</SPAN
|
|
> and do not
|
|
contain content and a closing tag. An example of this is a link to
|
|
an external document where the URL is printed to the page. This
|
|
element would include only the following <TT
|
|
CLASS="sgmltag"
|
|
><ulink url="http://google.com/></TT
|
|
>.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Emacs</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Popular text editor, especially on UNIX systems or alikes.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>entity</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An entity is a name designated for some part of data so that it
|
|
can be referenced by a name. The data could be anything from
|
|
from simple characters to chapters to sets
|
|
of statements in a <SPAN
|
|
CLASS="acronym"
|
|
>DTD</SPAN
|
|
>.
|
|
Entity parameters can be generic, external, internal or
|
|
<SPAN
|
|
CLASS="acronym"
|
|
>SGML</SPAN
|
|
> data. An entity is similar to a variable
|
|
in a programming language, or a macro.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>epcEdit</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Cross-platform XML editor.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>external entity</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An external entity points to an external document. External entities
|
|
are used to include texts on certain locations of a
|
|
<SPAN
|
|
CLASS="acronym"
|
|
>SGML</SPAN
|
|
> document. It could be used to include
|
|
sample screens, legal notes, and chapters for example.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>float</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Objects such as side bars, pictures, tables, and charts are called floats when they don't have a fixed placement on the text. For
|
|
printed text, a chart can appear either at the top or at the
|
|
bottom of the page. It can also be placed on the next page if it is
|
|
too large.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Frequently Asked Questions
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>FAQ</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>LDP hosts a number of documents that are a list in the form of
|
|
questions and answers. These documents are called FAQs. A FAQ is usually a single-page document.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>generic entities</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An entity referenced by a name, which starts with
|
|
<SPAN
|
|
CLASS="QUOTE"
|
|
>"&"</SPAN
|
|
> and ends with semicolon is a generic
|
|
entity. Most of the time this type of entity is used in the
|
|
document and not on the <SPAN
|
|
CLASS="acronym"
|
|
>DTD</SPAN
|
|
>. There are two types
|
|
of entities: external and internal. They can refer to special
|
|
characters or to text objects such as repeated sentences, names or
|
|
chapters.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>GNU Free Documentation License
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>GFDL</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Like the GNU Public License for free software, but with specifics for written text and documentation with software.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>GNU Public License
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>GPL</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>License type for software that guarantees that the software remains freely distributable, that the source code is available, that you can make changes to it and redistribute those changes if you want, on the condition that you keep on using the same license for your derived works.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Guide</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>TLDP documents that are too long to be a HOWTO are usually stored
|
|
as guides. These are more like entire books that treat a particular
|
|
subject in-dept.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>HOWTO</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Documents that discuss how to do something with a system or
|
|
application. Most documents hosted at TLDP are HOWTOs,
|
|
explaining how to install, configure or manage tens of applications
|
|
on a variety of systems. HOWTOs are typically 10-25 pages.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>internal entity</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An internal entity refers to part of the text and is often used
|
|
as a shortcut for frequently repeated text.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>ispell</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Spell check program.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Jade</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An application which applies the rules defined in a DSSSL
|
|
style sheet to an SGML or XML document, transforming the document
|
|
into the desired output.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Markup, markup language
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>ML</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Code added to the content of a document, describing its structure.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Metadata</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Text in your document that is not important for understanding the subject, but that should be there anyway, such as version information, co-authors, credits to people etc.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>nedit</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Text editor oriented to programmers.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>nsgmls, onsgmls</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>SGML document parser and validator program.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>OpenOffice
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>OOo</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Open Source office suite, compatible with Microsoft Office.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>parameter entity</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An entity type often used in the <SPAN
|
|
CLASS="acronym"
|
|
>DTD</SPAN
|
|
> or a
|
|
document's internal subset. The entity's
|
|
name starts with a percent sign (%) and ends with a
|
|
semicolon.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>PSGML</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Emacs <EM
|
|
>major mode</EM
|
|
> that customizes Emacs for editing SGML documents.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Organization for the Advancement of Structured Information Standards
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>OASIS</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>OASIS is a non-profit, global consortium that drives the development, convergence and adoption of e-business standards.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Outline</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Draft of your document that conceptualizes the subject and scope. Summary and To-Do list for the work to come.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Portable Document Format
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>PDF</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Standard document type supported on a wide range of operating systems.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>processing instruction</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>A processing instruction is a command passed to the document
|
|
formatting tool. It starts with <SPAN
|
|
CLASS="QUOTE"
|
|
>"<?"</SPAN
|
|
>. This document
|
|
uses processing instructions for naming files when it
|
|
is rendered into
|
|
<SPAN
|
|
CLASS="acronym"
|
|
>HTML</SPAN
|
|
>: <TT
|
|
CLASS="sgmltag"
|
|
><?dbhtml
|
|
filename="file.html"></TT
|
|
></P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>PostScript
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>PS</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Document format designed for printable documents. PS is the standard print format on UNIX(-alikes).
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Reviewer, review process</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>TLDP doesn't accept just anything. Once you submit a document, it will be checked for consistency, grammar, spelling and style by a reviewer, a volunteer assigned by the review coordinator.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
><SPAN
|
|
CLASS="acronym"
|
|
>SGML</SPAN
|
|
></B
|
|
></DT
|
|
><DD
|
|
><P
|
|
><I
|
|
CLASS="foreignphrase"
|
|
>Standard Generalized Markup
|
|
Language</I
|
|
>.
|
|
It is an international standard (<SPAN
|
|
CLASS="acronym"
|
|
>ISO</SPAN
|
|
>8879) that
|
|
specifies rules for the creation of electronic documents in markup
|
|
systems, regardless of the platform used.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Subject and scope</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Obviously, the subject is what your documentation is about. The scope defines which areas of the subject you are going to discuss, and how much detail will be involved.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>tag</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>An <SPAN
|
|
CLASS="acronym"
|
|
>SGML</SPAN
|
|
> element bounded by the marks
|
|
<SPAN
|
|
CLASS="QUOTE"
|
|
>"<"</SPAN
|
|
> and <SPAN
|
|
CLASS="QUOTE"
|
|
>">"</SPAN
|
|
>. Tags are used
|
|
to mark the semantic or logical structure of a document. A sample
|
|
is the tag <EM
|
|
><TT
|
|
CLASS="sgmltag"
|
|
><title></TT
|
|
></EM
|
|
> to mark the beginning
|
|
of a title.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>TeX</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Popular UNIX text formatting and typesetting tool.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Transformation</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>The process of converting a document from its original DocBook XML form to another format, such as PDF, HTML or PostScript.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Validation</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>The process of checking your XML code to ensure it complies
|
|
with the XML DTD you declared at the top of your document.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>vi Improved
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>vIm</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Popular text editor on UNIX and alike systems.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>WordPerfect
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>WP</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Popular word processor, runs on many systems.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
><SPAN
|
|
CLASS="acronym"
|
|
>XML</SPAN
|
|
></B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>eXtensible Markup Language. A sub-product of <SPAN
|
|
CLASS="acronym"
|
|
>SGML</SPAN
|
|
>
|
|
created specifically for Internet use.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>xmllint</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Command line XML parser and validator.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>XMLmind XML Editor
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>XXE</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Free but not Open XML editor.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>xmlto</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Command line XML transformation program.
|
|
</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
><SPAN
|
|
CLASS="acronym"
|
|
>XSL</SPAN
|
|
></B
|
|
></DT
|
|
><DD
|
|
><P
|
|
><SPAN
|
|
CLASS="acronym"
|
|
>XML</SPAN
|
|
> Style
|
|
Language. XSL is to a <SPAN
|
|
CLASS="acronym"
|
|
>XML</SPAN
|
|
> document what a
|
|
<SPAN
|
|
CLASS="acronym"
|
|
>DSSSL</SPAN
|
|
> style is for a <SPAN
|
|
CLASS="acronym"
|
|
>SGML</SPAN
|
|
>
|
|
document. The XSL is written in
|
|
<SPAN
|
|
CLASS="acronym"
|
|
>XML</SPAN
|
|
>.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Extensible Stylesheet Transformation
|
|
(<SPAN
|
|
CLASS="acronym"
|
|
>XSLT</SPAN
|
|
>)</B
|
|
></DT
|
|
><DD
|
|
><P
|
|
>Framework for managing documents, consisting of the XSLT transformation language, the XPath expression language and XSL formatting objects.
|
|
</P
|
|
></DD
|
|
></DL
|
|
></DIV
|
|
><DIV
|
|
CLASS="NAVFOOTER"
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"><TABLE
|
|
SUMMARY="Footer navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="docbook2docbook.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="index.html"
|
|
ACCESSKEY="H"
|
|
>Home</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="fdl.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
>DocBook to DocBook Transformations</TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
> </TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
>GNU Free Documentation License</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></BODY
|
|
></HTML
|
|
> |