-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreadme.txt
168 lines (118 loc) · 6.44 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
==============================================================================
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
==============================================================================
1. Download
This release of xsddoc is available in two version:
If you already have Apache Xalan and Xerces on your classpath, the standard
distribution should be your choice. Otherwise download the full distribution
to have all required libraries. Both distributions are available once in ZIP
format for Win32 users and once as tar.gz for Unix/Linux users.
here you can download xframe - xsddoc:
http://sourceforge.net/project/showfiles.php?group_id=48863
==============================================================================
2. Installation of xsddoc as command line tool
2.1. extract the xsddoc distribution file to a folder of your choice.
2.2. declare an environment variable XSDDOC_HOME and set it to the folder
where you have extracted xsddoc.
2.3. add the bin folder of xsddoc to your systems path.
Example on UNIX (bash):
> export XSDDOC_HOME=/usr/local/xsddoc
> export PATH=${XSDDOC_HOME}/bin: ${PATH}
Example on UNIX (csh):
> setenv XSDDOC_HOME /usr/local/xsddoc
> set path=( $XSDDOC_HOME/bin $path )
Example on Win32:
> set XSDDOC_HOME=C:\Programs\xframe\xsddoc
> set PATH=%XSDDOC_HOME%;%PATH%
2.4. try to build the sample that comes with xsddoc:
Example with the command line tool
> cd samples/XMLSchema
> mkdir doc
> xsddoc -t "XML Schema for XML Schema" -o doc -verbose XMLSchema.xsd
Example with Apache Ant
> cd samples
> ant
==============================================================================
3. Installation of xsddoc for Apache Ant
All you have to do is to copy the file xsddoc.jar to the lib folder of your ant installation.
==============================================================================
4. Command line usage
Usage: xsddoc [-option] schema
(to document a schema)
where options include:
-o -out <folder> Set the output folder
-t -doctitle <title> Set the documentation title
-h -header <header> Set the documentation header
-f -footer <footer> Set the documentation footer
-b -bottom <bottom> Set the documentation bottom
-s -hideSubTypes hide sub types references
-l -hideSubLocalUsage hide show local usage references
-p -hideTypes hide types in overview pages
-g -hideGroups hide groups in overview pages
-a -hideAttributes hide attributes in overview pages
-xml output as XML instead of HTML
-version Only output version of xsddoc
-v -verbose Output messages about what xsddoc is doing
-q -quiet Be quiet about what xsddoc is doing
-d -debug Output debug messages
-? -help Print this help message
==============================================================================
5. Usage with Apache Ant
5.1. ensure that the file xsddoc.jar is on your clathpath when starting ant.
One easy way to do this is to copy it to the lib folder of your ant installation.
5.2. Task definition
Add the following XML fragment to your build file:
<taskdef name="xsddoc" classname="net.sf.xframe.xsddoc.Task"/>
5.3. Task usage, Example
<xsddoc file="myschema.xsd"
out="doc/schema/myschema"
title="Title of my schema"
verbose="true"/>
5.4. Attributes of xsddoc task:
file path to location of schema
dir folder of schemas
out optional, path to output folder (default: .)
doctitle optional, descriptibe title of schema
header Include header text for each page (html-code) (default: no)
footer Include footer text for each page (html-code) (default: no)
bottom Include bottom text for each page (html-code) (default: no)
failonerror Log a warning message, but do not stop the build,
when the file to copy does not exist or one of the
nested filesets points to a directory that doesn't
exist or an error occurs while copying. (default: no)
verbose optional boolean, verbose output (default: true)
quiet optional boolean, quiet output (default: false)
debug optional boolean, debug output (default: false)
xml optional boolean, if XML should be generated
insteadof html for schema components (default: false)
hideSubTypes optional boolean, if sub types reference should be hidden (default: false)
hideLocalUsage optional boolean, if local usage reference should be hidden (default: false)
hideTypes hide types in overview pages (default: false)
hideGroups hide groups in overview pages (default: false)
hideAttributes hide attributes in overview pages (default: false)
5.5. nested tags
fileset fileset of schemas (see ant documentation for details)
doctitle Same as the doctitle attribute, but you can nest text inside the element this way.
header Similar to <doctitle>.
footer Similar to <doctitle>.
bottom Similar to <doctitle>
==============================================================================
6. Support, Community
If you have questions or problems with xsddoc, you can get support in several ways:
- check out the information on our homepage at http://xframe.sourceforge.net/xsddoc/index.html
- subscribe to our mailing list at http://sourceforge.net/mail/?group_id=48863
- search for help in our xsddoc forum at http://sourceforge.net/forum/forum.php?forum_id=318508
- ask a question to the xframe team in our xsddoc forum at http://sourceforge.net/forum/forum.php?forum_id=318508