forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ross Gardler (JIRA)" <j...@apache.org>
Subject [jira] Issue Comment Edited: (FOR-734) Document new forrest.properties.xml file
Date Sat, 05 Jul 2008 20:40:31 GMT

    [ https://issues.apache.org/jira/browse/FOR-734?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12358266#action_12358266
] 

rgardler edited comment on FOR-734 at 7/5/08 1:39 PM:
----------------------------------------------------------

Naming Convention
================

The naming convention for properties is as follows:

COMPONENT.PROPERTY[.TYPE]

where:

COMPONENT is one of:

- 'core' for a core property exposed by Forrest
- the name of a project that exposes the property
- the name of the plugin that exposes the property (when it is a plugin it shoudl be of the
form output.pdf or input.html or similar)

PROPERTY is a human readable name for the property

TYPE is an optional indicator of the type of property value. It does not restrict the values
the property can accept and is only intended as an aid to the humans reading the property
name.

      was (Author: rgardler):
    Naming Convention
================

The naming convention for properties is as follows:

COMPONENT.PROPERTY[.TYPE]

where:

COMPONENT is one of:

- 'core' for a core property exposed by Forrest
- the name of a project that exposes the property
- the name of the plugin that exposes the property

PROPERTY is a human readable name for the property

TYPE is an optional indicator of the type of property value. It does not restrict the values
the property can accept and is only intended as an aid to the humans reading the property
name.
  
> Document new forrest.properties.xml file
> ----------------------------------------
>
>                 Key: FOR-734
>                 URL: https://issues.apache.org/jira/browse/FOR-734
>             Project: Forrest
>          Issue Type: Sub-task
>          Components: Core operations, Documentation and website
>    Affects Versions: 0.8
>            Reporter: Ross Gardler
>            Priority: Minor
>
> Documentation for this issue should include:
> - details gleaned from FOR-588
> - an entry in status.xml
> - notes in plugins docs

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message