Skip to content

Commit

Permalink
Item109: fixed refs to TWikiPreferences, renamed TWikiRenderingShortc…
Browse files Browse the repository at this point in the history
…uts to ShortcutMacros

git-svn-id: http://svn.foswiki.org/trunk@490 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
CrawfordCurrie authored and CrawfordCurrie committed Nov 9, 2008
1 parent 2484b5f commit 4f50bc8
Show file tree
Hide file tree
Showing 77 changed files with 185 additions and 194 deletions.
2 changes: 1 addition & 1 deletion core/data/TWiki/DefaultPreferences.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="TWikiContributor" date="1176595196" format="1.1" version="$Rev: 15706 $"}%
!%META:TOPICINFO{author="TWikiContributor" date="1176595196" format="1.1" version="$Rev: 15706 $"}%
---+!! <nop>%WIKITOOLNAME% Site-Level Preferences

This topic defines __site-level__ settings that apply to all users and webs on this TWikiSite.
Expand Down
2 changes: 1 addition & 1 deletion core/data/TWiki/DontNotify.txt
Expand Up @@ -3,7 +3,7 @@ Use the "Minor changes, don't notify" checkbox in preview in case you only make

__Note:__ No new revision is created in case you save the same topic again within a certain time frame (default is one hour). You only need to checkmark the "Minor change, don't notify" checkbox once within this time frame, because subsequent save operations do not notify users.

__Note:__ The initial state of the checkbox can be set to on with the =DONTNOTIFYCHECKBOX= preferences variable. See TWikiPreferences for more.
__Note:__ The initial state of the checkbox can be set to on with the =DONTNOTIFYCHECKBOX= preferences variable. See DefaultPreferences for more.


__Related Topics:__ UserDocumentationCategory
Expand Down
2 changes: 1 addition & 1 deletion core/data/TWiki/FileAttachment.txt
Expand Up @@ -29,7 +29,7 @@ File Attachments can be used to archive data, or to create powerful customized g
* __NOTE:__ The topic must already exist. It is a two step process if you want to attach a file to a non-existing topic; first create the topic, then add the file attachment.
* Any type of file can be uploaded. Some files that might pose a security risk are renamed, ex: =*.php= files are renamed to =*.php.txt= so that no one can place code that would be read in a .php file.
* The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field.
* TWiki can limit the file size. This is defined by the =%<nop>ATTACHFILESIZELIMIT%= variable of the TWikiPreferences, currently set at %ATTACHFILESIZELIMIT% KB.
* TWiki can limit the file size. This is defined by the =%<nop>ATTACHFILESIZELIMIT%= variable of the DefaultPreferences, currently set at %ATTACHFILESIZELIMIT% KB.
* %X% It's not recommended to upload files greater than a few hundred K through a browser. Large files can be extremely slow-loading, and often time out. Use an FTP site for large file uploads.
* Automatic attachments:
* When enabled, all files in a topic's attachment directory are shown as attachments to the topic - even if they were directly copied to the directory and never attached by using an 'Attach' link. This is a convenient way to quickly "attach" files to a topic without uploading them one by one; although at the cost of losing audit trail and version control.
Expand Down
2 changes: 1 addition & 1 deletion core/data/TWiki/ForceNewRevision.txt
Expand Up @@ -3,7 +3,7 @@ Normally, if you make subsequent edits within a one hour period (configuration i

The "Force New Revision" checkbox is a way to force it to create a separate revision each time you save.

The [[%SYSTEMWEB%.TWikiPreferences]] variable =FORCENEWREVISIONCHECKBOX= controls whether this is checked by default or not.
The [[%SYSTEMWEB%.DefaultPreferences!]] variable =FORCENEWREVISIONCHECKBOX= controls whether this is checked by default or not.

On a related note, you can force __every__ save to be a new revision number by setting =ReplaceIfEditedAgainWithin= to 0.

Expand Down
2 changes: 0 additions & 2 deletions core/data/TWiki/FormattedSearch.txt
Expand Up @@ -202,5 +202,3 @@ Result:
%SEARCH{ search="%URLPARAM{"q"}%" format=" * $web.$topic: %BR% $summary" nosearch="on" }%

__Related Topics:__ UserDocumentationCategory, SearchHelp, TWikiVariables#VarSEARCH, SearchPatternCookbook, RegularExpression

-- __Contributors:__ TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
1 change: 0 additions & 1 deletion core/data/TWiki/GoodStyle.txt
Expand Up @@ -38,4 +38,3 @@

__Related Topics:__ UserDocumentationCategory

-- __Contributors:__ TWiki:Main.MikeMannix, TWiki:Main.PeterThoeny
2 changes: 1 addition & 1 deletion core/data/TWiki/InstantEnhancements.txt
Expand Up @@ -48,7 +48,7 @@ Without explaining what WEBTOPICLIST is, just try it:

---+++ Simple way to create %RED% colored text %ENDCOLOR% and graphics

This should be enabled, see the "Miscellaneous Settings" in the TWikiPreferences, . If not, look at TWiki:TWiki/TWikiPreferences. Look for variables RED, BLUE etc (which define HTML tag FONT). To copy/paste the variables defining the colors you need to see the source text, but =Edit= is disabled. Instead, go to =More= and view the topic in ==raw== format.
This should be enabled, see the "Miscellaneous Settings" in the DefaultPreferences, . If not, look at TWiki:TWiki/DefaultPreferences. Look for variables RED, BLUE etc (which define HTML tag FONT). To copy/paste the variables defining the colors you need to see the source text, but =Edit= is disabled. Instead, go to =More= and view the topic in ==raw== format.

---+++ EZ Graphic Icons to Highlight Text

Expand Down
2 changes: 1 addition & 1 deletion core/data/TWiki/MainFeatures.txt
Expand Up @@ -18,7 +18,7 @@
* *Managing pages:* Individual [[TWikiTopics][pages]] can be renamed, moved and deleted through the browser.
* *Managing users:* Web-based [[TWikiRegistration][user registration]] and [[ChangePassword][change of password]].
* *Statistics:* Create statistics of TWiki webs. Find out most popular pages and top contributors.
* *Preferences:* Three levels of preferences: TWikiPreferences for site-level, WebPreferences for each web, and user level preferences.
* *Preferences:* Three levels of preferences: DefaultPreferences for site-level, WebPreferences for each web, and user level preferences.
* *[[SimultaneousEdits][simultaneous page editing]]:*
* *Referred-By:* Find the pages that contain links to a topic.

Expand Down
8 changes: 4 additions & 4 deletions core/data/TWiki/ManagingWebs.txt
Expand Up @@ -55,12 +55,12 @@ To create a subweb named =Bar= inside a web named =Foo=, use =Foo/Bar= or =Foo.B

---+++ Subweb Preferences are Inherited

The preferences of a subweb are inherited from the parent web and overridden locally. Preferences are ultimately inherited from the [[%SYSTEMWEB%.TWikiPreferences]] topic.
The preferences of a subweb are inherited from the parent web and overridden locally. Preferences are ultimately inherited from the [[%SYSTEMWEB%.DefaultPreferences]] topic.

*Example Preference Inheritance for =Sandbox/TestWeb/SubWeb.SubWebTopic= topic:*

1. =%SYSTEMWEB%.TWikiPreferences= site-wide preferences
2. =Sandbox.%WEBPREFSTOPIC%= inherits from and overrides settings in =%SYSTEMWEB%.TWikiPreferences=
1. =%SYSTEMWEB%.DefaultPreferences= site-wide preferences
2. =Sandbox.%WEBPREFSTOPIC%= inherits from and overrides settings in =%SYSTEMWEB%.DefaultPreferences=
3. =Sandbox/TestWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox.%WEBPREFSTOPIC%=
4. =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox/TestWeb.%WEBPREFSTOPIC%=
5. =Sandbox/TestWeb/SubWeb.SubWebTopic= inherits from and overrides settings in =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%=
Expand All @@ -79,7 +79,7 @@ Rename a web via the Tools section in each %WEBPREFSTOPIC% topic. You may delet
You may only rename a web if you have the following permissions
* You must be allowed to rename and changes topics in the web you want to rename
* You must be allowed to rename topics in the parent web of the web you want to rename
* If the web is a root web (i.e. it has no parent web) then you must have permission to both create and rename root webs. These permissions are controlled by the ALLOWROOTCHANGE preference, which can be set in [[%USERSWEB%.TWikiPreferences]].
! * If the web is a root web (i.e. it has no parent web) then you must have permission to both create and rename root webs. These permissions are controlled by the ALLOWROOTCHANGE preference, which can be set in [[%USERSWEB%.DefaultPreferences]].
* If you move the web to another parent web you must be allowed to create and change topics in the new parent web.

When you rename a web TWiki will try and update all links that refer to the old web. You should note that links only get updated in topics that you are allowed to edit. If you use access rights in the TWiki installation it is generally best to let an administrator rename webs to avoid too many broken links.
Expand Down
2 changes: 1 addition & 1 deletion core/data/TWiki/QuerySearch.txt
Expand Up @@ -115,7 +115,7 @@ When a query is applied to a topic, the goal is to reduce to a TRUE or FALSE val
A query matches if the query returns one or more values when it is applied to the topic. So if I have a very simple query, such as ="attachments"=, then this will return TRUE for all topics that have one or more attachments. If I write ="attachments[size>1024 AND name ~ '*.gif']"= then it will return TRUE for all topics that have at least one attachment larger than 1024 bytes with a name ending in =.gif=.

---++ Gotcha
* Remember that in the query language, TWiki topic names are _constants_. You cannot write =Main.UserTopic/UserForm.firstName= because =Main.UserTopic= will be interpreted as a form field name. If you want to refer to topics you *must* enclose the topic name in quotes i.e. ='Main.UserTopic'/UserForm.firstName=
* Remember that in the query language, topic names are _constants_. You cannot write =%USERSWEB%.UserTopic/UserForm.firstName= because =%USERSWEB%.UserTopic= will be interpreted as a form field name. If you want to refer to topics you *must* enclose the topic name in quotes i.e. ='%USERSWEB%.UserTopic'/UserForm.firstName=

---++ Examples

Expand Down
4 changes: 2 additions & 2 deletions core/data/TWiki/SearchHelp.txt
Expand Up @@ -17,7 +17,7 @@ By default searches are keyword based like in a typical search engine:
* Specify a minus sign to *exclude* a word, like =soap -shampoo=
* Use double quotes if you want to search for a leading minus sign, like ="-nowarn"=
* *Stop words* are excluded from a keyword search:
* Stop words are common words and characters such as ="how"= and ="where"=, defined in the SEARCHSTOPWORDS setting in the TWikiPreferences
* Stop words are common words and characters such as ="how"= and ="where"=, defined in the SEARCHSTOPWORDS setting in the DefaultPreferences
* If you want to search for a word in the stop word list, prefix the word with a plus sign
* *Example:* To search for all topics that contain ="SOAP"=, ="WSDL"=, a literal ="web service"=, but not ="shampoo"=,%BR% enter this: =soap +wsdl "web service" -shampoo=

Expand All @@ -34,7 +34,7 @@ You can embed a nicely [[FormattedSearch][formatted search]] in a topic by using

---++ Search Preferences

TWikiPreferences defines these search preferences:
!DefaultPreferences defines these search preferences:

* =SEARCHDEFAULTTTYPE=: Default search type for search forms which calls the =search= script
* Currently =%SEARCHDEFAULTTTYPE%=
Expand Down
5 changes: 2 additions & 3 deletions core/data/TWiki/SearchPatternCookbook.txt
Expand Up @@ -124,7 +124,7 @@ Which expands to this: (here limited to all Z* users because TWiki.org has so ma
<input type="submit" value="Go" />
</form>

This searches all topics in the Main web that contain "Name", "Email" and "Country" bullets. Alternatively, do a %SYSTEMWEB%.FormattedSearch with =multiple="on"= on the [[%USERSWEB%.TWikiUsers]] topic.
This searches all topics in the %USERSWEB% web that contain "Name", "Email" and "Country" bullets. Alternatively, do a %SYSTEMWEB%.FormattedSearch with =multiple="on"= on the [[%USERSWEB%.TWikiUsers]] topic.

---+++ Solution 2: As Solution 1, but with possibility for multi-selecting usernames

Expand Down Expand Up @@ -242,7 +242,7 @@ How to find and display public webs in a drop down list box.

---+++ Solution

_Thanks to TWiki:Main.PeterThoeny for these solutions._
_Thanks to Peter Thoeny for these solutions._

<verbatim>
<form>
Expand Down Expand Up @@ -404,4 +404,3 @@ Moved topics: %SEARCH{ "%META\:TOPICMOVED" type="regex" format="$topic, " nosear

__Related Topics:__ UserDocumentationCategory, SearchHelp, TWikiVariables#VarSEARCH, FormattedSearch, RegularExpression

-- __Contributors:__ TWiki:Main.AntonAylward, TWiki:Main.ArthurClemens, TWiki:Main.JosMaccabiani, TWiki:Main.PeterThoeny, TWiki:Main.SueLocke
16 changes: 16 additions & 0 deletions core/data/TWiki/ShortcutMacros.txt
@@ -0,0 +1,16 @@
%META:TOPICINFO{author="ProjectContributor" date="1160951440" format="1.1" version="$Rev$"}%
%META:TOPICPARENT{name="DefaultPreferences"}%
---+ Shortcuts

_Easy ways to save some typing_

Some macros are just shortcuts for longer sequences of characters, to either save typing or to easily allow line breaks in format strings and the like. These macros are not intended to be customized, though there's nothing stopping you from doing so.

*The following variables are classified as rendering shortcuts:*
%SEARCH{ "Type:.*ShortcutMacro" type="regex" topic="Var*"
format=" * [[$topic][%<nop>$pattern(.*?\-\++ *([^ ]*).*)%]] - $pattern(.*?\-\+.*?-- ([^\n\r]*).*) %$pattern(.*?\-\++ *([^ ]*).*)%" nonoise="on" }%

__See also:__
* TWikiVariables - an alphabetical list of all variables
* DefaultPreferences#RenderingShortcuts - where shortcuts are defined
* TWikiShorthand - summary of the TWiki markup language
1 change: 0 additions & 1 deletion core/data/TWiki/TWikiAccessControl.txt
Expand Up @@ -253,4 +253,3 @@ Alternatively, place them in HTML comment markers, but this exposes the access s

__Related Topics:__ AdminDocumentationCategory, TWikiUserAuthentication, TWiki:TWiki.TWikiAccessControlSupplement

-- __Contributors:__ TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.CrawfordCurrie
2 changes: 1 addition & 1 deletion core/data/TWiki/TWikiCss.txt
Expand Up @@ -134,7 +134,7 @@ A wide range of standard styles are used in the TWiki core code and topics, and

---+++ TWiki Styles in topics

|.twikiBroadcastMessage |%SYSTEMWEB%.TWikiPreferences |
|.twikiBroadcastMessage |%SYSTEMWEB%.DefaultPreferences! |
|#twikiSearchTable |%SYSTEMWEB%.WebSearch, %SYSTEMWEB%.WebSearchAdvanced |

---+++ TWiki Styles in Skins
Expand Down
4 changes: 2 additions & 2 deletions core/data/TWiki/TWikiDocGraphics.txt
Expand Up @@ -342,7 +342,7 @@ There are several other ways to put an image in a topic.

Shorthand notation:
<blockquote>
In [[%USERSWEB%.TWikiPreferences]] set a variable to an ICON, for example:
In [[%USERSWEB%.DefaultPreferences!]] set a variable to an ICON, for example:

=<nop> * Set H = %<nop>ICON{help}%=

Expand Down Expand Up @@ -374,7 +374,7 @@ and that will get rendered as: %ICONURL{"toggleopen"}%

__Related Topics:__ TWikiSkins, DeveloperDocumentationCategory, AdminDocumentationCategory

__Contributors:__ Most icons on this page were originally designed by TWiki:Main.PeterThoeny. Many icons were recreated by TWiki:Main.ArthurClemens.
__Contributors:__ Most icons on this page were originally designed by Peter Thoeny. Many icons were recreated by Arthur Clemens.

%META:FILEATTACHMENT{name="addon.gif" attr="" comment="" date="1169565034" path="addon.gif" size="370" user="ProjectContributor" version=""}%
%META:FILEATTACHMENT{name="air.gif" attr="" comment="" date="1169565034" path="air.gif" size="356" user="ProjectContributor" version=""}%
Expand Down
4 changes: 2 additions & 2 deletions core/data/TWiki/TWikiEditingShorthand.txt
Expand Up @@ -310,7 +310,7 @@ To link to a topic in a subweb write =Otherweb.Subweb.TopicName=.%BR%
%H% The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the <nop>%HOMETOPIC% topic. %BR%
%X% Dots ='.'= are used to separate webs and subwebs from topic names and therefore cannot be used in topic names.

It's generally a good idea to use the TWikiVariables %<nop>SYSTEMWEB% and %<nop>USERSWEB% instead of TWiki and Main.
It's generally a good idea to use the TWikiVariables %<nop>SYSTEMWEB% and %<nop>USERSWEB% instead of %SYSTEMWEB% and %USERSWEB%.
</td><td>
<verbatim>
WebStatistics
Expand Down Expand Up @@ -366,7 +366,7 @@ Text within the brackets may contain optional spaces; the topic name is formed b
<verbatim>
[[wiki syntax]]

[[Main.TWiki groups]]
[[Sandbox.My unspaced topic]]

escaped:
![[wiki syntax]]
Expand Down
1 change: 0 additions & 1 deletion core/data/TWiki/TWikiFAQ.txt
Expand Up @@ -33,4 +33,3 @@ Other places where you can find answers to your questions:
* TextFormattingFAQ: Answers to frequently asked questions about text styling in TWiki
* If you can't find an answer, ask a question - post it in the TWiki:Support web

-- __Contributors:__ TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.CrawfordCurrie
2 changes: 1 addition & 1 deletion core/data/TWiki/TWikiForms.txt
Expand Up @@ -71,7 +71,7 @@ Field values can also be set using the result of expanding other TWiki variables
=%<nop>SEARCH{"Office$" scope="topic" web="%<nop>USERSWEB%" nonoise="on" type="regex" format="$web.$topic" separator=", " }%=
</blockquote>

When used in the value field of the form definition, this will find all topic names in the Main web which end in "Office" and use them as the legal field values.
When used in the value field of the form definition, this will find all topic names in the %USERSWEB% web which end in "Office" and use them as the legal field values.

#EnablingForms
---++ Enabling Forms by Web
Expand Down
2 changes: 1 addition & 1 deletion core/data/TWiki/TWikiGlossary.txt
Expand Up @@ -11,7 +11,7 @@ _Simple glossary of TWiki terms_
| Page: | A regular Web page. A page in TWiki is composed of the _template/skin_ decoration and _topic_ content. |
| Plugin: | Prepackaged server-side extension that adds all sorts of additional functions, seamlessly integrated into TWiki. [[TWikiPlugins][Details...]] |
| Plugin API: | The standard interface for creating TWiki _Plugins_ and add-on programs that ensure a perfect integration. [[TWikiFuncDotPm][Details...]] |
| Preferences: | The site-wide, single _web_ and single user-level preferences settings. The settings are stored in TWikiPreferences, WebPreferences and %USERSWEB%.TWikiUsers home pages. [[TWikiVariables#PreferencesVariables][Details...]] |
| Preferences: | The site-wide, single _web_ and single user-level preferences settings. The settings are stored in DefaultPreferences, WebPreferences and %USERSWEB%.TWikiUsers home pages. [[TWikiVariables#PreferencesVariables][Details...]] |
| Site: | A TWiki installation consisting of one or more _webs_. [[TWikiSite][Details...]] |
| Skin: | Skins overlay regular _templates_ with alternate header/footer layout of _pages_; topic text is not affected. Skins are typically enabled site-wide or per _web_. [[TWikiSkins][Details...]] |
| Templates: | (1) Regular templates define header/footer layout of _pages_; topic text is not affected. (2) Template topics set the default content for new _topics_. [[PresentationTemplates][Details...]] |
Expand Down

0 comments on commit 4f50bc8

Please sign in to comment.