Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Item9693: Item11737: Doc updates
 - Change System / Main / Sandbox references to %Macro equivalents
 - Examples in IfStatements broken by change to Single Quotes in %RED%
   color macro.
  • Loading branch information
gac410 committed Jan 1, 2015
1 parent 34cb74a commit 150b76f
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 43 deletions.
4 changes: 2 additions & 2 deletions CommentPlugin/data/Sandbox/CommentPluginTemplateExample.txt
@@ -1,8 +1,8 @@
%META:TOPICINFO{author="ProjectContributor" date="1274992098" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1420148640" format="1.1" version="1"}%
%META:TOPICPARENT{name="CommentPlugin"}%
---+!! Template Example

Example template topic for [[Sandbox.CommentPluginExamples#TemplateTopic][CommentPluginExamples:templatetopic]].
Example template topic for [[%SANDBOXWEB%.CommentPluginExamples#TemplateTopic][CommentPluginExamples:templatetopic]].


<verbatim>
Expand Down
14 changes: 7 additions & 7 deletions PatternSkin/data/System/PatternSkinTheme2012.txt
@@ -1,8 +1,8 @@
%META:TOPICINFO{author="ProjectContributor" date="1304087511" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1420154378" format="1.1" version="1"}%
%META:TOPICPARENT{name="PatternSkin"}%
---+!! <nop>PatternSkin theme: Foswiki "2012" Site Skin

This is a remix of the [[System.PatternSkinThemeFatWilly][Foswiki Site]] theme for patternskin, using the new 2012 foswiki System.ProjectLogos.
This is a remix of the [[%SYSTEMWEB%.PatternSkinThemeFatWilly][Foswiki Site]] theme for patternskin, using the new 2012 foswiki %SYSTEMWEB%.ProjectLogos.

This is just a stopgap for now, Arthur is working on a real skin :)

Expand All @@ -24,10 +24,10 @@ This is just a stopgap for now, Arthur is working on a real skin :)
* Local DISPLAY_PATTERNSKIN_COLUMNS = %CALC{"$SUBSTITUTE(%PATTERNSKIN_COLUMNS%, %PUBURLPATH%/%SYSTEMWEB%, $NOP(%<nop>PUBURLPATH%/%<nop>SYSTEMWEB%))"}%
* Local DISPLAY_PATTERNSKIN_THEME_VARIANT = %CALC{"$SUBSTITUTE(%PATTERNSKIN_THEME_VARIANT%, %PUBURLPATH%/%SYSTEMWEB%/, $NOP(%<nop>PUBURLPATH%/%<nop>SYSTEMWEB%))"}%
* Local DISPLAY_PATTERNSKIN_NAVIGATION_TOPIC = %CALC{"$SUBSTITUTE(%PATTERNSKIN_NAVIGATION_TOPIC%, %SYSTEMWEB%, $NOP(%<nop>SYSTEMWEB%))"}%
-->


-->

<form action="%SCRIPTURL{view}%/%BASEWEB%/%BASETOPIC%">
<input type="hidden" name="viewtheme" value="1" />
<input type="hidden" name="layout" value="%PUBURLPATH%/%SYSTEMWEB%/PatternSkinTheme2012/layout.css" />
Expand Down Expand Up @@ -58,7 +58,7 @@ This is just a stopgap for now, Arthur is working on a real skin :)
%INCLUDE{
"%SYSTEMWEB%.WebCreateNewTopicComponents"
override="%WEB%.%TOPIC%"
sectionlist="themesettings"
sectionlist="themesettings"
section="newtopic"
defaultweb="%MAINWEB%"
newtopic="%WIKINAME%"
Expand Down
6 changes: 3 additions & 3 deletions TopicUserMappingContrib/data/System/ManagingUsers.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1419139236" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1420154378" format="1.1" version="1"}%
%META:TOPICPARENT{name="ReferenceManual"}%
%STARTINCLUDE%
---+ Manage Users
Expand Down Expand Up @@ -318,6 +318,6 @@ Pending registration requests are stored in the
*Related Topics:* AdminDocumentationCategory
<!-- %JQREQUIRE{"chili"}% -->

%META:PREFERENCE{name="ALLOWTOPICCHANGE" title="ALLOWTOPICCHANGE" type="Set" value="Main.AdminGroup"}%
%META:PREFERENCE{name="ALLOWTOPICCHANGE" title="ALLOWTOPICCHANGE" type="Set" value="AdminGroup"}%
%META:PREFERENCE{name="PERMSET_CHANGE" title="PERMSET_CHANGE" type="Local" value="details"}%
%META:PREFERENCE{name="PERMSET_CHANGE_DETAILS" title="PERMSET_CHANGE_DETAILS" type="Local" value="Main.AdminGroup"}%
%META:PREFERENCE{name="PERMSET_CHANGE_DETAILS" title="PERMSET_CHANGE_DETAILS" type="Local" value="AdminGroup"}%
4 changes: 2 additions & 2 deletions core/data/Sandbox/WebHome.txt
@@ -1,9 +1,9 @@
%META:TOPICINFO{author="ProjectContributor" date="1308332134" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1420148306" format="1.1" version="1"}%
---+!! %MAKETEXT{"Welcome to the [_1] web" args="<nop>%WEB%"}%
%MAKETEXT{"The [_1] web is the sandbox you can use for testing. Everybody is welcome to add or delete some stuff. It is recommended to walk through the [_2] to get a jumpstart on the [_3] tool. A good rule of thumb is to add at the end of the page and sign and date it with your [_4]." args="<b><nop>%WEB%</b>,%SYSTEMWEB%.TwentyMinuteTutorial,<nop>%WIKITOOLNAME%,%SYSTEMWEB%.WikiName"}%

<!--
To include a custom "create new topic" form on a page, see System.WebCreateNewTopicComponents
To include a custom "create new topic" form on a page, see %SYSTEMWEB%.WebCreateNewTopicComponents
-->
%TWISTY{
link="%BUTTON{"%MAKETEXT{"Create New Topic"}%" icon="add"}%%CLEAR%"
Expand Down
24 changes: 12 additions & 12 deletions core/data/System/BeginnersStartHere.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1419938319" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1420147851" format="1.1" version="1"}%
%META:TOPICPARENT{name="UsersGuide"}%
---+!! %TOPIC%

Expand Down Expand Up @@ -256,7 +256,7 @@ Foswiki understands pages in plain text just fine, but you can %RED% __jazz__ %E
* An ordinary URL pasted into text will appear as a link - http://www.google.com
* You can also prettify URLs using square brackets:
* =[<nop>[http://www.google.com/][Google]]= appears as [[http://www.google.com/][Google]]
* Use %<nop>SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See [[System.Macros][%SYSTEMWEB%.Macros]] for full details.
* Use %<nop>SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See [[%SYSTEMWEB%.Macros][%SYSTEMWEB%.Macros]] for full details.

---++ More formatting
* There's *lots* more formatting available, see %SYSTEMWEB%.TextFormattingRules and %SYSTEMWEB%.WikiSyntax
Expand Down Expand Up @@ -387,13 +387,13 @@ If you get stuck, you can refer to the http://foswiki.org/Support web, which has

__Related topics:__ WelcomeGuest, WikiCulture, TwentyMinuteTutorial, TopicsAndWebs

%META:FILEATTACHMENT{name="myco.gif" attachment="myco.gif" attr="h" comment="" date="1394884241" size="1834" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="whiteboard.gif" attachment="whiteboard.gif" attr="h" comment="" date="1394884243" size="13471" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="SAP_logo.gif" attachment="SAP_logo.gif" attr="h" comment="" date="1394884244" size="2711" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="Motorola_logo.gif" attachment="Motorola_logo.gif" attr="h" comment="" date="1394884246" size="2394" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="lego.gif" attachment="lego.gif" attr="h" comment="" date="1394884248" size="4084" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="hula.gif" attachment="hula.gif" attr="h" comment="" date="1394884249" size="8780" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="EpicGames_logo.gif" attachment="EpicGames_logo.gif" attr="h" comment="" date="1394884251" size="2270" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="Disney_logo.gif" attachment="Disney_logo.gif" attr="h" comment="" date="1394884253" size="1506" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="BT_logo.gif" attachment="BT_logo.gif" attr="h" comment="" date="1394884254" size="1687" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="camel.png" attachment="camel.png" attr="h" comment="" date="1419938319" size="1687" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="myco.gif" attachment="myco.gif" attr="h" comment="" date="1420147851" size="1834" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="whiteboard.gif" attachment="whiteboard.gif" attr="h" comment="" date="1420147851" size="13471" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="SAP_logo.gif" attachment="SAP_logo.gif" attr="h" comment="" date="1420147851" size="2711" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="Motorola_logo.gif" attachment="Motorola_logo.gif" attr="h" comment="" date="1420147851" size="2394" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="lego.gif" attachment="lego.gif" attr="h" comment="" date="1420147851" size="4084" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="hula.gif" attachment="hula.gif" attr="h" comment="" date="1420147851" size="8780" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="EpicGames_logo.gif" attachment="EpicGames_logo.gif" attr="h" comment="" date="1420147851" size="2270" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="Disney_logo.gif" attachment="Disney_logo.gif" attr="h" comment="" date="1420147851" size="1506" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="BT_logo.gif" attachment="BT_logo.gif" attr="h" comment="" date="1420147851" size="1687" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="camel.png" attachment="camel.png" attr="h" comment="" date="1420147851" size="1687" user="ProjectContributor" version="1"}%
18 changes: 9 additions & 9 deletions core/data/System/IfStatements.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1416592876" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1420154378" format="1.1" version="1"}%
%META:TOPICPARENT{name="DeveloperDocumentationCategory"}%
---+!! IF statements

Expand All @@ -20,8 +20,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 [[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) &#124;&#124; $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) &#124;&#124; $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 ="=. |

The =%<nop>IF%= statement is deliberately kept simple. In particular, note that there is no way to conditionally execute a Set statement. If you need more sophisticated control over formatting, then consider using the SpreadSheetPlugin.
Expand Down Expand Up @@ -75,7 +75,7 @@ Note that macro =URLPARAM= is evaluated before the =IF= macro, therefore the exp

Example:
<verbatim class="tml">
url param t is %IF{
URL param t is %IF{
"0 < $t and $t < 1000"
then="in"
else="out of"
Expand Down Expand Up @@ -126,12 +126,12 @@ Be careful when you test for an empty value: if the URL parameter is not defined
| %IF{"$paramtest=1 and $paramvalue=1" then='%IF{"defined scope" then='true'}%'}% |
| is empty \
| =$scope=''= \
| %IF{"$paramtest=1 and $noparam=1" then='%IF{"$scope=''" else='false %RED%NOTE: value is undefined, so not empty%ENDCOLOR%'}%'}% \
| %IF{"$paramtest=1 and $noparam=1" then="%IF{"$scope=''" else="false %RED%NOTE: value is undefined, so not empty%ENDCOLOR%"}%"}% \
| %IF{"$paramtest=1 and $emptyparam=1" then='%IF{"$scope=''" then='true'}%'}% \
| %IF{"$paramtest=1 and $paramvalue=1" then='%IF{"$scope=''" else='false'}%'}% |
| is not empty \
| =$scope!=''= \
| %IF{"$paramtest=1 and $noparam=1" then='%IF{"$scope!=''" then='true %RED%NOTE: value is undefined, so also \\'not empty\\'%ENDCOLOR%'}%'}% \
| %IF{"$paramtest=1 and $noparam=1" then="%IF{"$scope!=''" then="true %RED%NOTE: value is undefined, so also \\'not empty\\'%ENDCOLOR%"}%"}% \
| %IF{"$paramtest=1 and $emptyparam=1" then='%IF{"$scope!=''" else='false'}%'}% \
| %IF{"$paramtest=1 and $paramvalue=1" then='%IF{"$scope!=''" then='true'}%'}% |
| has value =text= \
Expand Down Expand Up @@ -241,7 +241,7 @@ TablePlugin is %IF{
Example:
<verbatim class="tml">
You %IF{"'%TOPIC%' allows 'change'" then="can" else="cannot"}% change this topic.
You %IF{"'Sandbox.TestTopic' allows 'change'" then="can" else="cannot"}% change Sandbox.TestTopic.
You %IF{"'%SANDBOXWEB%.TestTopic' allows 'change'" then="can" else="cannot"}% change %SANDBOXWEB%.TestTopic.
You %IF{"'Sandbox' allows 'change'" then="can" else="cannot"}% change Sandbox web
</verbatim>

Expand All @@ -250,8 +250,8 @@ You %IF{"'Sandbox' allows 'change'" then="can" else="cannot"}% change Sandbox we

Example:
<verbatim class="tml">
Topic Sandbox.TestTopic %IF{"istopic 'Sandbox.TestTopic'" then="exists" else="does not exist"}%.
Web Sandbox %IF{"isweb 'Sandbox'" then="exists" else="does not exist"}%.
Topic %SANDBOXWEB%.TestTopic %IF{"istopic '%SANDBOXWEB%.TestTopic'" then="exists" else="does not exist"}%.
Web %SANDBOXWEB% %IF{"isweb '%SANDBOXWEB%'" then="exists" else="does not exist"}%.
</verbatim>

---+++ Group membership
Expand Down
12 changes: 6 additions & 6 deletions core/data/System/InstallationGuide.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1419310881" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1420147851" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
---+ Installation Guide

Expand Down Expand Up @@ -166,7 +166,7 @@ The configure tool should generally be restricted to a very small subset of user
#AuthenticationOfUsers
---+++ Step 7: Authentication

Authentication of users means their activity can be tracked, and access to your site can be controlled. *This is particularly important for sites that are publicly accessible on the web.* You are strongly encouraged to read [[System.UserAuthentication][%SYSTEMWEB%.UserAuthentication]] and Foswiki:Support.UserAuthenticationSupplement for further information about managing users and access controls for your Foswiki site.
Authentication of users means their activity can be tracked, and access to your site can be controlled. *This is particularly important for sites that are publicly accessible on the web.* You are strongly encouraged to read [[%SYSTEMWEB%.UserAuthentication][%SYSTEMWEB%.UserAuthentication]] and Foswiki:Support.UserAuthenticationSupplement for further information about managing users and access controls for your Foswiki site.

The most common authentication methods used for public Foswiki installations are Template Login and Apache Login. They have the following relative advantages:
* Template Login can be set up without any web server configuration, and users can log off without restarting the browser. As the login page is just a Wiki page, you can customize it to suit your needs.
Expand Down Expand Up @@ -224,23 +224,23 @@ To add an initial administrator to the =AdminGroup=, perform the following steps
* Go to the =[[%USERSWEB%.AdminGroup]]= topic and select the "internal admin login" link. Login using the password you set on the =configure= page.
* After you have logged in as the internal admin, view the =%USERSWEB%.AdminGroup= topic. Follow the instructions on the page to add users to the %USERSWEB%.AdminGroup. You do _not_ need to edit the topic.

Any member of the %USERSWEB%.AdminGroup can add subsequent members you do not have to use the internal admin login.
Any member of the %USERSWEB%.AdminGroup can add subsequent members, you do not have to use the internal admin login.

To more easily debug access control issues, you may want to have a regular Foswiki user account for daily use, and a special one that belongs to the =AdminGroup= that you use only for administering your Foswiki site. See [[System.AccessControls][%SYSTEMWEB%.AccessControls]] for more information on access controls and user groups.
To more easily debug access control issues, you may want to have a regular Foswiki user account for daily use, and a special one that belongs to the =AdminGroup= that you use only for administering your Foswiki site. See [[%SYSTEMWEB%.AccessControls][%SYSTEMWEB%.AccessControls]] for more information on access controls and user groups.

---+++ Congratulations!

You now have set up your Foswiki installation! At this point you can start creating and editing pages. See InstallationGuidePart2 to proceed with further tailoring your site.

In order to keep your user, group, and site configuration information separate from the actual content of your site, it is recommended that you create a new web in which your site's pages will reside. See [[System.ManagingWebs][%SYSTEMWEB%.ManagingWebs]] for more information on Wiki webs and how to create one.
In order to keep your user, group, and site configuration information separate from the actual content of your site, it is recommended that you create a new web in which your site's pages will reside. See [[%SYSTEMWEB%.ManagingWebs][%SYSTEMWEB%.ManagingWebs]] for more information on Wiki webs and how to create one.

#TroubleshootingInstall
---++ Troubleshooting

If you are having problems with your installation, try the following:

* Run the =configure= script and ensure you have resolved all errors and are satisfied that you understand any warnings.
* Review the [[System.PerlDependencyReport][%SYSTEMWEB%.PerlDependencyReport]] and sure all dependencies are correctly resolved.
* Review the [[%SYSTEMWEB%.PerlDependencyReport][%SYSTEMWEB%.PerlDependencyReport]] and sure all dependencies are correctly resolved.
* Consult the topics at Foswiki:Support.SupplementalDocuments and Foswiki:Support.AskedQuestions.
* Ask for help on [[Foswiki:Community.InternetRelayChat][IRC]] (irc.freenode.net, channel #foswiki). There are often a number of people waiting to help.
* Ask a question in the Foswiki:Support web
Expand Down
4 changes: 2 additions & 2 deletions core/data/System/ReleaseNotes01x02.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1419142002" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1420147851" format="1.1" version="1"}%
%META:TOPICPARENT{name="ReleaseHistory"}%
---+!! Foswiki Release 1.2 - not released yet
%RED% These are not actual release notes, but a collection of documented changes that we should not forget to mention. %ENDCOLOR%
Expand Down Expand Up @@ -232,7 +232,7 @@ macro to generate singe quotes by default. This has no impact unless the

In order to simplify migration, a new =quote== parameter has been added to the
ICON macro. =%<nop>ICON{"pdf" quote="\""}%= generates the html using double
quotes delimiters. See System.VarICON for more details.
quotes delimiters. See %SYSTEMWEB%.VarICON for more details.

---++ Foswiki Release 1.2 Details

Expand Down

0 comments on commit 150b76f

Please sign in to comment.