cvs commit: ALFS/docs/syntax_doc/preface changelog.xml

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Tue Nov 4 18:53:21 PST 2003


jwrober     03/11/04 19:53:21

  Modified:    docs/syntax_doc index.xml
               docs/syntax_doc/alfs_dtd elem_alfs.xml
               docs/syntax_doc/book book.ent
               docs/syntax_doc/preface changelog.xml
  Log:
  update elem_alfs to match dtd.
  
  Revision  Changes    Path
  1.10      +2 -2      ALFS/docs/syntax_doc/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/index.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- index.xml	4 Nov 2003 02:48:54 -0000	1.9
  +++ index.xml	5 Nov 2003 02:53:21 -0000	1.10
  @@ -3,8 +3,8 @@
   			"/usr/share/docbook/docbookx.dtd" [
   
   <!ENTITY alfs-dtd-version "3.1">
  -<!ENTITY version "&alfs-dtd-version;-20031103">
  -<!ENTITY releasedate "November 3rd, 2003">
  +<!ENTITY version "&alfs-dtd-version;-20031104">
  +<!ENTITY releasedate "November 4th, 2003">
   
   <!ENTITY % book      SYSTEM "book/book.ent">
   <!ENTITY % preface   SYSTEM "preface/preface.ent">
  
  
  
  1.7       +47 -35    ALFS/docs/syntax_doc/alfs_dtd/elem_alfs.xml
  
  Index: elem_alfs.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_alfs.xml,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- elem_alfs.xml	30 Sep 2003 15:07:51 -0000	1.6
  +++ elem_alfs.xml	5 Nov 2003 02:53:21 -0000	1.7
  @@ -6,33 +6,33 @@
   <title>Syntax</title>
   
   <synopsis>
  -<!ELEMENT alfs           (configure|copy|download|execute|if|link|make|
  -                          mkdir|move|ownership|package|patch|
  -                          permissions|remove|search_replace|
  -                          stage|textdump|unpack)*>
  +<!ELEMENT alfs     ((configure | copy | download | execute | link |
  +                        make | mkdir | move | ownership | package |
  +                        patch | permissions | remove | search_replace |
  +                        stage | textdump | unpack)*)>
   <!ATTLIST alfs
  -          version        CDATA   #FIXED "3.1">
  +          base        CDATA #IMPLIED
  +          version     CDATA #FIXED "3.1">
   </synopsis>
   
   <para>See also :
  -<link linkend="elem_configure">configure</link>,
  -<link linkend="elem_copy">copy</link>,
  -<link linkend="elem_download">download</link>,
  -<link linkend="elem_execute">execute</link>,
  -<link linkend="elem_if">if</link>,
  -<link linkend="elem_link">link</link>,
  -<link linkend="elem_make">make</link>,
  -<link linkend="elem_mkdir">mkdir</link>,
  -<link linkend="elem_move">move</link>,
  -<link linkend="elem_ownership">ownership</link>,
  -<link linkend="elem_package">package</link>,
  -<link linkend="elem_patch">patch</link>,
  -<link linkend="elem_permissions">permissions</link>,
  -<link linkend="elem_remove">remove</link>,
  -<link linkend="elem_search_replace">search_replace</link>,
  -<link linkend="elem_stage">search_stage</link>,
  -<link linkend="elem_textdump">textdump</link>,
  -<link linkend="elem_unpack">unpack</link>.
  +<xref linkend="elem_configure"/>,
  +<xref linkend="elem_copy"/>,
  +<xref linkend="elem_download"/>,
  +<xref linkend="elem_execute"/>,
  +<xref linkend="elem_link"/>,
  +<xref linkend="elem_make"/>,
  +<xref linkend="elem_mkdir"/>,
  +<xref linkend="elem_move"/>,
  +<xref linkend="elem_ownership"/>,
  +<xref linkend="elem_package"/>,
  +<xref linkend="elem_patch"/>,
  +<xref linkend="elem_permissions"/>,
  +<xref linkend="elem_remove"/>,
  +<xref linkend="elem_search_replace"/>,
  +<xref linkend="elem_stage"/>,
  +<xref linkend="elem_textdump"/>,
  +<xref linkend="elem_unpack"/>.
   </para>
   
   </sect2>
  @@ -40,35 +40,47 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>alfs</token> is the root element 
  -of the DTD, meaning that an ALFS profile should contain one and only
  -one alfs element, all the other elements being embedded in this element</para>
  +<para>The element <filename>alfs</filename> is the root element of the
  +&book-product;. This means that an <acronym>ALFS</acronym> profile should
  +contain one and only one <filename>alfs</filename> element with all the other
  +elements being embedded in this element.</para>
   
  -<para>When processing an <token>alfs</token> element, one processes all its
  +<para>When processing an <filename>alfs</filename> element, one processes all its
   children in their order of occurence.</para>
   
  -<para>The attribute <token>version</token> identifies the version of the
  -ALFS profile syntax used; it should be <literal>"3.0"</literal>.</para>
  +<para>Notice that all the main operation elements
  +(<filename>configure</filename> to <filename>unpack</filename>) are surrounded
  +by parathensis [()]and followed by an asterisk [*]. The asterisk signifies
  +that each main operation element can be used optionally inside the
  +<filename>alfs</filename> declaration in a profile and that if used, they can
  +be used more than once.</para>
  +
  +<para>The attribute <filename>base</filename> identifies the base directory
  +that work should be performed under. The use of <literal>#IMPLIED</literal>
  +denotes that this attribute is optional.  If not used,
  +<filename>base</filename> will inherit its value from an earlier use in the
  +profile.</para>
  +
  +<para>The attribute <filename>version</filename> identifies the version of the
  +ALFS profile syntax used; it should be <literal>"3.1"</literal>.</para>
   
   </sect2>
   
   <sect2>
   <title>Examples</title>
   
  -<programlisting>
  -<!DOCTYPE alfs SYSTEM "alfs.dtd" [
  +<screen><userinput><!DOCTYPE alfs SYSTEM "alfs-3.1.dtd" [
   
  -<!ENTITY % general_entities SYSTEM "entities/general">
  +<!ENTITY % general_entities SYSTEM "entities/general">
   
   %general_entities;
   
   ]>
  -<alfs version="3.1">
  +<alfs version="3.1">
   
    .....
   
  -</alfs>
  -</programlisting>
  +</alfs></userinput></screen>
   
   </sect2>
   
  
  
  
  1.5       +10 -3     ALFS/docs/syntax_doc/book/book.ent
  
  Index: book.ent
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/book/book.ent,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- book.ent	4 Nov 2003 02:51:54 -0000	1.4
  +++ book.ent	5 Nov 2003 02:53:21 -0000	1.5
  @@ -8,14 +8,21 @@
   
   <!-- Generally used entities go here -->
   
  +<!ENTITY lt     "&#60;">
  +<!ENTITY gt     ">">
  +<!ENTITY amp    "&#38;">
  +<!ENTITY apos   "'">
  +<!ENTITY quot   """>
  +<!ENTITY nbsp   " ">
  +<!ENTITY emdash "İ">
  +
  +<!ENTITY book-product "ALFS DTD">
  +
   <!ENTITY book-maintainer-fullname "James Robertson">
   <!ENTITY book-maintainer-firstname "James">
   <!ENTITY book-maintainer-address "jwrober at linuxfromscratch.org">
  -<!ENTITY book-product "ALFS DTD">
   
   <!ENTITY ftp-root "ftp://ftp.linuxfromscratch.org">
   <!ENTITY http-root "http://www.linuxfromscratch.org">
   <!ENTITY hints-root "http://www.linuxfromscratch.org/hints">
   <!ENTITY alfs-root "http://www.linuxfromscratch.org/alfs">
  -<!ENTITY nbsp " ">
  -<!ENTITY emdash "--">
  
  
  
  1.10      +4 -0      ALFS/docs/syntax_doc/preface/changelog.xml
  
  Index: changelog.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/preface/changelog.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- changelog.xml	4 Nov 2003 03:07:51 -0000	1.9
  +++ changelog.xml	5 Nov 2003 02:53:21 -0000	1.10
  @@ -6,6 +6,10 @@
   
   <itemizedlist>
   
  +<listitem><para>November 4th, 2003 [jwrober]: Updated elem_alfs to match the
  +DTD; also began the element standardization with this element's
  +page.</para></listitem>
  +
   <listitem><para>November 3rd, 2003 [jwrober]: Standardized
   headings.</para></listitem>
   
  
  
  



More information about the alfs-log mailing list