• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7700 for generic doc work for TWiki-6.0.2. Use View topic Item7703 for doc work on extensions that are not part of a release. More... Close
• Anything you create or change in standard webs (Main, TWiki, Sandbox etc) will be automatically reverted on every SVN update.
Does this site look broken?. Use the LitterTray web for test cases.

CDot said - raise an issue "no documentation for .spec files"


Here is the high-level overview:
  1. Create a Config.spec file in the plugin directory (i.e., the TWiki/Plugins/XXX/ directory for a plugin named XXX
  2. In that spec file, follow the style of TWiki.spec to document your settings and give defaults. You can either create a new sub-section in plugins or put the settings into the plugin section. It is best to follow the style of the examples below.

Examples:

  • From TWiki::Contrib::JSCalendarContrib
    #---+ Contrib
    #---++ JSCalendarContrib
    # **STRING 10**
    # Style setting
    $TWiki::cfg{JSCalendarContrib}{style} = 'blue';
    # **STRING 5**
    # Language setting
    $TWiki::cfg{JSCalendarContrib}{lang} = 'en';
    1;
       
  • From TWiki::Plugins::EditTablerowPlugin
    #---+ Plugins
    #---++ EditTablerowPlugin
    # **BOOLEAN**
    # Debug setting
    $TWiki::cfg{Plugins}{EditTablerowPlugin}{DEBUG} = 0;
    1;
       

Note that currently you can stick your settings anywhere by creating the appropriate section markers. Probably there should be some limitation on that. -- TW


Excellent examples, Thomas, thanks! ...but unfortunately they are not in SVN. The only example of a Config.spec I have found was that of MainInContrib, and this does not have a #---+ Contrib header (it should be "Contribs", by the way).

I have never found out that entries are collected if they have a common subheading.

I have copied your text and discussion to TWiki:Codev.SpecifyingConfigurationItemsForExtensions. State is "Actioning".


Checking in CC's suggestion from TWiki:Codev.SpecifyingConfigurationItemsForExtensions now, and setting to "Waiting for Release" because the ability to write spec files should be in the release notes --haj

4.1.0 released

KJL

ItemTemplate
Summary Document how to get plugin settings into and from configure
ReportedBy TWiki:Main.SvenDowideit
Codebase ~twiki4
SVN Range TWiki-4.1, Sat, 18 Nov 2006, build 12001
AppliesTo Engine
Component

Priority Urgent
CurrentState Closed
WaitingFor

Checkins 12098
TargetRelease minor
Edit | Attach | Watch | Print version | History: r9 < r8 < r7 < r6 < r5 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r9 - 2007-01-16 - KennethLavrsen
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback