1mdassembler(1)              General Commands Manual             mdassembler(1)
2
3
4

NAME

6       mdassembler - Compile documentation for use in monodoc browser
7

SYNOPSIS

9       mdassembler OPTIONS* DIRS+
10

OPTIONS

12       --ecma The documentation found within DIRS is in the Mono ECMA documen‐
13              tation format.  See the Mono ECMA Documentation  Format  section
14              below.
15
16       --ecmaspec
17              The documentation found within DIRS is in the ECMA Specification
18              documentation format.  See the Mono ECMA Specification  Documen‐
19              tation Format section below.
20
21       --error
22              The  documentation  found within DIRS is in "error" format.  See
23              the Error Documentation Format section below.
24
25       --help Show program argument information.
26
27       --man  The documentation found within DIRS is in man page format.   See
28              the Man Page Documentation Format section below.
29
30       -o, --out PREFIX
31              Specify  the  output file prefix.  mdassembler creates the files
32              PREFIX.zip and PREFIX.tree .
33
34       --simple
35              The documentation found within DIRS is in "simple" format.   See
36              the Simple Documentation Format section below.
37
38       --xhtml, --hb
39              The documentation found within DIRS is in XHTML format.  See the
40              XHTML Documentation Format section below.
41

DESCRIPTION

43       mdassembler is a program that creates .tree and .zip files for  use  in
44       the monodoc documentation browser.
45
46       The  .tree  and .zip files are copied into monodoc's sources directory,
47       and reside with a .source file which is  used  by  monodoc  to  specify
48       where  the documentation should be displayed.  The .source file's /mon‐
49       odoc/source/@basefile attribute specifies the filename prefix  for  the
50       documentation  files.   This  must  be the same prefix as used with the
51       --out parameter.
52

FORMATS

54       The following documentation formats are supported:
55
56   Mono ECMA Documentation Format
57       An XML documentation format with one file per type.
58
59       See the monodocer(1) man page for more information.
60
61   Mono ECMA Specification Documentation Format
62       This is not the format you're looking for.
63
64       This is the format used to represent the ECMA-334 (C#) standard  within
65       monodoc  .   It is not used to display class library documentation; for
66       class library documentation, use the --ecma format.
67
68   Error Documentation Format
69       Used to present detailed error messages, and is used in  monodoc  tree.
70       DIRS  is not a directory, but is instead a configuration file, contain‐
71       ing the XML:
72       <ErrorProviderConfig>
73               <FilesPath>../../mcs/errors</FilesPath>
74               <Match>cs????*.cs</Match>
75               <ErrorNumSubstringStart>2</ErrorNumSubstringStart>
76               <ErrorNumSubstringLength>4</ErrorNumSubstringLength>
77               <FriendlyFormatString>CS{0:0###}</FriendlyFormatString>
78       </ErrorProviderConfig>
79
80       /ErrorProviderConfig/FilesPath  specifies  where  to  look  for  files,
81       /ErrorProviderConfig/Match  specifies  the filename pattern to look for
82       within /ErrorProviderConfig/FilesPath ,  /ErrorProviderConfig/ErrorNum‐
83       SubstringStart and /ErrorProviderConfig/ErrorNumSubstringLength control
84       which portion of the filename is used as the error number, and  /Error‐
85       ProviderConfig/FriendlyFormatString controls how the formatting/display
86       of the node in the monodoc tree.
87
88       For each file found, it is converted to HTML with  C#  syntax  coloring
89       applied.
90
91   Simple Documentation Format
92       Converts  text files into HTML by translating each newline into an HTML
93       <br> element.
94
95   Man Page Documentation Format
96       Converts man pages into HTML for display.
97
98   XHTML Documentation Format
99       Copies the XHTML file as-is.
100

EXAMPLES

102       To install your documenation for use with monodoc:
103
104       Create a PREFIX.source file
105              with the contents:
106
107              <?xml version="1.0"?>
108              <monodoc>
109                <source provider="FORMAT" basefile="PREFIX" path="PATH"/>
110              </monodoc>
111
112              where FORMAT is the documentation format  contained  within  the
113              PREFIX.tree  file, e.g.  ecma , or simple .  PREFIX is the base‐
114              name of the .tree and .zip files that mdassembler creates.  PATH
115              is  the "path" in the monodoc tree that should contain the docu‐
116              mentation.  See the @prefix@/lib/monodoc/monodoc.xml file for  a
117              list of PATH values (the //node/@name values).
118
119              See also: http://www.mono-project.com/Generating_Documentation
120
121       Create your documentation
122              See also the monodocer(1) man page, e.g.
123
124                   monodocer -assembly:foo.dll -path:foo/en
125
126
127       Assemble the documentation
128
129                   mdassembler --ecma foo/en PREFIX
130
131              Make sure that you use the same PREFIX here as you did above.
132
133       Install the documentation by using the command
134
135                   cp PREFIX.source PREFIX.tree PREFIX.zip \
136                   `pkg-config monodoc --variable=sourcesdir`
137
138              (Note  the  backticks  used  in  the  pkg-config command!)  This
139              copies the .source , .tree , and .zip  files  into  the  monodoc
140              sources directory, which will allow monodoc to display the docu‐
141              mentation.
142

MAILING LISTS

144       Visit    http://lists.ximian.com/mailman/listinfo/mono-docs-list    for
145       details.
146

WEB SITE

148       See     also:     http://www.mono-project.com     ,    http://www.mono-
149       project.com/Assembler
150
151
152
153                                                                mdassembler(1)