2000-08-13 Manuel Guesdon <mguesdon@orange-concept.com>

* base/Tools/gsdoc-0_6_6.dtd: added ivariable, constant and stylesheet
	* base/Tools/gsdoc.m: added ivariable, constant and stylesheet support
		added index generation
	* base/Tools/gsdoc.gsdoc: added parameters documentation


git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@7200 72102866-910b-0410-8b05-ffd578937521

Tools/gsdoc-0_6_6.dtd

@@ -66,7 +66,7 @@
 <!ENTITY % text "#PCDATA | %xref; | %anchor; | %phrase; | footnote | br">
 
 <!-- Entity for definition elements. -->
-<!ENTITY % def "class|jclass|category|protocol|function|macro|type|variable">
+<!ENTITY % def "class|jclass|category|protocol|function|macro|type|variable|constant">
 
 <!-- Entity for list elements. -->
 <!ENTITY % list "list | enum | deflist | qalist">
@@ -89,6 +89,9 @@
 <!-- The content is a metasyntactic variable name. -->
 <!ELEMENT var (%text;)*>
 
+<!-- The content is a metasyntactic ivariable name. -->
+<!ELEMENT ivar (%text;)*>
+
 <!-- Emphasize the content. -->
 <!ELEMENT em (%text;)*>
 
@@ -145,7 +148,7 @@
 <!ELEMENT ref (%text;)*>
 <!ATTLIST ref
   id CDATA #REQUIRED
-  type (class|protocol|method|function|type|macro|variable|label) "label"
+  type (class|protocol|method|function|type|macro|variable|constant|label) "label"
   class CDATA #IMPLIED
 >
 
@@ -274,6 +277,31 @@
   id CDATA #IMPLIED
   name CDATA #REQUIRED
   type CDATA #REQUIRED
+  posttype CDATA #REQUIRED
+  value CDATA #IMPLIED
+  role (except|defaults|notify|key) #IMPLIED
+>
+
+<!-- Ivariable definition.
+  VALUE may be set for a constant or a default value
+-->
+<!ELEMENT ivariable (declared?, desc?, standards?)>
+<!ATTLIST ivariable
+  id CDATA #IMPLIED
+  name CDATA #REQUIRED
+  type CDATA #REQUIRED
+  posttype CDATA #REQUIRED
+  value CDATA #IMPLIED
+  role (except|defaults|notify|key) #IMPLIED
+>
+
+<!-- Constant definition.
+  VALUE may be set for a constant or a default value
+-->
+<!ELEMENT constant (declared?, desc?, standards?)>
+<!ATTLIST constant
+  id CDATA #IMPLIED
+  name CDATA #REQUIRED
   value CDATA #IMPLIED
   role (except|defaults|notify|key) #IMPLIED
 >
@@ -304,14 +332,14 @@
 <!-- Show a protocol a class conforms to. -->
 <!ELEMENT conform (#PCDATA)*>
 
-<!ELEMENT class (declared?, conform*, desc?, method*, standards?)>
+<!ELEMENT class (declared?, conform*, desc?, ivariable*, method*, standards?)>
 <!ATTLIST class
   id CDATA #IMPLIED
   name CDATA #REQUIRED
   super CDATA #IMPLIED
 >
 
-<!ELEMENT jclass (declared?, conform*, desc?, jmethod*, standards?)>
+<!ELEMENT jclass (declared?, conform*, desc?, ivariable*, jmethod*, standards?)>
 <!ATTLIST jclass
   id CDATA #IMPLIED
   name CDATA #REQUIRED
@@ -388,7 +416,7 @@
 <!-- Index -->
 <!ELEMENT index EMPTY>
 <!ATTLIST index
-  type (class|protocol|method|function|type|macro|variable|label) "label"
+  type (class|protocol|method|function|type|macro|variable|constant|label) "label"
 >
 
 
@@ -445,5 +473,6 @@
   next CDATA #IMPLIED
   prev CDATA #IMPLIED
   up CDATA #IMPLIED
+  stylesheeturl CDATA #IMPLIED
 >
 

Tools/gsdoc.gsdoc

@@ -575,6 +575,37 @@
 	Use of the tool is trivial - just provide it with a list of gsdoc
 	file names, and it will produce a load of html output files.
       </p>
+		<section>
+		  <heading>Parameters</heading>
+		  <deflist>
+			<term><ref id="--makeRefs">--makeRefs=ReferencesFileName</ref></term>
+		  <desc>With this option, gsdoc reads gsdoc files and create ReferencesFileName.gsdocrefs files which can be used as <ref id="">--refs</ref> to make links between elements</desc>
+			
+		  <term><ref id="--projectName">--projectName=TheProjectName</ref></term>
+		  <desc>Set the project name to "TheProjectName".It is used fo index titles,...</desc>
+			
+		  <term><ref id="--refs">--refs=ARefFile or --refs=ARefDirectory</ref></term>
+		  <desc>Use ARefFile.gsdocrefs (or files whith extensions .gsdocrefs in ARefDirectory directory) as references files. It's enable to make links bettwen documentations</desc>
+			
+		  <term><ref id="--makeIndex">--makeIndex=MyIndexFileName</ref></term>
+		  <desc>Create an index of the parsed files and save it as MyIndexName.gsdoc. You have to set --makeIndexTemplate option</desc>
+			
+		  <term><ref id="--makeIndexTemplate">--makeIndexTemplate=MyIndexTemplateFileName</ref></term>
+		  <desc>The file used as index template for makeIndex option</desc>
+			
+		  <term><ref id="--define-">--define-XXX=YYY</ref></term>
+		  <desc>Used to define a constant named XXX with value YYY in .gsdoc file, all [[infoDictionary.XXX]] texts are replaced with YYY</desc>
+			
+		  <term><ref id="-verbose">--verbose=X</ref></term>
+		  <desc>Level of traces from 0 to ...</desc>
+			
+		  <term><ref id="--location">--location=file://usr/doc/gnustep/MyProject or --location=http://www.gnustep.org/gnustep/MyProject</ref></term>
+		  <desc>Location of the installed documentation (it helps to make kinks between projects)</desc>
+			
+		  <term><ref id="files">file1 file2</ref></term>
+		  <desc>.gsdoc files</desc>
+		  </deflist>
+		</section>
     </chapter>
 
     <back>