[docs] xmldocs - docelic modified 9 files

docs at icdevgroup.org docs at icdevgroup.org
Wed Jul 21 16:55:52 EDT 2004


User:      docelic
Date:      2004-07-21 20:55:52 GMT
Added:     docbook/item-skel bugs control description example notes
Added:              synopsis
Added:     images   home.gif up.gif
Added:     refs/post_page synopsis
Log:
- docbook/item-skel/* files: templates for symbols documentation
- images/: added home.gif and up.gif (should be .png once later)
- refs/post_page/synopsis: how did this slip through uncommited before

Revision  Changes    Path
1.1                  xmldocs/docbook/item-skel/bugs


rev 1.1, prev_rev 1.0
Index: bugs
===================================================================
<!-- List bugs here. Environment is <para>.
     Delete those two lines.            -->



1.1                  xmldocs/docbook/item-skel/control


rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here. 
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty

#  purpose: oneline description (MUST FILL IN)
purpose:
# Please take time to fill in the See Also line.
#  Just name the related symbols. The system will work everything out.
#  (Note that if you link some item from here, that item will auto-point
#  back here (under "indirect links" section))
see also:

# Usually not needed to modify below

#  id: name of the output file (defaults to <name>)
id:
#  name: visible name in the pages
name:
#  specify person(s). Defaults to icdevgroup
author:
#  leave empty; GPL is the default
copyright:



1.1                  xmldocs/docbook/item-skel/description


rev 1.1, prev_rev 1.0
Index: description
===================================================================
<!-- Enter description here. Context is <para>.
     Delete those two lines                 -->



1.1                  xmldocs/docbook/item-skel/example


rev 1.1, prev_rev 1.0
Index: example
===================================================================
<!-- Template example. Fill in the title (in title), short description
     (in para) and actual program chunk (inside listing/cdata).
     Delete those 3 lines of comments.                             -->

<example>

<title>
</title>

<para>
</para>

<programlisting><![CDATA[
]]></programlisting>

</example>



1.1                  xmldocs/docbook/item-skel/notes


rev 1.1, prev_rev 1.0
Index: notes
===================================================================
<!-- Add notes or delete this line -->



1.1                  xmldocs/docbook/item-skel/synopsis


rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<!-- Synopsis is a CDATA block (it's <pre>formatted), so you're pretty
     much free to construct the synopsis any way you want. Try to keep it
     along the lines of (if not describing Tags for which this scheme is
     not usable: 

      literal - literal text
      <text>  - mandatory value
      [text]  - optional text

     Describe various options inside 'description' file.
     Delete those comment lines                                       -->

<synopsis><![CDATA[
]]></synopsis>



1.1                  xmldocs/images/home.gif


<<home.gif: GIF image data, version 89a, 35 x 15>>


1.1                  xmldocs/images/up.gif


<<up.gif: GIF image data, version 89a, 35 x 15>>


1.1                  xmldocs/refs/post_page/synopsis


rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Pragma post_page=<subroutine name>
]]></synopsis>








More information about the docs mailing list