1mdassembler(1) General Commands Manual mdassembler(1)
2
6 mdassembler - Compile documentation for use in monodoc browser
7
9 mdassembler OPTIONS* DIRS+
10
12 mdassembler has been obsoleted by mdoc(1). See the mdoc-assemble(1)
13 man page.
14 mdassembler is a program that creates .tree and .zip files for use in
16 the monodoc documentation browser.
17 The .tree and .zip files are copied into monodoc's sources directory,
19 and reside with a .source file which is used by monodoc to specify
20 where the documentation should be displayed. The .source file's /mon‐
21 odoc/source/@basefile attribute specifies the filename prefix for the
22 documentation files. This must be the same prefix as used with the
23 --out parameter.
24
26 --ecma The documentation found within DIRS is in the Mono ECMA documen‐
27 tation format. See the Mono ECMA Documentation Format section
28 below.
29 --ecmaspec
31 The documentation found within DIRS is in the ECMA Specification
32 documentation format. See the Mono ECMA Specification Documen‐
33 tation Format section below.
34 --error
36 The documentation found within DIRS is in "error" format. See
37 the Error Documentation Format section below.
38 --help Show program argument information.
40 --man The documentation found within DIRS is in man page format. See
42 the Man Page Documentation Format section below.
43 -o, --out PREFIX
45 Specify the output file prefix. mdassembler creates the files
46 PREFIX.zip and PREFIX.tree .
47 --simple
49 The documentation found within DIRS is in "simple" format. See
50 the Simple Documentation Format section below.
51 --xhtml, --hb
53 The documentation found within DIRS is in XHTML format. See the
54 XHTML Documentation Format section below.
55
57 The following documentation formats are supported:
58 Mono ECMA Documentation Format
60 An XML documentation format with one file per type.
61 See the mdoc(5) man page for more information.
63 Mono ECMA Specification Documentation Format
65 This is not the format you're looking for.
66 This is the format used to represent the ECMA-334 (C#) standard within
68 monodoc. It is not used to display class library documentation; for
69 class library documentation, use the --ecma format.
70 Error Documentation Format
72 Used to present detailed error messages, and is used in monodoc's "C#
73 Compiler Error Reference" tree. DIRS is not a directory, but is
74 instead a configuration file, containing the XML:
75 <ErrorProviderConfig>
77 <FilesPath>../../mcs/errors</FilesPath>
78 <Match>cs????*.cs</Match>
79 <ErrorNumSubstringStart>2</ErrorNumSubstringStart>
80 <ErrorNumSubstringLength>4</ErrorNumSubstringLength>
81 <FriendlyFormatString>CS{0:0###}</FriendlyFormatString>
82 </ErrorProviderConfig>
83 /ErrorProviderConfig/FilesPath specifies where to look for files,
85 /ErrorProviderConfig/Match specifies the filename pattern to look for
86 within /ErrorProviderConfig/FilesPath, /ErrorProviderConfig/ErrorNum‐
87 SubstringStart and /ErrorProviderConfig/ErrorNumSubstringLength control
88 which portion of the filename is used as the error number, and /Error‐
89 ProviderConfig/FriendlyFormatString controls how the formatting/display
90 of the node in the monodoc tree.
91 For each file found, it is converted to HTML with C# syntax coloring
93 applied.
94 Simple Documentation Format
96 Converts text files into HTML by translating each newline into an HTML
97 <br> element.
98 Man Page Documentation Format
100 Converts man pages into HTML for display.
101 XHTML Documentation Format
103 Copies the XHTML file as-is.
104
106 To install your documenation for use with monodoc:
107 Create a PREFIX.source file
109 with the contents:
110 <?xml version="1.0"?>
112 <monodoc>
113 <source provider="FORMAT" basefile="PREFIX" path="PATH"/>
114 </monodoc>
115 where FORMAT is the documentation format contained within the
117 PREFIX.tree file, e.g. ecma, or simple. PREFIX is the basename
118 of the .tree and .zip files that mdassembler creates. PATH is
119 the "path" in the monodoc tree that should contain the documen‐
120 tation. See the @prefix@/lib/monodoc/monodoc.xml file for a
121 list of PATH values (the //node/@name values).
122 See also: http://www.mono-
124 project.com/docs/tools+libraries/tools/monodoc/generating-docu‐
125 mentation/
126 Create your documentation
128 See also the monodocer(1) man page, e.g.
129 monodocer -assembly:foo.dll -path:foo/en
131 Assemble the documentation
134 mdassembler --ecma foo/en PREFIX
136 Make sure that you use the same PREFIX here as you did above.
138 Install the documentation by using the command
140 cp PREFIX.source PREFIX.tree PREFIX.zip \
142 `pkg-config monodoc --variable=sourcesdir`
143 (Note the backticks used in the pkg-config command!) This
145 copies the .source , .tree , and .zip files into the monodoc
146 sources directory, which will allow monodoc to display the docu‐
147 mentation.
148
150 mdcs2ecma(1), mdnormalizer(1), mdoc(1), mdoc-assemble(1), mdvalida‐
151 tor(1), monodocer(1), monodocs2html(1)
152
154 Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for
155 details.
156
158 See also: http://www.mono-project.com and http://www.mono-
159 project.com/docs/tools+libraries/tools/mdassembler/
160 mdassembler(1)