[xwiki-devs] [Proposal] Configuration keys for Macro Categories
Hi, After a discussion with Thomas we'd like to propose the following format for defining macro categories in xwiki.properties: rendering.macroCategories = <macro id>=<cateogory name> Ex: rendering.macroCategories = toc:presentation rendering.macroCategories = velocity=code Internally the config will be available from RenderingConfiguration: public interface RenderingConfiguration { /** * A link label format is the format used to decide how to display links that have no label. * By default the page name is displayed. However it's possible to customize it using the * following tokens: * <ul> * <li><strong>%w</strong>: wiki name</li> * <li><strong>%s</strong>: space name</li> * <li><strong>%p</strong>: page name</li> * <li><strong>%P</strong>: page name with spaces between camel case words, i.e. "My Page" * if the page name is "MyPage"</li> * <li><strong>%t</strong>: page title</li> * </ul> * Note that if the page title is empty or not defined then it defaults to %p. This is also the case * if the title cannot be retrieved for the document. * * The default is "%p". Some examples: "%s.%p", "%w:%s.%p". * * @return the format to use to display link labels when the user hasn't specified a label */ String getLinkLabelFormat(); /** * @return the category names to use for the macros. These are the categories under which they'll be listed * in UIs for example. If a category for a macro is null then the category defined in the macro * descriptor (ie defined by the macro author) will be used */ Properties getMacroCategories(); WDYT? If no negative comments are given I'd like to implement this ASAP. Thanks -Vincent
On Sat, Aug 8, 2009 at 21:25, Vincent Massol<[email protected]> wrote:
Hi,
After a discussion with Thomas we'd like to propose the following format for defining macro categories in xwiki.properties:
rendering.macroCategories = <macro id>=<cateogory name>
Ex:
rendering.macroCategories = toc:presentation rendering.macroCategories = velocity=code
Note that this is the standard way of defining a Properties value in Commons Configuration. It does not come form nowhere ;)
Internally the config will be available from RenderingConfiguration:
public interface RenderingConfiguration { /** * A link label format is the format used to decide how to display links that have no label. * By default the page name is displayed. However it's possible to customize it using the * following tokens: * <ul> * <li><strong>%w</strong>: wiki name</li> * <li><strong>%s</strong>: space name</li> * <li><strong>%p</strong>: page name</li> * <li><strong>%P</strong>: page name with spaces between camel case words, i.e. "My Page" * if the page name is "MyPage"</li> * <li><strong>%t</strong>: page title</li> * </ul> * Note that if the page title is empty or not defined then it defaults to %p. This is also the case * if the title cannot be retrieved for the document. * * The default is "%p". Some examples: "%s.%p", "%w:%s.%p". * * @return the format to use to display link labels when the user hasn't specified a label */ String getLinkLabelFormat();
/** * @return the category names to use for the macros. These are the categories under which they'll be listed * in UIs for example. If a category for a macro is null then the category defined in the macro * descriptor (ie defined by the macro author) will be used */ Properties getMacroCategories();
WDYT?
+1
If no negative comments are given I'd like to implement this ASAP.
Thanks -Vincent _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
On Sun, Aug 9, 2009 at 12:55 AM, Vincent Massol <[email protected]> wrote:
Hi,
After a discussion with Thomas we'd like to propose the following format for defining macro categories in xwiki.properties:
rendering.macroCategories = <macro id>=<cateogory name>
Ex:
rendering.macroCategories = toc:presentation rendering.macroCategories = velocity=code
Internally the config will be available from RenderingConfiguration:
public interface RenderingConfiguration { /** * A link label format is the format used to decide how to display links that have no label. * By default the page name is displayed. However it's possible to customize it using the * following tokens: * <ul> * <li><strong>%w</strong>: wiki name</li> * <li><strong>%s</strong>: space name</li> * <li><strong>%p</strong>: page name</li> * <li><strong>%P</strong>: page name with spaces between camel case words, i.e. "My Page" * if the page name is "MyPage"</li> * <li><strong>%t</strong>: page title</li> * </ul> * Note that if the page title is empty or not defined then it defaults to %p. This is also the case * if the title cannot be retrieved for the document. * * The default is "%p". Some examples: "%s.%p", "%w:%s.%p". * * @return the format to use to display link labels when the user hasn't specified a label */ String getLinkLabelFormat();
/** * @return the category names to use for the macros. These are the categories under which they'll be listed * in UIs for example. If a category for a macro is null then the category defined in the macro * descriptor (ie defined by the macro author) will be used */ Properties getMacroCategories();
WDYT?
If no negative comments are given I'd like to implement this ASAP.
+1
Thanks -Vincent _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
participants (3)
-
Asiri Rathnayake -
Thomas Mortagne -
Vincent Massol