Priority: Enhancement
Current State: New
Released In: n/a
Target Release: major
I think it is useful to let extension authors automatically link to the extension configuration screen.
An extension topic could have this text:
Configuring DateTimePlugin
Settings of this extension can be changed in
configure.
-
{DateTimePlugin}{TimezoneOffset}
- the timezone offset of the webserver
-
{DateTimePlugin}{Dates}
- localized date strings
Now, the link format to a specific extension in configure is this:
%SCRIPTURL{configure}%/#PLUGIN_NAME$Extensions
so for DateTimePlugin it would be:
%SCRIPTURL{configure}%/#DateTimePlugin$Extensions
With
%CONFIGURE_INSTRUCTIONS%
I could automatically have a link to the right section, and users would not have to look through the configure navigation to find the settings.
--
ArthurClemens - 18 Aug 2009
I'm not sure I fully understand what you want this to expand to in the Topic? Should it just be the link to configure, or do you want some boilerplate telling the user that the extension is configured using the bin/configure interface. ... Or should it go further and expand the help text in the
Config.spec
file? Actually in thinking about it, that sounds interesting, and it avoids duplicating the configure instructions in two places.
So entering
%$CONFIGURE_INSTRUCTIONS%
would expand to:
---++ Configuring $PLUGIN_NAME
(Only if a Config.spec file exists)
---+++ Using the configure script
The following parameters are configured using [[%SCRIPTURL{configure}%/#PLUGIN_NAME$Extensions][Configure:PLUGIN_NAME]]
<Expand the help text from Config.spec, listing each non-expert config item.>
These expert parameters are also available.
<expand the expert parms>
---+++ Other configuration
__Add any other configuration instructions here and remove this note__
--
GeorgeClark - 28 Aug 2011
It should link to configure AND expand the help text in the
Config.spec
file.
--
ArthurClemens - 27 Oct 2011