Documenting Databases through the Command Line

You can automate document generation using the command line.

  1. Click Start, type cmd in the Search programs and files text box, and press ENTER. The Command Prompt opens.

  2. Specify the operation you want to perform and the required parameters and arguments (actions you want to run) in the Command Prompt, for example as follows:

     documenter.com /document [/switch1[:value | [parameter1:value parameter2:value ..]] /switch2 ..]
    
  3. Press ENTER to run the process.

    Select corresponding command line switches to perform the required operations:

Argument Action and Usage
/author Specifies the ‘author’ parameter for documentation. Overrides the ‘author’ field value specified in the documentation project file (.ddoc). Command usage looks like: /author:<expression>
/breadcrumbs Specifies the ‘breadcrumbs’ parameter value for documentation. To turn on the option, specify: Yes, Y, On, True, T. To turn off the option, specify: No, N, Off, False, F. The default value for the parameter is Y. Command usage looks like: /breadcrumbs:<value>
/connection This switch is used to specify the connection string. Command usage looks like: /connection:<connection_string>
/copyright This switch is used to specify the ‘copyright’ parameter for documentation. Overrides the ‘copyright’ field value specified in the documentation project file (.ddoc). Command usage looks like: /copyright:<expression>
/created This switch is used to specify the ‘created’ parameter for documentation. Overrides the ‘created’ field value specified in the documentation project file (.ddoc). Command usage looks like: /created:<expression>
/database This switch is used to specify schemas for which the documentation project will be generated. The user can specify a single schema or multiple schemas separated by commas. If the user wants to select all the schemas of the server, the ALLDATABASES parameter can be used (ex. /database:ALLDATABASES). Command usage looks like: /database:<schname1[,schname2]>
/docdescription This switch is used to specify the ‘docdescription’ parameter for documentation. Overrides the ‘docdescription’ field value specified in the documentation project file (.ddoc). Command usage looks like: /docdescription:<expression>
/doclogo This switch is used to specify the ‘doclogo’ parameter for documentation. Overrides the ‘doclogo’ field value specified in the documentation project file (.ddoc) (eg. "D:\mydoc\proj.png"). Command usage looks like: /doclogo:<path>
/doctitle Specifies the ‘doctitle’ parameter for documentation. Overrides the ‘doctitle’ field value specified in the documentation project file (.ddoc). Command usage looks like: /doctitle:<expression>
/documentformat This switch is used to specify the output documentation file format: HTML - a simple HTML file; PDF - a portable document format file; MARKDOWN - a document with a lightweight markup language. If the format was not specified, the default is HTML. Command usage looks like: /documentformat:<HTML|PDF|MARKDOWN>
/outputfile This switch is used to specify the output path to generate documentation (eg. "D:\mydoc\"”). Command usage looks like: /outputfile:<path>
/password This switch is used to specify server password. Override password specified in the connection string. Command usage looks like: /password:<pw>
/projfile This switch is used to load command line settings from the project file .ddoc ("D:\mydoc.ddoc"). Command usage looks like: /projfile:<path>