Changes between Version 44 and Version 45 of TracLegosScript


Ignore:
Timestamp:
Mar 16, 2015, 7:52:40 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • TracLegosScript

    v44 v45  
    11[[Image(source:traclegosscript/anyrelease/image/TracLegos.png, 200px, align=right)]]
    2 
    3 = Building blocks for creating Trac projects =
    4 
    5 [[TOC]]
    6 
    7 == Description ==
    8 
    9 !TracLegos is software designed to template trac projects and assist with trac project creation. 
    10 Its goal is to make project creation easy and flexible, allowing
    11 flexibility with regards to creation methodology as well as
    12 extensibility as a project factory for environments with advanced
    13 needs.  !TracLegos is not meant for project
    14 upgrading or maintainence, but only to setup a project with sensible
    15 defaults.
    16 
    17 You should be able to setup your own templates to suit your trac needs.  You should be able to share these templates with others.
     2[[PageOutline(2-5,Contents,pullout)]]
     3
     4= Building blocks for creating Trac projects
     5
     6== Description
     7
     8!TracLegos is software designed to template Trac projects and assist with Trac project creation. 
     9Its goal is to make project creation easy and flexible, allowing flexibility with regards to creation methodology as well as extensibility as a project factory for environments with advanced needs. !TracLegos is not meant for project upgrading or maintenance, but only to setup a project with sensible defaults.
     10
     11You should be able to setup your own templates to suit your Trac needs. You should be able to share these templates with others.
    1812
    1913!TracLegos can be invoked in a number of ways:
    … …  
    2519!TracLegos also makes it easy to turn an existing project into a [http://pythonpaste.org/script/developer.html#template PasteScript template].
    2620
    27 == Bugs/Feature Requests ==
    28 
    29 This is somewhat experimental software so feedback and feature requests are greatly appreciated
     21See also: AdminToolkitScript
     22
     23== Bugs/Feature Requests
     24
     25This is experimental software, so feedback and feature requests are greatly appreciated.
    3026
    3127Existing bugs and feature requests for TracLegosScript are
    … …  
    3430[/newticket?component=TracLegosScript&owner=k0s new ticket].
    3531
    36 == Installation and Setup ==
     32[[TicketQuery(component=TracLegosScript&group=type,format=progress)]]
     33
     34== Download and Source
    3735
    3836Download the [download:traclegosscript zipped source], check out [/svn/traclegosscript/anyrelease using Subversion], or [source:traclegosscript/anyrelease browse the source] with Trac.
    3937
    40 Installation is done in the typical python manner.  Once you have downloaded the source, run {{{python setup.py install}}} for installation into python's site packages or {{{python setup.py develop}}} to install with edittable source.
    41 
    42 === Installation of Example Template ===
     38== Installation
     39
     40Installation is done in the typical python manner. Once you have downloaded the source, run {{{python setup.py install}}} for installation into python's site packages or {{{python setup.py develop}}} to install with edittable source.
     41
     42=== Example Template
    4343
    4444TracLegosScript also comes with an existing template:  source:traclegosscript/anyrelease/example/oss, which is an example of the kind of template used at [http://topp.openplans.org/ The Open Planning Project] for open source software projects.  To install this template, run {{{python setup.py install}}} or {{{python setup.py develop}}} from this directory.  This [http://pythonpaste.org/script/developer.html#templates PasteScript template] can be seen in the output of `paster create --list-templates`:
    … …  
    5353}}}
    5454
    55 === Turning an Existing {{{trac.ini}}} File into a Template ===
     55=== Turning an Existing {{{trac.ini}}} File into a Template
    5656
    5757The last project shown in the templates listed by `paster create --list-templates`, [source:traclegosscript/anyrelease/traclegos/project.py trac_project], is a template designed to turn an existing [http://trac.edgewall.org/wiki/TracIni trac.ini] configuration file into a [source:traclegosscript/anyrelease/traclegos/project.py TracProject] template that can be used by TracLegosScript for project creation.  To turn an existing configuration `trac.ini` into a [source:traclegosscript/anyrelease/traclegos/project.py TracProject] template, run:
    … …  
    7777To customize the template, edit `yourproject/yourproject/template/conf/trac.ini`.  [http://pythonpaste.org/script PasteScript] template variables can be denoted and `pre` and `post` template writing setup can be done by customizing `yourproject/yourproject/project.py`.
    7878
    79 === Setup of [http://pythonpaste.org/webob/ WebOb] View for Project Creation ===
    80 
    81 !TracLegos includes a [http://pythonpaste.org paste] webapp that serves existing projects (delegating to trac) and also allows creating new projects.  In order to use this view, you must have at least one template installed, so first install the example template as described above.  Once the {{{topp_trac_template}}} (or any other template) is installed, you should be all set to run the webapp by running {{{paster serve development.ini}}} from the top-level directory of your copy of the !TracLegos source (source:traclegosscript/anyrelease/development.ini).
     79=== Setup of [http://pythonpaste.org/webob/ WebOb] View for Project Creation
     80
     81!TracLegos includes a [http://pythonpaste.org paste] webapp that serves existing projects (delegating to trac) and also allows creating new projects.  In order to use this view, you must have at least one template installed, so first install the example template as described above. Once the {{{topp_trac_template}}} (or any other template) is installed, you should be all set to run the webapp by running {{{paster serve development.ini}}} from the top-level directory of your copy of the !TracLegos source (source:traclegosscript/anyrelease/development.ini).
    8282
    8383Point your browser at http://127.0.0.1:8080 and you should be all set with a bare-bones web-based trac project creator.
    8484
    85 == Site Configuration ==
    86 
    87 !TracLegos is designed so that site-specific configuration does not need to (and really shouldn't) live in the templates but can live in its own {{{.ini}}} file.  The advantages of this is that templates from XYZcorp can be shared with ABCcorp without modification but that a policy for trac project creation can be effectively enforced as well as having the convenience of domain-specific variables by using a site configuration {{{.ini}}} file (or files). See TracLegosTemplates for a fuller explanation of how multiple templates can be used to factor out site-specific configuration.
    88 
    89 Variables are currently supported in a site configuration file.  See source:traclegosscript/anyrelease/example/site_example.ini for the format of this file.  Using the command line, site configuration {{{.ini}}} files are specified with the `-c` option:
     85== Configuration
     86
     87!TracLegos is designed so that site-specific configuration does not need to (and really shouldn't) live in the templates but can live in its own {{{.ini}}} file. The advantages of this is that templates from XYZcorp can be shared with ABCcorp without modification but that a policy for trac project creation can be effectively enforced as well as having the convenience of domain-specific variables by using a site configuration {{{.ini}}} file (or files). See TracLegosTemplates for a fuller explanation of how multiple templates can be used to factor out site-specific configuration.
     88
     89Variables are currently supported in a site configuration file. See source:traclegosscript/anyrelease/example/site_example.ini for the format of this file.  Using the command line, site configuration {{{.ini}}} files are specified with the `-c` option:
    9090
    9191{{{
    … …  
    9393}}}
    9494
    95 Configuration files may also be specified for the web front-end.  To use this, add the following option to the {{{.ini}}} file specified for `paster serve`:
     95Configuration files may also be specified for the web front-end. To use this, add the following option to the {{{.ini}}} file specified for `paster serve`:
    9696
    9797{{{
    … …  
    9999}}}
    100100
    101 
    102 == !TracLegos Components ==
    103 
    104 !TracLegos is designed to be maleably configurable and extensible.  Here are the components that make that possible:
    105 
    106  * TracLegosTemplates : the process by which !TracLegos transforms templates into trac projects
    107 
     101== !TracLegos Components
     102
     103!TracLegos is designed to be configurable and extensible. Here are the components that make that possible:
     104 * TracLegosTemplates : the process by which !TracLegos transforms templates into Trac projects
    108105 * TracLegosConfiguration : how to control what !TracLegos does
    109106
    110 == Examples ==
    111 
    112 === Example of through the web project creation === 
     107== Examples
     108
     109=== Example of through the web project creation
     110
    113111The index of the project additionally has a '''Create Project''' link:
    114112
    … …  
    129127After completion, the project is created and you are redirected to it.
    130128
    131 === Example of command line usage ===
     129=== Example of command line usage
    132130
    133131{{{
    … …  
    162160}}}
    163161
    164 === Example of turning an existing project into a pastescript template ===
     162=== Example of turning an existing project into a paste-script template
    165163
    166164{{{
    … …  
    195193}}}
    196194
    197 == Similar Software ==
    198 
    199 ''I haven't investigated these, but they are noted for similarity to some aspects of [TracLegosScript TracLegos]''
    200 
    201  * AdminToolkitScript
    202 
    203 == Recent Changes ==
     195== Recent Changes
    204196
    205197[[ChangeLog(traclegosscript, 3)]]
    206198
    207 == Author/Contributors ==
     199== Author/Contributors
    208200
    209201''Originally developed at [http://topp.openplans.org The Open Planning Project]''
    210202
    211203'''Author:''' [wiki:k0s] [[BR]]
    212 '''Maintainer:''' ejucovy [[BR]]
     204'''Maintainer:''' [[Maintainer]] [[BR]]
    213205'''Contributors:'''