Skip to content

Commit

Permalink
Item349: Corrected links to PreferenceSettings (was used without the …
Browse files Browse the repository at this point in the history
…trailing s many places and that may not always work in non english installations)

git-svn-id: http://svn.foswiki.org/trunk@1073 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
KennethLavrsen authored and KennethLavrsen committed Nov 30, 2008
1 parent 0dcc094 commit cb0d927
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion PatternSkin/data/System/PatternSkin.txt
Expand Up @@ -54,7 +54,7 @@ The original Photoshop files of the skin graphics (mainly background images) are

---+++ Troubleshooting

If you have set the SKIN [[preference setting]] to =pattern= and you still don't see the layout as on the <a href="%ATTACHURL%/patternskin_screenshot_full.png">screenshot</a>, a few settings in may have been disabled.
If you have set the SKIN [[%SYSTEMWEB%.PreferenceSettings][preference setting]] to =pattern= and you still don't see the layout as on the <a href="%ATTACHURL%/patternskin_screenshot_full.png">screenshot</a>, a few settings in may have been disabled.

Check these [[%SYSTEMWEB%.PreferenceSettings][preference settings]] here:
* FOSWIKI_LAYOUT_URL = %FOSWIKI_LAYOUT_URL%
Expand Down
2 changes: 1 addition & 1 deletion PreferencesPlugin/data/System/PreferencesPlugin.txt
Expand Up @@ -13,7 +13,7 @@ In edit mode, the edit button is replaced by Save and Cancel buttons, with their

* =%<nop>EDITPREFERENCES{ "= _topic_ =" }%=
* _topic_ references a [[%SYSTEMWEB%.DataForms][DataForm]] defining the format of the edit fields for preferences. It may be prefixed by a web.
* If a [[preference setting]] is not mentioned in the form referenced by _topic_, a text input box of the specified length is provided.
* If a [[%SYSTEMWEB%.PreferenceSettings][preference setting]] is not mentioned in the form referenced by _topic_, a text input box of the specified length is provided.
* Otherwise, the input can be through textareas, select, radio, checkbox, date, or text, as provided by %SYSTEMWEB%.DataForms.
* =%<nop>EDITPREFERENCES%=
* Edit existing preferences in the topic using a simple text field.
Expand Down
6 changes: 3 additions & 3 deletions WysiwygPlugin/data/System/WysiwygPluginSettings.txt
@@ -1,14 +1,14 @@
---+ Settings for WysiwygPlugin that are common to most editor integrations
%STARTINCLUDE%
The *global* [[preference setting]] =WYSIWYG_EXCLUDE= can be set to make the plugin sensitive to what is in a topic, before allowing it to be edited. You can set it up to veto an edit if the topic contains:
The *global* [[%SYSTEMWEB%.PreferenceSettings][preference setting]] =WYSIWYG_EXCLUDE= can be set to make the plugin sensitive to what is in a topic, before allowing it to be edited. You can set it up to veto an edit if the topic contains:
* =html= - HTML tags (e.g. =&lt;div&gt;=, not including &lt;br&gt;), or
* =macros= - simple macros (e.g. =%<nop>VAR%=) or
* =calls= - macros with parameters e.g. =%<nop>MACRO{...}%=
* =pre= blocks (=&lt;pre&gt;=)
* HTML =comments= (=&lt;!--= ... =--&gt;=)
If the plugin detects an excluded construct in the topic, it will refuse to allow the edit and will redirect to the default editor.

If you excluded =calls= in =WYSIWYG_EXCLUDE=, you can still define a subset of macros that do *not* block edits. this is done in the *global* [[preference setting]] =WYSIWYG_EDITABLE_CALLS=, which should be a list of macro names separated by vertical bars, with no spaces, e.g: =* Set WYSIWYG_EDITABLE_CALLS = COMMENT|CALENDAR|INCLUDE=
If you excluded =calls= in =WYSIWYG_EXCLUDE=, you can still define a subset of macros that do *not* block edits. this is done in the *global* [[%SYSTEMWEB%.PreferenceSettings][preference setting]] =WYSIWYG_EDITABLE_CALLS=, which should be a list of macro names separated by vertical bars, with no spaces, e.g: =* Set WYSIWYG_EDITABLE_CALLS = COMMENT|CALENDAR|INCLUDE=

You should set =WYSIWYG_EXCLUDE= and =WYSIWYG_EDITABLE_CALLS= in %USERSWEB%.SitePreferences, or in %WEBPREFSTOPIC% for each web.

Expand All @@ -18,7 +18,7 @@ HTML when certain specific attributes are present on the tag. This is most
useful when you have styling or alignment information in tags that must be
preserved.

This [[preference setting]] is used to tell the translator which attributes, when present
This [[%SYSTEMWEB%.PreferenceSettings][preference setting]] is used to tell the translator which attributes, when present
on a tag, make it "stick" i.e. block conversion. For example, setting it to
=table=background,lang;tr=valign= will stop the translator from trying to
handle any =table= tag that has =background= or =lang= attributes, and any
Expand Down
2 changes: 1 addition & 1 deletion core/data/System/CommandAndCGIScripts.txt
Expand Up @@ -59,7 +59,7 @@ The main difference between invoking this script and using WebChanges is that We
The =edit= script understands the following parameters, typically supplied by HTML input fields:

| *Parameter* | *Description* | *Default* |
| =action= | Optional. Use the editaction template instead of the standard edit. If action=text, then hide the form. If action=form hide the normal text area and only edit the form. You can change the Edit/Edit Raw buttons to always append the action parameter in skins like Pattern and Classic by setting the topic or [[preference setting]] [[VarEDITACTION][EDITACTION]] to the value =text= or =form=. To edit the topic once the EDITACTION is defined as form simply remove the action=form from the browser URL of the edit script and reload the edit window | |
| =action= | Optional. Use the editaction template instead of the standard edit. If action=text, then hide the form. If action=form hide the normal text area and only edit the form. You can change the Edit/Edit Raw buttons to always append the action parameter in skins like Pattern and Classic by setting the topic or [[PreferenceSettings][preference setting]] [[VarEDITACTION][EDITACTION]] to the value =text= or =form=. To edit the topic once the EDITACTION is defined as form simply remove the action=form from the browser URL of the edit script and reload the edit window | |
| =onlynewtopic= | If set, error if topic already exists | |
| =onlywikiname= | If set, error if topic name is not a WikiWord | |
| =templatetopic= | The name of the template topic, copied to get the initial content (new topic _only_) | |
Expand Down
6 changes: 3 additions & 3 deletions core/data/System/DefaultPreferences.txt
Expand Up @@ -213,7 +213,7 @@ Preference settings local to your site should be set in [[%LOCALSITEPREFS%]] (th
---++ Plugins Settings

* You can enable/disable Plugins using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface.
* You can also disable installed plugins in individual webs/topics by defining the DISABLEDPLUGINS [[preference setting]] to be a list of plugins to disable e.g.
* You can also disable installed plugins in individual webs/topics by defining the DISABLEDPLUGINS [[PreferenceSettings][preference setting]] to be a list of plugins to disable e.g.
* <nop>Set DISABLEDPLUGINS = SpreadSheetPlugin,EditTablePlugin
* Currently, %<nop>DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%"
* Currently activated Plugins: %ACTIVATEDPLUGINS%
Expand Down Expand Up @@ -334,13 +334,13 @@ Preference settings local to your site should be set in [[%LOCALSITEPREFS%]] (th

---++ Creating New Preference Settings

You can introduce new [[%SYSTEMWEB%.PreferenceSettings][preference settings]] and use them in your topics and templates. There is no need to change the Foswiki engine (Perl scripts).
You can introduce new [[PreferenceSettings][preference settings]] and use them in your topics and templates. There is no need to change the Foswiki engine (Perl scripts).
* A preference is defined in a ShortHand bullet item: ==[3 spaces] * [space] Set NAME = value== <br /> Example (as a nested bullet item, indented 6 spaces):
* S<nop>et WEBBGCOLOR = #FFFFC0
* Preferences are used as [[%SYSTEMWEB%.Macros][Macros]] by enclosing the name in percent signs: ==%==. Example:
* When you write ==%WEB<nop>BGCOLOR%==, it gets expanded to =%WEBBGCOLOR%= .

* %X% The sequential order of the [[%SYSTEMWEB%.PreferenceSettings][preference settings]] is significant. Define preferences that use other preferences FIRST. For example, set ==<nop>WEBCOPYRIGHT== before ==<nop>WIKIWEBMASTER== since the copyright notice uses the Wiki administrator e-mail address.
* %X% The sequential order of the [[PreferenceSettings][preference settings]] is significant. Define preferences that use other preferences FIRST. For example, set ==<nop>WEBCOPYRIGHT== before ==<nop>WIKIWEBMASTER== since the copyright notice uses the Wiki administrator e-mail address.
* %X% In order to protect your custom preferences from being overwritten when upgrading the [[%SYSTEMWEB%.%TOPIC%]] topic, it is recommended that all custom settings are defined in [[%USERSWEB%.%TOPIC%]].

---++ Protected System Settings
Expand Down
4 changes: 2 additions & 2 deletions core/data/System/IfStatements.txt
Expand Up @@ -16,8 +16,8 @@ The basic syntax of a condition is the same as [[QuerySearch][the syntax used fo
| istopic | =istopic 'X'= is true if topic 'X' exists |
| isweb | =isweb 'X'= is true if web 'X' exists |
| ingroup | ='X' ingroup 'Y'= is true if user 'X' is in group 'Y'. 'X' can be a login name or a wikiname. |
| defined | True if a [[preference setting]] or url parameter of this name is defined. |
| isempty | True if a [[preference setting]], url parameter or session variable of this name has an empty value. It is equivalent to the expression =(!defined(x) || $x='')= |
| defined | True if a [[PreferenceSettings][preference setting]] or url parameter of this name is defined. |
| isempty | True if a [[PreferenceSettings][preference setting]], url parameter or session variable of this name has an empty value. It is equivalent to the expression =(!defined(x) || $x='')= |
| $ | expands a URL parameter or [[Macros][macro]] name. Plugin handlers *are not called*. You can pass a limited subset of parameters to macros by enclosing the parameter string in single quotes; for example, =$ 'MACRO{value}'=. The ='MACRO{value}'= string may *not* contain quotes (' or "). |
| {X} | expands to the value of the =configure= setting {X} - for example, ={ScriptUrlPath}= |

Expand Down
2 changes: 1 addition & 1 deletion core/data/System/InstantEnhancements.txt
Expand Up @@ -22,7 +22,7 @@ Incredibly obvious, maybe, but some site admins don't get around to changing the

*What we are doing*

We want to set the preference WEBBGCOLOR in topic WebPreferences to one of the StandardColors. <nop>WebPreferences is, as you can guess, a topic which holds all kind of [[preference setting]] for each Web[[ManagingWebs][{*}]]. Each web has its own <nop>WebPreferences, and you can set them differently for each web.
We want to set the preference WEBBGCOLOR in topic WebPreferences to one of the StandardColors. <nop>WebPreferences is, as you can guess, a topic which holds all kind of [[%SYSTEMWEB%.PreferenceSettings][preference settings]] for each Web[[ManagingWebs][{*}]]. Each web has its own <nop>WebPreferences, and you can set them differently for each web.

*How to do it*

Expand Down
4 changes: 2 additions & 2 deletions core/data/System/SiteTools.txt
Expand Up @@ -122,7 +122,7 @@ Foswiki generates monthly log files which are used by the statistics script

Outgoing mail is required for UserRegistration and for [[#WebNotify][recent changes alert]].

Foswiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== [[preference setting]].
Foswiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== [[%SYSTEMWEB%.PreferenceSettings][preference setting]].

The notify e-mail uses the default =changes.tmpl= template, or a skin if activated by a [[%SYSTEMWEB%.PreferenceSettings][preference setting]].

Expand All @@ -132,7 +132,7 @@ You can use an external mail program, such as ==sendmail==, if the =Net::SMTP= m

! * %H% Net::SMTP can be easily disabled (if there is an installation error) by setting the ==SMTPMAILHOST== [[%SYSTEMWEB%.PreferenceSettings][preference setting]] to an empty value.

* %T% You can set a separate ==SMTPSENDERHOST== [[preference setting]] to define the mail sender host (some SMTP installations require this).
* %T% You can set a separate ==SMTPSENDERHOST== [[%SYSTEMWEB%.PreferenceSettings][preference setting]] to define the mail sender host (some SMTP installations require this).

---+++ Setting the automatic e-mail schedule

Expand Down
4 changes: 2 additions & 2 deletions core/data/System/VarEDITACTION.txt
Expand Up @@ -3,8 +3,8 @@
#VarEDITACTION
---+++ EDITACTION -- Selects an edit template

* The EDITACTION [[preference setting]] lets you define the use of an editaction template instead of the standard edit. If EDITACTION is defined as =text=, then hide the form. If EDITACTION is defined as =form= hide the normal text area and only edit the form.
* The EDITACTION [[PreferenceSettings][preference setting]] lets you define the use of an editaction template instead of the standard edit. If EDITACTION is defined as =text=, then hide the form. If EDITACTION is defined as =form= hide the normal text area and only edit the form.
* Syntax: Set EDITACTION = text|form
* Expands to: %EDITACTION%
* Related: CommandAndCGIScripts#edit
* %X% When EDITACTION is defined as text or form the Edit and Edit Raw buttons simply add =;action=text= or =;action=form= to the URL for the edit script. If you have defined an EDITACTION [[preference setting]] you can still edit the topic content or the form by removing the =;action=form= or =;action=text= from the edit URL in the browser and reload.
* %X% When EDITACTION is defined as text or form the Edit and Edit Raw buttons simply add =;action=text= or =;action=form= to the URL for the edit script. If you have defined an EDITACTION [[PreferenceSettings][preference setting]] you can still edit the topic content or the form by removing the =;action=form= or =;action=text= from the edit URL in the browser and reload.
2 changes: 1 addition & 1 deletion core/data/System/VarWEBLIST.txt
Expand Up @@ -2,7 +2,7 @@
%META:TOPICPARENT{name="Macros"}%
#VarWEBLIST
---+++ WEBLIST{"format"} -- index of all webs
* List of all webs. Obfusticated webs are excluded, e.g. webs with a =NOSEARCHALL = on= [[preference setting]]. The ="format"= defines the format of one web item. The =$name= gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=.
* List of all webs. Obfusticated webs are excluded, e.g. webs with a =NOSEARCHALL = on= [[PreferenceSettings][preference setting]]. The ="format"= defines the format of one web item. The =$name= gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=.
* Syntax: =%<nop>WEBLIST{"format" ...}%=
* Supported parameters:
| *Parameter:* | *Description:* | *Default:* |
Expand Down

0 comments on commit cb0d927

Please sign in to comment.