Changes between Version 10 and Version 11 of TracLegosConfiguration


Ignore:
Timestamp:
Nov 2, 2015, 10:34:50 AM (6 years ago)
Author:
figaro
Comment:

Tagged as reference

Legend:

Unmodified
Added
Removed
Modified
  • TracLegosConfiguration

    v10 v11  
    11= [TracLegosScript TracLegos] Configuration =
    22
    3 '''NOTE: not all of the functionality presented herein has been implemented.  This documentation primarily serves as a spec for how [TracLegosScript TracLegos] should work.'''
     3'''Note''': not all of the functionality presented herein has been implemented. This documentation primarily serves as a spec for how [TracLegosScript TracLegos] should work.
    44
    55[TracLegosScript TracLegos] is designed to support several ways of creating trac projects: from the command line (`create-trac-project`), via a [http://pythonpaste.org paster] [source:traclegosscript/anyrelease/traclegos/web.py web interface], and via API calls to [source:traclegosscript/anyrelease/traclegos/legos.py#L100 TracLegos.create_project] and support functions such as [source:traclegosscript/anyrelease/traclegos/legos#L253].
    66
    7 In all three cases, you can have a site configuration file.  The site configuration file contains [TracLegosTemplates template] variables appropriate to the particular site as well as driver configuration defining the project directory, database type, a default set of templates, and other configuration needed to define trac project creation.  A site configuration `.ini` file may be used to enable a trac project creation policy, whether by convention (using `create-trac-project` from the command line) or by enforcement (using the web front end).  The site configuration is tailored to the needs of a particular site or organization and so is not useful to share. Contrast this to [TracLegosTemplates trac project templates] which are generally meant to be generic and therefore sharable.
     7In all three cases, you can have a site configuration file. The site configuration file contains [TracLegosTemplates template] variables appropriate to the particular site as well as driver configuration defining the project directory, database type, a default set of templates, and other configuration needed to define trac project creation. A site configuration `.ini` file may be used to enable a trac project creation policy, whether by convention (using `create-trac-project` from the command line) or by enforcement (using the web front end). The site configuration is tailored to the needs of a particular site or organization and so is not useful to share. Contrast this to [TracLegosTemplates trac project templates] which are generally meant to be generic and therefore sharable.
    88
    99== Site Configuration Example ==
     
    1515There are two sections:
    1616
    17  * `[site-configuration]` contains defaults for arguments to [source:traclegosscript/anyrelease/traclegos/legos.py#L100 TracLegos.create_project] and the [source:traclegosscript/anyrelease/traclegos/legos.py#L32 TracLegos constructor].  These have the same name as specified on the command line and also the method arguments. ''This section also contains the database types and project types '''TO BE IMPLEMENTED?''' ''
     17 * `[site-configuration]` contains defaults for arguments to [source:traclegosscript/anyrelease/traclegos/legos.py#L100 TracLegos.create_project] and the [source:traclegosscript/anyrelease/traclegos/legos.py#L32 TracLegos constructor]. These have the same name as specified on the command line and also the method arguments. ''This section also contains the database types and project types '''TO BE IMPLEMENTED?''' ''
    1818
    19  * `[variables]` contains default values for variables.  For instance, if your company has a standard footer, and you are using which is set by `$footer` in templates, you could set `footer = Visit <a href="http://example.com">Our Company</a>"` to have a sane default.
     19 * `[variables]` contains default values for variables. For instance, if your company has a standard footer, and you are using which is set by `$footer` in templates, you could set `footer = Visit <a href="http://example.com">Our Company</a>"` to have a sane default.
    2020
    2121== Use of [TracLegosScript TracLegos] Site Configuration ==
     
    2929 * via API calls to `TracLegos.create_project`
    3030
    31 Running `create-trac-projct -c site-configuration.ini` will read the variables and defaults from the `site-configuration.ini` file.  Additional parameters and variables passed via the command line will override those in `site-configuration.ini`. Additional templates passed in will be applied in order and overwrite configuration from previous templates.
     31Running `create-trac-projct -c site-configuration.ini` will read the variables and defaults from the `site-configuration.ini` file. Additional parameters and variables passed via the command line will override those in `site-configuration.ini`. Additional templates passed in will be applied in order and overwrite configuration from previous templates.
    3232
    33 Running `paster serve paster.ini` reads configuration from the `paster.ini` file.  If `traclegos.conf` is set in section `[app:traclegos]` of the `paster.ini` file, site configuration will be read from that file (or comma separated list of files).  Other configuration in the `[app:traclegos]` section of the `paster.ini` file will override those in the `[site-configuration]` file(s) specified by `traclegos.conf`. [TracLegosTemplates Template] variables may be specified in the `[DEFAULTS]` section of the `paster.ini` file which will override those given in the `[variables]` section of the `traclegos.conf` files.
     33Running `paster serve paster.ini` reads configuration from the `paster.ini` file. If `traclegos.conf` is set in section `[app:traclegos]` of the `paster.ini` file, site configuration will be read from that file (or comma separated list of files). Other configuration in the `[app:traclegos]` section of the `paster.ini` file will override those in the `[site-configuration]` file(s) specified by `traclegos.conf`. [TracLegosTemplates Template] variables may be specified in the `[DEFAULTS]` section of the `paster.ini` file which will override those given in the `[variables]` section of the `traclegos.conf` files.