Changes between Version 117 and Version 118 of TestManagerForTracPlugin


Ignore:
Timestamp:
Jun 20, 2015, 9:40:59 AM (9 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • TestManagerForTracPlugin

    v117 v118  
    99This plugin implements a full test management life-cycle: definition, planning, execution, statistics.
    1010
    11 This test management Trac plugin can be used to create '''[wiki:TestManagerForTracPlugin#TestCases Test Cases]''', organize them in [wiki:TestManagerForTracPlugin#TestCatalogs Catalogs] and generate '''[wiki:TestManagerForTracPlugin#TestPlans Test Plans]''' to track their execution status and outcome.
     11This plugin can be used to create '''[wiki:TestManagerForTracPlugin#TestCases Test Cases]''', organize them in [wiki:TestManagerForTracPlugin#TestCatalogs Catalogs] and generate '''[wiki:TestManagerForTracPlugin#TestPlans Test Plans]''' to track their execution status and outcome.
    1212
    1313This plugin uses Wiki pages and an additional data model to store Test Cases, rather than tickets. This allows you to separate your tickets from your test findings, while still being powered by the Trac search engine and formatting syntax for Wiki pages.
    … …  
    1515A set of plugins intercept requests for Wiki pages that match the Test Manager URL namespace and decorate them with additional information stored in the database.
    1616
    17 [[Image(Carousel.png, link=)]]
     17[[Image(Carousel.png)]]
    1818
    1919Key features:
    … …  
    2727 * '''One-click changing status of a test case''', ie marking a test case in a particular test plan as successful or failed.
    2828 * '''Ticket integration''': opening tickets directly from a (usually failed) test case, keeping track of the relationship. Navigating from a test case to its related tickets and vice-versa.
    29  * Test cases, catalogs and plans can have their own '''custom properties''', defined in trac.ini like tickets. All property types are supported: text, text area, listbox, radio buttons, checkbox.
     29 * Test cases, catalogs and plans can have their own '''custom properties''', defined in `trac.ini` like tickets. All property types are supported: text, text area, listbox, radio buttons, checkbox.
    3030 * Defining '''custom test outcomes (statuses)''', in addition to the built-in "Untested", "Success", "Failed".
    3131 * Test execution '''statistical charts''', showing the overall testing activity, status of the test plans, statistics on the tickets opened agains all or a specific test plan. '''Exporting the data to CSV'''.
    … …  
    5555 * A generic, customizable '''[wiki:TestManagerForTracPluginWorkflow Workflow Engine]''' is provided as a separate plugin in the package, which allows you to associate custom workflows to any Resource in Trac, including Wiki pages and any custom object handled through a Resource Manager. This can be done easily by adding [wiki:TestManagerForTracPluginWorkflow a few lines of code] to the component which manages the User interface.
    5656
    57  * All the data manipulation layer has been extracted into a '''[wiki:TestManagerForTracPluginGenericClass Generic Persistent Class framework]''' plugin, which can be easily used by any other plugin developer to provide persistence, security, change history, custom properties, pattern matching search, and other features to their basic data model with a handful lines of code.
    58 
    59  * All of the test objects, ie catalogs, test cases, test plans and test cases in a plan (i.e. with a status and a status change history), support:
     57 * The data manipulation layer has been extracted into a '''[wiki:TestManagerForTracPluginGenericClass Generic Persistent Class framework]''' plugin, which can be easily used by any other plugin to provide persistence, security, change history, custom properties, pattern matching search, and other features to their basic data model with a handful lines of code.
     58
     59 * The test objects, ie catalogs, test cases, test plans and test cases in a plan (i.e. with a status and a status change history), support:
    6060   * '''[#Customfields Custom properties]''', which can be declared in the `trac.ini` file and will be available to the User for change, stored in the database and available to change listeners.
    6161   * Property and status change history.
    … …  
    6666   * Workflow states also support custom properties, so to be able to convey additional context information on a workflow state and use it in listeners or directly from the database.
    6767
    68  * The developed workflow engine is able to work on any Trac resource, it is not confined to this plugin. You can then define a workflow on any Trac resource, including Wiki pages, declaratively in the `trac.ini` file. You then add a handful of custom code (for example in an ITemplateStreamFilter) to add the markup that the workflow engine generates for you to your desired Trac web page. See [wiki:TestManagerForTracPluginWorkflow#Extendworkflowsupporttoanyofyourartifacts this page] for further details.
     68 * The developed workflow engine is able to work on any Trac resource, it is not confined to this plugin. You can then define a workflow on any Trac resource, including Wiki pages, declaratively in the `trac.ini` file. You then add a handful of custom code (for example in an ITemplateStreamFilter) to add the markup that the workflow engine generates for you to your desired Trac web page. See [wiki:TestManagerForTracPluginWorkflow#Extendworkflowsupporttoanyofyourartefacts this page] for further details.
    6969
    7070For an [#Tutorialaspowerpointpresentation overview] of this plugin's capabilities, see this [http://www.youtube.com/watch?v=BIi3QMT0rT4 video].
    … …  
    7676They are implemented as wiki pages, with a naming convention that allows the plugin code to recognize them and treat them appropriately, and with a set of auxiliary database tables. This provides out-of the box support for rich text formatting (using Wiki syntax), attachments and versioning.
    7777
    78 This also means that the `WIKI_VIEW`, in addition to the `TEST_WIEW`, permission is required to be able to browse test catalogs and test cases.
     78This also means that the `WIKI_VIEW`, in addition to the `TEST_VIEW`, permission is required to be able to browse test catalogs and test cases.
    7979
    8080You can '''choose between a tree-like and a tabular representation''' of the catalog and all of its sub-catalogs and test cases, as shown in the following figures.
    … …  
    8585
    8686 * Some '''breadcrumbs''', to easily locate where the current catalog is and to navigate up in the catalogs tree.
    87  * '''Switch to Tabular View''' / '''Switch to Tree View''' icons. Use these icons to switch between the tree vew and the tabular view. The former is useful to actually work on the Test Catalog, adding sub-catalogs and new test cases, or modifying them. The latter, which also reports a printout of all the Test Case descriptions, may be useful for a Test Engineer to save or print as a handout to actually run the test cases in the catalog. This is particularly true for [#TestPlans Test Plans]. The tabular view is also the only one to show all of the [#Customfields Custom Fields] you may have added to the catalogs, plans or test cases.
     87 * '''Switch to Tabular View''' / '''Switch to Tree View''' icons. Use these icons to switch between the tree view and the tabular view. The former is useful to actually work on the Test Catalog, adding sub-catalogs and new test cases, or modifying them. The latter, which also reports a printout of all the Test Case descriptions, may be useful for a Test Engineer to save or print as a handout to actually run the test cases in the catalog. This is particularly true for [#TestPlans Test Plans]. The tabular view is also the only one to show all of the [#Customfields Custom Fields] you may have added to the catalogs, plans or test cases.
    8888 * The catalog's '''Title'''. This is the text you have entered in the parent catalog's '''New Sub-Catalog''' text field when you created this catalog.
    8989 * '''Filter''' text box. Type inside the text box to filter all sub-catalogs and test cases matching your input text. See [#SearchingandfilteringTestCases Searching and filtering Test Cases] for details.
    … …  
    102102 * '''Organize Test Catalogs''' button. It will display a dialog box where you can, using simple drag and drop, reorganize the test cases in this catalog and sub-catalogs. See [#OrganizingthecontentsofaTestCatalog Organizing the contents of a Test Catalog] for details.
    103103 * '''Available Test Plans''' section. The number in brackets shows the number of [#TestPlans Test Plans] that have been generated for this catalog. Expand the section to access detailed test plan information and to navigate to the individual test plans. Type inside the text box to filter all test plan information matching your input text.
    104  * '''Object Change History''' section. In addition to the standard Wiki versioning, test objects support their own change history, which lets you inspect who changed which property and when, also showing its old and new value. This is also particularly useful for [#Customfields Custom Fields] you may add to the test objects. See [#TestArtifactChangeHistory Test Artefact Change History] for more details.
     104 * '''Object Change History''' section. In addition to the standard Wiki versioning, test objects support their own change history, which lets you inspect who changed which property and when, also showing its old and new value. This is also particularly useful for [#Customfields Custom Fields] you may add to the test objects. See [#TestArtefactChangeHistory Test Artefact Change History] for more details.
    105105 * '''Edit this page''' button. If you wish to edit the title of the catalog or add some textual contents to it, click on this button to enter the Wiki page editing mode. Be careful that the first line is always interpreted as the test catalog title. You can then add the Test Catalog description just below it, using WikiFormatting, adding attachments and everything else is supported for Wiki pages. When you're done, simply save the page with '''Submit Changes''' to save your textual changes to the catalog.
    106  * '''Attach File''' button. Use this button to attach files to the Catalog page.
     106 * '''Attach File''' button. Attach files to the Catalog page.
    107107 * '''Rename page''' button. This function is '''not allowed''' for Test Catalogs, Test Cases or Test Plans. This because the Test Manager plugin uses the page names to keep track of the test artefacts hierarchy information. Submitting a new page name will then throw you a meaningful error. '''To change the Catalog's title''', use the '''Edit this page''' button and change the first text line. It is interpreted as the catalog title. If you '''wish to move '''the object elsewhere, instead, use the 'move' Test Manager functions.
    108108 * '''Delete this version''' button. It will delete the current Test Catalog's '''description Wiki page''', and revert to the last one. This action will have no effect on the changes you may have done to the sub-catalogs or test cases contained therein. To undo changes to the Wiki pages of any of these latter objects, go to the corresponding page and work with the Wiki versions accordingly. As long as the Test Catalog internal organization in sub-catalogs and Test Case, Test Manager does not have a "Test Catalog snapshot" kind of functionality, which you may revert to.
    … …  
    136136They are implemented again as wiki pages, with a naming convention that allows the plugin code to recognize them and treat them appropriately, and with a set of auxiliary database tables. This provides out-of the box support for rich text formatting (using Wiki syntax), attachments and versioning.
    137137
    138 To add Test Cases into a Test Catalog, open the catalog, go to the bottom of the page and enter a name for the new Test Case to be created into the appropriate text box (blanks, special characters and case are supported). Then click the button '''Add a Test Case'''. A new wiki page is generated, with a naming convention allowing the plugin code to position it correctly in the catalogs tree, and opened for editing. '''Be careful''' that the first line (the one surrounded by '==') will always be taken as the title of the Test Case, so do not remove this line. You can edit this line to change the test case title, anyway, at any time.
     138To add Test Cases into a Test Catalog, open the catalog, go to the bottom of the page and enter a name for the new Test Case to be created into the appropriate text box (blanks, special characters and case are supported). Then click the button '''Add a Test Case'''. A new wiki page is generated, with a naming convention allowing the plugin code to position it correctly in the catalogs tree, and opened for editing. '''Be careful''' that the first line (the one starting with '== ') will always be taken as the title of the Test Case, so do not remove this line. You can edit this line to change the test case title, anyway, at any time.
    139139
    140140You can then add the Test Case description just below the first line, ie the title, using WikiFormatting, adding attachments and everything else is supported for Wiki pages.
    … …  
    159159 * '''Duplicate the Test Case''' button. Only available on Test Case definitions. Lets you make an exact copy of this Test Case definition. Note that the test execution statuses, ie successful, failed, etc, associated to the original Test Cases in any Test Plan are not duplicated along with the Test Case definition.
    160160 * '''Add to a Test Plan''' button. Only available on Test Case definitions. Allows you to add the Test Case to one or more suitable Test Plans, i.e. Test Plans that have been defined as not containing all the test cases (current and future) of the associated Test Catalog, but only a selected set of them.
    161  * '''Object Change History''' section. In addition to the standard Wiki versioning, test objects support their own change history, which lets you inspect who changes which property and when, also showing its old and new value. This is also particularly useful for [#Customfields Custom Fields] you may add to the test objects. See [#TestArtifactChangeHistory Test Artefact Change History] for more details.
    162  * '''Edit this page''' button. If you wish to edit the title of the Test Case or edite the textual contents of it, click on this button to enter the Wiki page editing mode. When you're done, simply save the page with '''Submit Changes''' to save your textual changes to the test case. '''Be careful''' that the first line is always interpreted as the test case title.
    163  * '''Attach File''' button. Use this button to attach files to the Test Case page.
     161 * '''Object Change History''' section. In addition to the standard Wiki versioning, test objects support their own change history, which lets you inspect who changes which property and when, also showing its old and new value. This is also particularly useful for [#Customfields Custom Fields] you may add to the test objects. See [#TestArtefactChangeHistory Test Artefact Change History] for more details.
     162 * '''Edit this page''' button. If you wish to edit the title of the Test Case or its contents, click on this button to enter the Wiki page editing mode. When you're done, simply save the page with '''Submit Changes''' to save your changes to the test case. '''Be careful''' that the first line is always interpreted as the test case title.
     163 * '''Attach File''' button. Attach files to the Test Case page.
    164164 * '''Rename page''' button. This function is '''not allowed''' for Test Catalogs, Test Cases or Test Plans. This because the Test Manager plugin uses the page names to keep track of the test artefacts hierarchy information. Submitting a new page name will then throw you a meaningful error. '''To change the Test Case's title''', use the '''Edit this page''' button and change the first text line. It is interpreted as the test case title. If you wish to move the object elsewhere, instead, use the 'move' Test Manager functions.
    165165 * '''Delete this version''' button. It will delete the current Test Case's '''description Wiki page''', and revert to the last one.
    … …  
    192192As with Test Catalogs, you can '''choose between tree and a tabular representation''' of the Test Plan, as shown in the figures below.
    193193
    194  * The former is useful to actually work on the Test Plan and to view test cases before actually going and executing them. It also gives you a bird-eye view of the test execution progress and results. Additionally, you can set a test case verdict directly form the tree view, left-clicking on any Test Case's traffic light and changing its color using the pop-up menu that comes out.
    195  * The latter, which indicates for each Test Case the latest status modification and its author, may be useful to keep as the documentation of a just run test plan. It is also the only way to display the Test Case in a Plan [#Customfields Custom Fields] you may have set. Additionally, you can set a test case verdict directly form the table view, left-clicking on any Test Case's traffic light and changing its color using the pop-up menu that appears.
     194 * The former is useful to work on the Test Plan and to view test cases before executing them. It also gives you a bird-eye view of the test execution progress and results. Additionally, you can set a test case verdict directly form the tree view, left-clicking on any Test Case's traffic light and changing its color using the pop-up menu that appears.
     195 * The latter, which indicates for each Test Case the latest status modification and its author, may be useful to keep as the documentation of a just run test plan. It is also the only way to display the Test Case in a Plan [#Customfields Custom Fields] you may have set. Additionally, you can set a test case verdict directly from the table view, left-clicking on any Test Case's traffic light and changing its color using the pop-up menu that appears.
    196196
    197197On a Test Plan page, from the top down, you have:
    … …  
    204204 * '''Expand All''' and '''Collapse All'''. In tree view mode, use these links to expand or collapse all the tree nodes.
    205205 * '''Sub-catalogs and Test Cases'''.
    206    * A traffic light icon on a sub-catalog indicates the '''worse outcome''' of all the contained test cases. Red is considered worse than yellow, which is considered worse than green.
     206   * A traffic light icon on a sub-catalog indicates the '''severity of the outcome''' of the test cases. Red is considered worse than yellow, which is considered worse than green.
    207207   * You can '''browse''' each sub-catalog and '''Test Case instance''' by following the corresponding link.
    208208   * Hovering on a Test Case, a pencil icon will appear on the right. Click on it to go to the '''Test Case definition''' directly into '''Edit''' mode. Refer to [#TestCases Test Cases] for an explanation of the difference between Test Case definition and instance.
    … …  
    211211 * '''Export Test Plan''' button. Allows you to export the Test Plan to CSV format. See [#ExportingTestCatalogsorTestPlansintoCSVfile Custom Test Case Outcomes (i.e. states, verdicts)] for details.
    212212 * '''Clone Test Plan''' button. This button will open a dialog where you can specify a name for the cloned Test Plan. The cloned Test Plan will inherit all the characteristics of the original one, but the contained Test Cases will '''all be reset to Untested''', and their test status change history emptied.
    213  * '''Object Change History''' section. In addition to the standard Wiki versioning, test objects support their own change history, which lets you inspect who changes which property and when, also showing its old and new value. This is also particularly useful for [#Customfields Custom Fields] you may add to the test objects. See [#TestArtifactChangeHistory Test Artefact Change History] for more details.
     213 * '''Object Change History''' section. In addition to the standard Wiki versioning, test objects support their own change history, which lets you inspect who changes which property and when, also showing its old and new value. This is also particularly useful for [#Customfields Custom Fields] you may add to the test objects. See [#TestArtefactChangeHistory Test Artefact Change History] for more details.
    214214 * '''Edit this page''' button. This button allows you to edit the Wiki page that contains '''the associated Test Catalog description'''. A Test Plan does not have itself a specific Wiki page. If you need to record specific Test Plan information, you may want to use a [#Customfields Custom Field], possibly of type textarea. Refer to [#TestCatalogs Test Catalogs] for details about editing their descriptions.
    215  * '''Attach File''' button. Use this button to attach files to the associated Test Catalog wiki page. There is currently no way to attach files to a specific Test Plan.
     215 * '''Attach File''' button. Attach files to the associated Test Catalog wiki page. There is currently no way to attach files to a specific Test Plan.
    216216 * '''Rename page''' button. This function is '''not allowed''' for Test Catalogs, Test Cases or Test Plans. This because the Test Manager plugin uses the page names to keep track of the test artefacts hierarchy information. Submitting a new page name will then throw you a meaningful error.
    217217 * '''Delete this version''' button. It will delete the associated Test Catalog's description Wiki page, and revert to the last one.
    218218 * '''Delete page''' button. Pushing this button will ask you for confirmation and, if confirmed, will delete the associated Test Catalog. Refer to [#TestCatalogs Test Catalogs] for details about what will be actually deleted. '''Caution''': there is no undo functionality.
    219219
    220 You have two ways of setting the execution outcome of a Test Case in a particular Test Plan (see figures below):
     220You have two ways of setting the outcome of a Test Case in a particular Test Plan (see figures below):
    221221
    222222 1. Directly from the test plan tree or tabular view, by clicking on the traffic-light icon and choosing the new color from the menu that opens. Since 1.4.7.
    … …  
    232232It is also possible to move one or more Test Cases into a different catalog, with an experience similar to cut&paste.
    233233
    234 As an alternative, it is also possible to ![OrganizingthecontentsofaTestCatalog graphically organize the contents of a Test Catalog] using drag&drop.
     234As an alternative, it is also possible to [#OrganizingthecontentsofaTestCatalog graphically organize the contents of a Test Catalog] using drag&drop.
    235235
    236236=== Moving a single Test Case
    … …  
    241241 1. Click on the "Move the Test Case into another catalog" button. This is similar to a "cut" operation, but into a "virtual" clipboard.
    242242 1. Navigate and open the destination catalog.
    243  1. Click on "Move the copied Test Case here" button (which only appears if a Test Case has been cut first).
     243 1. Click on "Move the copied Test Case here" button, which only appears if a Test Case has been cut first.
    244244
    245245It is also possible to cancel the operation at any time by clicking the "Cancel" button in the yellow message at the top of the page.
    … …  
    254254 1. Click on the "Copy the Selected Test Cases" button. This is similar to the usual "Copy" operation, but into a "virtual" clipboard.
    255255 1. Navigate and open the destination catalog, or create a new one.
    256  1. Click on "Paste the copied Test Cases here" button (which only appears if Test Cases have been copied first).
     256 1. Click on "Paste the copied Test Cases here" button, which only appears if Test Cases have been copied first.
    257257
    258258Note that the test execution statuses, ie successful, failed, etc, associated with the original Test Cases in any Test Plan are not copied along with the Test Case definitions.
    … …  
    280280The association is particularly useful when browsing the [#TestManagementandExecutionStatistics Test Management and Execution Statistics].
    281281
    282 You can specify a set of properties to control the contants of the new ticket's summary. In the {{{[testmanager]}}} section of the `trac.ini` file:
     282You can specify a set of properties to control the contents of the new ticket's summary. In the {{{[testmanager]}}} section of the `trac.ini` file:
    283283
    284284    ticket_summary_option: How to generate the ticket summary. Available options are:
    … …  
    365365The data can be exported to Excel (CSV format) by means of the links at the bottom of each chart.
    366366
    367 If you select a specific period of time and a specific test plan, you can save the settings by saving (in the favorites, bookmarks, etc.) the URL displayed at the bottom of each chart.
     367If you select a specific period of time and a specific test plan, you can save the settings by bookmarking the URL displayed at the bottom of each chart.
    368368
    369369There are three charts available:
    … …  
    401401You can customize the default period of time the charts will display, in terms of historical depth and scale.
    402402
    403 To change the settings, go to the [#TestManagerSettings Test Manager Settings] administration panel, or directly edit the trac.ini file.
     403To change the settings, go to the [#TestManagerSettings Test Manager Settings] administration panel, or directly edit the `trac.ini` file.
    404404
    405405== Importing and Exporting
    … …  
    439439In the Test Catalog and Test Plan pages you will find an "Export..." button.
    440440
    441 The export format is designed for you to elaborate your external statistics, but also to eventually import the stuff back into another Test Manager plugin evironment, as soon as a compatible import feature will be implemented :D (the current import feature is simpler than that).
     441The export format enables a drill down into your external statistics, but also to eventually import them back into another Test Manager plugin environment.
    442442
    443443Inside the export dialog shown in the next figure, you can specify whether the output should contain the complete text of the Test Cases, and whether this should be pre-formatted (WYSIWYG) or in raw WikiFormatting syntax.
    … …  
    449449'''The Export Test Catalog dialog'''[[BR]]
    450450
    451 == Test Artifact Change History
     451== Test Artefact Change History
    452452
    453453'''Since: 1.4.8'''
    … …  
    455455On each test artefact page you will find a section named "Object change history", which contains a list of all the changes to any standard and, more interestingly, custom object's property.
    456456
    457 In the following figure you can see how the "device" custom property has been changed in a Test Plan history.
     457In the following figure you can see how the "device" custom property has been changed in a Test Plan history:
    458458
    459459[[BR]][[BR]][[Image(ObjectChangeHistory01.png_th.png, link=[wiki:TestManagerForTracPluginGallery#ObjectchangehistoryforaTestPlan])]]
    … …  
    469469 * Defining [#CustomTestCaseOutcomesi.e.statesverdicts Custom Test Case Outcomes (i.e. states, verdicts)] to fit your quality process.
    470470 * Adding a [#CustomizableWorkflow Workflow] to any of your test artefacts. For example, you may want to have an approval workflow for new test case definitions, or be able to assign test plans or individual cases to specific test engineers to be run, and manage their completion status.
    471  * Adding [#TestArtifactTemplates Test Artefact Templates] for Test Catalogs and Test Cases, and specifying which default template should be used for new test cases in any particular catalog.
     471 * Adding [#TestArtefactTemplates Test Artefact Templates] for Test Catalogs and Test Cases, and specifying which default template should be used for new test cases in any particular catalog.
    472472
    473473In addition to these, you can personalize several aspects of the Test Manager behavior, by means of the [#TestManagerSettings Test Manager Settings] administration panel.
    … …  
    477477'''Since: 1.2.0'''
    478478
    479 Custom fields can be added to the four test objects and to the [wiki:TestManagerForTracPluginWorkflow workflow] state object, by declaring them in the trac.ini file.
     479Custom fields can be added to the four test objects and to the [wiki:TestManagerForTracPluginWorkflow workflow] state object, by declaring them in the `trac.ini` file.
    480480
    481481The syntax is the same used for custom Ticket properties, only the name of the `trac.ini` file sections are specific: you must use the test artefact type name followed by "-tm_custom".
    … …  
    522522}}}
    523523
    524 Once defined in the trac.ini file as above, custom fields will be available to the User for browse and for editing in the Web page, as shown next.
    525 
    526 '''Note''': Editing custom properties requires the TEST_MODIFY permission.
     524Once defined in the `trac.ini` file as above, custom fields will be available to the User for browse and for editing in the Web page, as shown next.
     525
     526'''Note''': Editing custom properties requires the `TEST_MODIFY` permission.
    527527
    528528The following screenshot shows a custom "platform" field added to the Test Case artefact, and how it is presented to the User for editing.
    529529
    530 The value is initially displayed read-only, as a label. Clicking on the pencil icon turns the label into an text field, allowing the User to edit the value, and also displays a '''Save''' button. Clicking the button immediately saves the new value into the database.
     530The value is initially displayed read-only, as a label. Clicking on the pencil icon turns the label into an text field, allowing the User to edit the value, and also displays a '''Save''' button. Clicking the button saves the new value into the database.
    531531
    532532[[BR]] [[BR]] [[Image(CustomFields01.png_th.png, link=[wiki:TestManagerForTracPluginGallery#EditingacustomOperatingSystempropertyonaTestcaseinaPlan])]]
    … …  
    540540You can customize the Test Case outcomes (i.e. states, verdicts) to match your internal quality process.
    541541
    542 The default outcomes are configured in trac.ini at plugin installation (or upgrade) time as follows:
     542The default outcomes are configured in `trac.ini` at plugin installation (or upgrade) time as follows:
    543543
    544544{{{#!ini
    … …  
    552552You can '''customize the outcomes''' at any moment by adding new outcomes, or modify the descriptions of the current ones. Do not delete previous outcomes if you have already assigned them to any of your test cases.
    553553
    554 For example, to add a new outcome named "It's a Mess!!!" to the failures, add a line like the following, in trac.ini:
     554For example, to add a new outcome named "It's a Mess!!!" to the failures, add a line like the following in `trac.ini`:
    555555
    556556{{{#!ini
    … …  
    572572Every object which has a workflow defined is created in a "new" state, so every transition should consider this as the first state in the state machine.
    573573
    574 This is a sample content of the trac.ini file to associate a workflow to the Test Case object:
     574This is a sample content of the `trac.ini` file to associate a workflow to the Test Case object:
    575575
    576576{{{#!ini
    … …  
    596596'''A custom workflow applied to Test Cases in a Plan'''[[BR]] [[BR]]
    597597
    598 === Test Artifact Templates
     598=== Test Artefact Templates
    599599
    600600Your quality process may require your test catalogs and test cases to follow particular templates. With the Test Manager, you can define templates for your test catalogs and your test cases. When you create a new test catalog or test case, their description will be filled with the templates you have defined.
    … …  
    650650=== Test Manager Settings
    651651
    652 Several aspects of the Test Manager operations are for you to personalize. To do this, you can either use the '''Test Manager''' administration panel, or directly edit the trac.ini file.
     652Several aspects of the Test Manager operations are for you to personalize. To do this, you can either use the '''Test Manager''' administration panel, or directly edit the `trac.ini` file.
    653653
    654654The following paragraphs outline the administration panel sections.
    … …  
    671671{{{#!ini
    672672[testmanager]
    673 default_days_back = <number of days back from today>
    674 default_interval = <number of days between samples>
    675 }}}
    676 
    677 For example:
    678 
    679 {{{#!ini
    680 [testmanager]
     673; number of days back from today
    681674default_days_back = 14
     675; number of days between samples
    682676default_interval = 1
    683677}}}
    … …  
    691685   * Name: Sorts the test cases by title.
    692686   * Modification Time: Sorts the test cases by modification time, with the most recent on top.
    693  * Open Test Cases in a new window: Determines whether, from a test catalog or test  plan view, clicking on a test case will display it in a new window or in the same window.
     687 * Open Test Cases in a new window: Determines whether, from a test catalog or test plan view, clicking on a test case will display it in a new window or in the same window.
    694688 * Default Test Catalog view type: Determines whether the default view for test catalogs should be Tree or Table.
    695689 * Default Test Plan view type: Determines whether the default view for test plans should be Tree or Table.
    … …  
    721715 * SQL_RUN - Ability to run arbitrary queries and statements on the Trac database. The SQLExecutor plugin shipped with the Test Manager provides this feature.
    722716
    723 == Programmatic API
    724 
    725 The '''programmatic RESTful API''' is documented in more detail in TestManagerForTracPluginApi.
    726 
    727717== Tutorial
    728718
    729 '''TODO:''' These tutorials document release 1.0.3 and so need to be updated with the Test Plan and other recent features. Refer to the '''[http://www.youtube.com/watch?v=BIi3QMT0rT4 video tutorial on Youtube]''' for more up-to-date information.
     719These tutorials document release 1.0.3 and so need to be updated with the Test Plan and other recent features. Refer to the '''[http://www.youtube.com/watch?v=BIi3QMT0rT4 video tutorial on Youtube]''' for more up-to-date information.
    730720
    731721 * attachment:"UserGuide_part_1.ppt"
    … …  
    737727Project site: http://sourceforge.net/projects/testman4trac/
    738728
    739 The project is also on Pypi: http://pypi.python.org/pypi/TestManager
     729The project is also on pypi:TestManager
    740730
    741731== Translations
    … …  
    778768 1. Test Manager
    779769
    780 An additional plugin is very useful for debugging, but has been proved very handy also in a production environment to fix problems with the Trac data. It provides the ability to run '''arbitrary SQL''' queries or statements on the Trac database from your web browser (including creating, modifying and dropping tables!).
     770An additional plugin is very useful for debugging, but also Trac data analysis and troubleshooting. It provides the ability to run '''arbitrary SQL''' queries or statements on the Trac database from your web browser (including creating, modifying and dropping tables!).
    781771
    782772 4. SQL Executor
    … …  
    807797'''Did you get the correct version of the Python egg?'''
    808798
    809 Python eggs have the Python version encoded in their filename. For example, `TestManager-1.0.0-py2.7.egg` is an egg for Python 2.7, and will not be loaded if you're running a different Python version, such as 2.5 or 2.6.
     799Python eggs have the Python version in their filename. For example, `TestManager-1.0.0-py2.7.egg` is an egg for Python 2.7, and will not be loaded if you're running a different Python version, such as 2.5 or 2.6.
    810800
    811801Also, verify that the egg file you downloaded is indeed a ZIP archive and not the HTML preview page instead.
    … …  
    813803'''Is the plugin enabled?'''
    814804
    815 If you install a plugin globally, ie not inside the plugins directory of the Trac project environment, you will have to explicitly enable it in trac.ini. Make sure that:
     805If you install a plugin globally, ie not inside the plugins directory of the Trac project environment, you will have to explicitly enable it in `trac.ini`. Make sure that:
    816806
    817807 * you actually added the necessary lines to the [components] section:
    … …  
    825815 * the value is "enabled", not "enable"
    826816
    827 '''Check the permissions on the egg file and on the trac.ini file'''
     817'''Check the permissions on the egg file and on the `trac.ini` file'''
    828818
    829819The user user to run Trac (either tracd or Apache) must be able to read the egg files.
    … …  
    845835If you put your plugins inside plugins directories, and certainly if you have more than one project, you need to make sure that the correct version of the plugin is loading. Here are some basic rules:
    846836
    847 Only one version of the plugin can be loaded for each running Trac server (ie each Python process). The Python namespaces and module list will be shared, and it cannot handle duplicates. Whether a plugin is enabled or disabled makes no difference.
    848 
    849 A globally installed plugin, typically setup.py install, will override any version in global or project plugins directories. A plugin from the global plugins directory will be located before any project plugins directory.
    850 
    851 '''If your Trac server hosts more than one project''' (as with TRAC_ENV_PARENT_DIR setups), then having two versions of a plugin in two different projects will give uncertain results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first found - basically from the project that receives the first request.
    852 
    853 Having more than one version listed inside Python site-packages is fine, ie installed with `setup.py` install, as setuptools will make sure you get the version installed most recently. However, '''don't store more than one version inside a global or project plugins directory''': neither version number nor installed date will matter. There is no way to determine which one will be located first when Trac searches the directory for plugins.
     837 * Only one version of the plugin can be loaded for each running Trac server (ie each Python process). The Python namespaces and module list will be shared, and it cannot handle duplicates. Whether a plugin is enabled or disabled makes no difference.
     838
     839 * A globally installed plugin, typically setup.py install, will override any version in global or project plugins directories. A plugin from the global plugins directory will be located before any project plugins directory.
     840
     841 * '''If your Trac server hosts more than one project''' (as with TRAC_ENV_PARENT_DIR setups), then having two versions of a plugin in two different projects will give uncertain results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first found - basically from the project that receives the first request.
     842
     843 * Having more than one version listed inside Python site-packages is fine, ie installed with `setup.py` install, as setuptools will make sure you get the version installed most recently. However, '''don't store more than one version inside a global or project plugins directory''': neither version number nor installed date will matter. There is no way to determine which one will be located first when Trac searches the directory for plugins.
    854844
    855845'''Have you restarted Apache?'''
    … …  
    859849'''If all of the above failed'''
    860850
    861 OK, so the logs don't mention these plugins, the egg is readable, the python version is correct and the egg has been installed globally (and is enabled in the trac.ini file), you restarted Apache and it still doesn't work or give any error messages or any other indication as to why?
     851OK, so the logs don't mention these plugins, the egg is readable, the Python version is correct and the egg has been installed globally (and is enabled in the `trac.ini` file), you restarted Apache and it still doesn't work or give any error messages or any other indication as to why?
    862852
    863853Open a ticket here. The plugins maintainers watch ticket notifications continuously.