cvs commit: ALFS/docs/syntax_doc/alfs_dtd xml_dtd-syntax.xml

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Fri Apr 2 19:10:34 PST 2004


jwrober     04/04/02 20:10:34

  Modified:    docs/syntax_doc/alfs_dtd xml_dtd-syntax.xml
  Log:
  formatting to fit conventions
  
  Revision  Changes    Path
  1.6       +113 -100  ALFS/docs/syntax_doc/alfs_dtd/xml_dtd-syntax.xml
  
  Index: xml_dtd-syntax.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/xml_dtd-syntax.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- xml_dtd-syntax.xml	31 Mar 2004 01:53:55 -0000	1.5
  +++ xml_dtd-syntax.xml	3 Apr 2004 03:10:34 -0000	1.6
  @@ -5,7 +5,7 @@
   <sect2>
   <title>Quick Introduction to XML Syntax</title>
   
  -<para>To ensure that all readers of the &book-product; get as much as
  +<para>To ensure that all readers of the &book-product; Book get as much as
   possible from its contents, it is necessary to provide a quick introduction
   to the concepts of <acronym>XML</acronym> and <acronym>DTD</acronym>
   syntax.</para>
  @@ -65,7 +65,7 @@
   <acronym>XML</acronym> document as tag pairs. Attributes provide a
   mechanism to further define or classify an element. Elements have
   relationships with other elements in a document. Some are parents and some
  -are children. Using this symantic description, one can see that children
  +are children. Using this semantic description, one can see that children
   elements need parent elements defined and used first. As mentioned in the
   last section, an <acronym>XML</acronym> document must have a root element.
   Think of this as the ultimate parent element. The root element must be
  @@ -108,27 +108,30 @@
   
   <itemizedlist>
   
  -<listitem><para>Element declarations and definitions : Elements
  -are declared and defined with their relationships in the
  -<acronym>DTD</acronym> file.</para></listitem>
  -
  -<listitem><para>Attribute declarations and definitions : Element
  -classes or attributes are declared and defined in the
  -<acronym>DTD</acronym> file.</para></listitem>
  -
  -<listitem><para>Entities : Entities are the same thing as
  -variables inside a <acronym>DTD</acronym> file or <acronym>XML</acronym>
  -document. They can hold any kind of data.</para></listitem>
  -
  -<listitem><para><filename>PCDATA</filename> : <filename>PCDATA</filename>
  -is Parsed Character DATA. <filename>PCDATA</filename> is
  -text that will be parsed by a parser. Tags inside the text will be treated
  -as markup and entities will be expanded.</para></listitem>
  -
  -<listitem><para><filename>CDATA</filename> : <filename>CDATA</filename>
  -is Character DATA. <filename>CDATA</filename> is text
  -that will NOT be parsed by a parser. Tags inside the text will NOT be
  -treated as markup and entities will not be expanded.</para></listitem>
  +<listitem><para><emphasis role="bold">Element declarations and
  +definitions</emphasis> : Elements are declared and defined with
  +their relationships in the <acronym>DTD</acronym> file.</para></listitem>
  +
  +<listitem><para><emphasis role="bold">Attribute declarations and
  +definitions</emphasis> : Element classes or attributes are
  +declared and defined in the <acronym>DTD</acronym> file.</para></listitem>
  +
  +<listitem><para><emphasis role="bold">Entities</emphasis>
  + :  Entities are the same thing as variables inside a
  +<acronym>DTD</acronym> file or <acronym>XML</acronym> document. They can
  +hold any kind of data.</para></listitem>
  +
  +<listitem><para><emphasis role="bold"><filename>PCDATA</filename></emphasis>
  + : <filename>PCDATA</filename> is Parsed Character DATA.
  +<filename>PCDATA</filename> is text that will be parsed by a parser. Tags
  +inside the text will be treated as markup and entities will be
  +expanded.</para></listitem>
  +
  +<listitem><para><emphasis role="bold"><filename>CDATA</filename></emphasis>
  + : <filename>CDATA</filename> is Character DATA.
  +<filename>CDATA</filename> is text that will NOT be parsed by a parser.
  +Tags inside the text will NOT be treated as markup and entities will not be
  +expanded.</para></listitem>
   
   </itemizedlist>
   
  @@ -143,28 +146,31 @@
   
   <itemizedlist>
   
  -<listitem><para><filename>EMPTY</filename> : When an element is
  -declared with the <filename>EMPTY</filename> keyword, it means that the
  -element will not hold any information.  This is generally used for special
  -tags like <br>.</para></listitem>
  -
  -<listitem><para><filename>ANY</filename> : When an element is
  -declared with the <filename>ANY</filename> keyword, it means that the
  -element can contain any information that the author wants it to. This
  -is generally a special case.</para></listitem>
  -
  -<listitem><para>Character Data : When an element is declared with
  -either the <filename>PCDATA</filename> or <filename>CDATA</filename>
  -keywords, it will hold one of the two types of information described
  -above.</para></listitem>
  -
  -<listitem><para>With Children : When an element is declared with
  -the names of other elements in it, this defines a parent-child
  -relationship. Look in the <acronym>DTD</acronym> for the child element
  -names to be further defined with the other three ways.</para></listitem>
  -
  -<listitem><para>Mixed : Some combination of the above four.
  -Generally this is character data mixed with children.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>EMPTY</filename></emphasis>
  + : When an element is declared with the
  +<filename>EMPTY</filename> keyword, it means that the element will not hold
  +any information.  This is generally used for special tags like
  +<br>.</para></listitem>
  +
  +<listitem><para><emphasis role="bold"><filename>ANY</filename></emphasis>
  + : When an element is declared with the <filename>ANY</filename>
  +keyword, it means that the element can contain any information that the
  +author wants it to. This is generally a special case.</para></listitem>
  +
  +<listitem><para><emphasis role="bold">Character Data</emphasis>
  + : When an element is declared with either the
  +<filename>PCDATA</filename> or <filename>CDATA</filename> keywords, it will
  +hold one of the two types of information described above.</para></listitem>
  +
  +<listitem><para><emphasis role="bold">With Children</emphasis>
  + : When an element is declared with the names of other elements
  +in it, this defines a parent-child relationship. Look in the
  +<acronym>DTD</acronym> for the child element names to be further defined
  +with the other three ways.</para></listitem>
  +
  +<listitem><para><emphasis role="bold">Mixed</emphasis>
  + : Some combination of the above four.  Generally this is
  +character data mixed with children.</para></listitem>
   
   </itemizedlist>
   
  @@ -175,36 +181,39 @@
   
   <itemizedlist>
   
  -<listitem><para>One Occurance Only : Example : 
  -<xref linkend="elem_search_replace"/>. The child elements of
  +<listitem><para><emphasis role="bold">One Occurance Only</emphasis>
  + : Example :  <xref linkend="elem_search_replace"/>.
  +The child elements of
   <search_replace> &emdash; <file>, <find>, and
   <replace> can only be used once. Notice that there are no symbols
   after any of the child element names. This is the
   identifier.</para></listitem>
   
  -<listitem><para>Minimum of One Occurance : Example : 
  -<xref linkend="elem_permissions"/>. One of the child elements of
  +<listitem><para><emphasis role="bold">Minimum of One Occurance</emphasis>
  + : Example :  <xref linkend="elem_permissions"/>. One
  +of the child elements of
   <permissions> &emdash; <name>, must be used a minimum
   of once, but can also be used many times. Notice the plus [ + ]
   symbol after the name. This is the identifier.</para></listitem>
   
  -<listitem><para>Zero or More Occurances : Example : 
  -<xref linkend="elem_download"/>. One of the child elements of
  -<download> &emdash; <url>, can be used zero or
  -many times. Notice the asterisk [ * ] symbol after the name.
  -This is the identifier.</para></listitem>
  -
  -<listitem><para>Zero or One Occurance : Example : 
  -<xref linkend="elem_download"/>. One of the child elements of
  -<download> &emdash; <digest>, can be used zero
  -or one time only. Notice the question mark [ ? ] symbol after the name.
  -This is the identifier.</para></listitem>
  -
  -<listitem><para>Either / Or Occurances : Example : 
  -<xref linkend="elem_execute"/>. One of the two child elements of
  -<execute> &emdash; <param>, or <prefix>, can
  -only be used.  Notice the pipe [ | ] symbol in between the two
  -elements. This is the identifier.</para></listitem>
  +<listitem><para><emphasis role="bold">Zero or More Occurances</emphasis>
  + : Example :  <xref linkend="elem_download"/>. One of
  +the child elements of <download> &emdash; <url>, can
  +be used zero or many times. Notice the asterisk [ * ] symbol
  +after the name. This is the identifier.</para></listitem>
  +
  +<listitem><para><emphasis role="bold">Zero or One Occurance</emphasis>
  + : Example :  <xref linkend="elem_download"/>. One of
  +the child elements of <download> &emdash; <digest>,
  +can be used zero or one time only. Notice the question mark [ ? ]
  +symbol after the name. This is the identifier.</para></listitem>
  +
  +<listitem><para><emphasis role="bold">Either / Or Occurances</emphasis>
  + : Example :  <xref linkend="elem_execute"/>. One of
  +the two child elements of <execute> &emdash; <param>,
  +or <prefix>, can only be used. Notice the pipe [ | ]
  +symbol in between the two elements. This is the
  +identifier.</para></listitem>
   
   </itemizedlist>
   
  @@ -219,38 +228,41 @@
   
   <itemizedlist>
   
  -<listitem><para><filename>CDATA</filename> : The
  -value is Character Data.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>CDATA</filename></emphasis>
  + : The value is Character Data.</para></listitem>
   
  -<listitem><para><filename>(en1|en2|...)</filename> : The value is
  -an enumerated list.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>(en1|en2|...)</filename></emphasis>
  + : The value is an enumerated list.</para></listitem>
   
  -<listitem><para><filename>ID</filename> : The value is a unique
  -id.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>ID</filename></emphasis>
  + : The value is a unique id.</para></listitem>
   
  -<listitem><para><filename>IDREF</filename> : The value is the id
  -of another element.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>IDREF</filename></emphasis>
  + : The value is the id of another element.</para></listitem>
   
  -<listitem><para><filename>IDREFS</filename> : The value is a list
  -of other ids,</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>IDREFS</filename></emphasis>
  + : The value is a list of other ids,</para></listitem>
   
  -<listitem><para><filename>NMTOKEN</filename> : The value is a
  -valid <acronym>XML</acronym> name.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>NMTOKEN</filename></emphasis>
  + : The value is a valid <acronym>XML</acronym>
  +name.</para></listitem>
   
  -<listitem><para><filename>NMTOKENS</filename> : The value is a
  -list of valid <acronym>XML</acronym> names.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>NMTOKENS</filename></emphasis>
  + : The value is a list of valid <acronym>XML</acronym>
  +names.</para></listitem>
   
  -<listitem><para><filename>ENTITY</filename> : The value is an
  -entity.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>ENTITY</filename></emphasis>
  + : The value is an entity.</para></listitem>
   
  -<listitem><para><filename>ENTITIES</filename> : The value is a
  -list of entities.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>ENTITIES</filename></emphasis>
  + : The value is a list of entities.</para></listitem>
   
  -<listitem><para><filename>NOTATION</filename> : The value is a
  -name of a notation.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>NOTATION</filename></emphasis>
  + : The value is a name of a notation.</para></listitem>
   
  -<listitem><para><filename>xml</filename> : The value is a
  -predefined <acronym>XML</acronym> value.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>xml</filename></emphasis>
  + : The value is a predefined <acronym>XML</acronym>
  +value.</para></listitem>
   
   </itemizedlist>
   
  @@ -258,21 +270,22 @@
   
   <itemizedlist>
   
  -<listitem><para><filename>Value</filename> : The default value of
  -the attribute surrounded by quotes [ " " ].
  -Example : <xref linkend="elem_alfs"/>.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>Value</filename></emphasis>
  + : The default value of the attribute surrounded by quotes
  +[ " " ]. Example : <xref
  +linkend="elem_alfs"/>.</para></listitem>
   
  -<listitem><para><filename>#IMPLIED</filename> : The attribute is
  -optional. Example : 
  +<listitem><para><emphasis role="bold"><filename>#IMPLIED</filename></emphasis>
  + : The attribute is optional. Example : 
   <xref linkend="elem_alfs"/>.</para></listitem>
   
  -<listitem><para><filename>#REQUIRED</filename> : The attribute is
  -required when the element is used. Example : 
  -<xref linkend="elem_execute"/>.</para></listitem>
  -
  -<listitem><para><filename>#FIXED</filename> : A fixed value. Used
  -with the <filename>Value</filename> option. Example : 
  -<xref linkend="elem_alfs"/>.</para></listitem>
  +<listitem><para><emphasis role="bold"><filename>#REQUIRED</filename></emphasis>
  + : The attribute is required when the element is used.
  +Example : <xref linkend="elem_execute"/>.</para></listitem>
  +
  +<listitem><para><emphasis role="bold"><filename>#FIXED</filename></emphasis>
  + : A fixed value. Used with the <filename>Value</filename>
  +option. Example : <xref linkend="elem_alfs"/>.</para></listitem>
   
   </itemizedlist>
   
  
  
  



More information about the alfs-log mailing list