mdassembler - Compile documentation for use in monodoc browser


   mdassembler OPTIONS* DIRS+


   mdassembler  has  been  obsoleted by mdoc(1).  See the mdoc-assemble(1)
   man page.

   mdassembler is a program that creates .tree and .zip files for  use  in
   the monodoc documentation browser.

   The  .tree  and .zip files are copied into monodoc's sources directory,
   and reside with a .source file which is  used  by  monodoc  to  specify
   where  the  documentation  should  be  displayed.   The  .source file's
   /monodoc/source/@basefile attribute specifies the filename  prefix  for
   the documentation files.  This must be the same prefix as used with the
   --out parameter.


   --ecma The  documentation  found  within  DIRS  is  in  the  Mono  ECMA
          documentation  format.   See  the Mono ECMA Documentation Format
          section below.

          The documentation found within DIRS is in the ECMA Specification
          documentation   format.    See   the   Mono  ECMA  Specification
          Documentation Format section below.

          The documentation found within DIRS is in "error"  format.   See
          the Error Documentation Format section below.

   --help Show program argument information.

   --man  The  documentation found within DIRS is in man page format.  See
          the Man Page Documentation Format section below.

   -o, --out PREFIX
          Specify the output file prefix.  mdassembler creates  the  files
 and PREFIX.tree .

          The  documentation found within DIRS is in "simple" format.  See
          the Simple Documentation Format section below.

   --xhtml, --hb
          The documentation found within DIRS is in XHTML format.  See the
          XHTML Documentation Format section below.


   The following documentation formats are supported:

   Mono ECMA Documentation Format
   An XML documentation format with one file per type.

   See the mdoc(5) man page for more information.

   Mono ECMA Specification Documentation Format
   This is not the format you're looking for.

   This  is the format used to represent the ECMA-334 (C#) standard within
   monodoc.  It is not used to display class  library  documentation;  for
   class library documentation, use the --ecma format.

   Error Documentation Format
   Used  to  present detailed error messages, and is used in monodoc's "C#
   Compiler Error Reference" tree.   DIRS  is  not  a  directory,  but  is
   instead a configuration file, containing the XML:


   /ErrorProviderConfig/FilesPath  specifies  where  to  look  for  files,
   /ErrorProviderConfig/Match specifies the filename pattern to  look  for
   within                                  /ErrorProviderConfig/FilesPath,
   /ErrorProviderConfig/ErrorNumSubstringStart                         and
   /ErrorProviderConfig/ErrorNumSubstringLength  control  which portion of
   the    filename    is    used    as    the    error     number,     and
   /ErrorProviderConfig/FriendlyFormatString      controls     how     the
   formatting/display of the node in the monodoc tree.

   For each file found, it is converted to HTML with  C#  syntax  coloring

   Simple Documentation Format
   Converts  text files into HTML by translating each newline into an HTML
   <br> element.

   Man Page Documentation Format
   Converts man pages into HTML for display.

   XHTML Documentation Format
   Copies the XHTML file as-is.


   To install your documenation for use with monodoc:

   Create a PREFIX.source file
          with the contents:

          <?xml version="1.0"?>
            <source provider="FORMAT" basefile="PREFIX" path="PATH"/>

          where FORMAT is the documentation format  contained  within  the
          PREFIX.tree file, e.g.  ecma, or simple.  PREFIX is the basename
          of the .tree and .zip files that mdassembler creates.   PATH  is
          the   "path"  in  the  monodoc  tree  that  should  contain  the
          documentation.  See  the  @prefix@/lib/monodoc/monodoc.xml  file
          for a list of PATH values (the //node/@name values).

          See                    also:                    http://www.mono-


   Create your documentation
          See also the monodocer(1) man page, e.g.

               monodocer -assembly:foo.dll -path:foo/en

   Assemble the documentation

               mdassembler --ecma foo/en PREFIX

          Make sure that you use the same PREFIX here as you did above.

   Install the documentation by using the command

               cp PREFIX.source PREFIX.tree \
               `pkg-config monodoc --variable=sourcesdir`

          (Note  the  backticks  used  in  the  pkg-config command!)  This
          copies the .source , .tree , and .zip  files  into  the  monodoc
          sources  directory,  which  will  allow  monodoc  to display the


   mdcs2ecma(1),     mdnormalizer(1),      mdoc(1),      mdoc-assemble(1),
   mdvalidator(1), monodocer(1), monodocs2html(1)


   Visit    for


   See    also:    and     http://www.mono-



Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.