Location: PHPKode > scripts > SourceScribe > rstacruz-SourceScribe/docsrc/10-documentation-reference.doc.txt

Page: Documentation reference
[Grouped under "References"]

Documentation reference:

  To be written


Page: Advanced configuration
[Filed under "Documentation reference"]

Required options:

  : The project name. This will be the title of the entire documentation.

    > <code>name: My API reference</code>
    A home page for your manual may be created by defining a page with the
    same name listed here.

  : The outputs to spit out. This is an array of key-value pairs, each pair
    requiring a *driver*, and a *path* to define where the output will be
    saved to.

    > <code>output:  
    > - driver: "html"  
    > &nbsp; template: "default"  
    > &nbsp; path: "doc/"</code>

    Currently only the *html* driver is supported. Plugins may give more
    driver types (e.g., *pdf*, *latex*, etc). Additional templates for
    the *html* driver may be added: see *templates_path* (not yet implemented)

More basic options:

  : The path where the source files are. In this example, SourceScribe will scan
    the *doc* folder (under where the configuration file resides): 

    > <code>src_path: doc</code>

   Multiple paths may also be defined using an array.

    > <code>src_path:  
    > &nbsp; - src  
    > &nbsp; - include</code>

  : An array of regex patterns to match filenames against.
    Any file that matches will not be parsed. In this example below,
    SourceScribe will skip files under the folders *.svn*, *.git*, and *cache*:  

    > <code>exclude:  
    > &nbsp; - \.svn/  
    > &nbsp; - \.git/  
    > &nbsp; - /cache/</code>
  : File types to include. This is an array of regex patterns. Defining this
    option will override all defaults, so be sure to include here all filetypes
    that your project uses. In the example below, this will make SourceScribe
    scan *php3* and *php4* file types: 
    > <code>include:  
    > &nbsp; - \\.php3$  
    > &nbsp; - \\.php4$</code>
    If you have a plugin that provides an alternate reader, you can define which
    reader to use for each file type.
    > <code>include:    
    > &nbsp; \\.php3$: default  
    > &nbsp; \\.php4$: default</code>

Advanced options:
  : Add your own block types, or modify built-in types (...)

    > <code>block_types:  
    > &nbsp; ... # it's complicated</code>

  : This will remove all the built-in block types defined so you may define
    your own. Use this in conjunction with *block_types*. (...)

    > <code>reset_block_types: true</code>
  : Adds more project-wide tags. (...)

    > <code>tags:  
    > &nbsp; - write-only  
    > &nbsp; - unimplemented  
    > &nbsp; - in debate</code>

  : Excludes any block that is tagged with the tags in this list.
  : This will remove all the built-in tag types defined so you may define
    your own. Use this in conjunction with *tags*.

    > <code>reset_tags: true</code>

    This option will clear only the project-wide tags. It will not clear the
    tag types in each block type.
  : Sets up synonyms for tags. (...)

    > <code>tag_synonyms:  
    > &nbsp; write-only: [ writeonly, no-read, wo ]  
    > &nbsp; unimplemented: [ not done ]</code>

  : (To be implemented) additional path to look for templates in

    > <code>templates_path: templates/     # not implemented!</code>

  : (To be implemented) path to look for plugins in

    > <code>plugins_path: ssplugins/     # not implemented!</code>

For block types:
  Every `block_types` entry can have any of these options.
  Note that *all* of them are optional.

  has_brief        - .
  title_plural     - .
  parent_in_id     - .
  starts_group_for - .
  block_class      - .
  title_prefix     - .
  title_suffix     - .
  tags             - .
  short            - .
  synonyms         - .

Return current item: SourceScribe