Item11383: Miscellaneous doc updates

git-svn-id: http://svn.foswiki.org/branches/Release01x01@14121 0b4bb1d4-4e5a-0410-9cc4-b2b747904278

core/data/System/BeginnersStartHere.txt

@@ -138,7 +138,7 @@ Your wiki may contain any number of webs, and webs can contain other webs.
 
 ---++ The menu - part 3
 
-Besides the Tools and Webs sections it it common to add your own links to important places.
+Besides the Tools and Webs sections it is common to add your own links to important places.
 
 These menu points can be different from web to web.
 

core/data/System/EditingShorthand.txt

@@ -313,7 +313,7 @@ Each row of the table is a line containing of one or more cells. Each cell start
 <verbatim class="tml">
 | *L* | *C* | *R* |
 | A2 |  B2  |  C2 |
-| A3 |  B3  |  C3 |
+  | A3 |  B3  |  C3 |
 | multi span |||
 | A5-7 |  5  |  5 |
 |^| six | six |
@@ -322,12 +322,14 @@ Each row of the table is a line containing of one or more cells. Each cell start
   | over\
   | 3 lines |
 | A9 |  B9  |  C9 |
+| %CARET% | B10 |%VBAR%|
+| &#94; | B11 |&#124;|
 </verbatim>
 </td><td>
 
 | *L* | *C* | *R* |
 | A2 |  B2  |  C2 |
-| A3 |  B3  |  C3 |
+  | A3 |  B3  |  C3 |
 | multi span |||
 | A5-7 |  5  |  5 |
 |^| six | six |
@@ -336,6 +338,8 @@ Each row of the table is a line containing of one or more cells. Each cell start
   | over\
   | 3 lines |
 | A9 |  B9  |  C9 |
+| %CARET% | B10 |%VBAR%|
+| &#94; | B11 |&#124;|
 </td>
 </tr>
 <tr valign="top">
@@ -372,7 +376,7 @@ It's generally a good idea to use the [[%SYSTEMWEB%.Macros][macros]] %<nop>SYSTE
 <tr valign="top">
 <td>
  *<nop>Acronym  Links:* %BR%
- <nop>Words that are all capitals will produce a link automatically _only_ if the topic aready exists!. 
+ <nop>Words that are all capitals will produce a link automatically _only_ if the topic already exists!. 
 </td><td>
 <verbatim class="tml">
 ACRONYM
@@ -421,7 +425,7 @@ Text within the brackets may contain optional spaces; the topic name is formed b
 <pre class="tml">
 [[wiki syntax]]
 
-[[%SANDBOXWEB%.My unspaced topic]]
+[[%USERSWEB%.Wiki groups]]
 
 escaped:
 ![[wiki syntax]]
@@ -471,7 +475,7 @@ The rules described under *Forced Links* apply for internal link references.
 <td>
  *Disable Links:* %BR%
  You can disable automatic linking of WikiWords by surrounding text with =&lt;noautolink&gt;= and =&lt;/noautolink&gt;= tags.%BR%
-%H% It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.
+%H% It is possible to turn off all auto-linking with a NOAUTOLINK [[%SYSTEMWEB%.PreferenceSettings][preference setting]].
 </td><td>
 <verbatim class="tml">
  <noautolink>
@@ -514,9 +518,11 @@ a@b.com
  *Literal content:* %BR%
  Foswiki generates HTML code from TML shorthand.
  *Experts* surround anything that must be output literally in the HTML code, without the application of
- shorthand rules, with =&lt;literal&gt;..&lt;/literal&gt;= tags. %X% any HTML
+ shorthand rules, with =&lt;literal&gt;..&lt;/literal&gt;= tags. 
+ %BR% %X% Any HTML
  within literal tags *must* be well formed i.e. all tags must be properly closed before
- the end of the literal block. %I% Macros are expanded within literal blocks.
+ the end of the literal block. 
+ %BR% %I% Macros are expanded within literal blocks.
 </td><td>
 <pre>
 &lt;literal&gt;
@@ -539,19 +545,27 @@ a@b.com
  protected from a WYSIWYG editor (usually because it isn't well-formed HTML, or because it
  is HTML that WYSIWYG would normally filter out or modify). Protected
  content appears as plain text in the WYSIWYG editor.
+ %BR% %X% Any HTML within sticky tags *must* be well formed
+ i.e. all tags must be properly closed before
+ the end of the sticky block. 
+ %BR% %I% Macros are expanded within sticky blocks.
 </td><td>
 <verbatim class="tml">
 <sticky>
 <div>
-This div is required
+This div
+%RED%is%ENDCOLOR%
+required
 </div>
 </sticky>
 </verbatim>
 </td>
 <td>
 <sticky>
 <div>
-This div is required
+This div
+%RED%is%ENDCOLOR%
+required
 </div>
 </sticky>
 </td>

core/data/System/ManagingTopics.txt

@@ -12,17 +12,22 @@ _Browser-based rename, move, copy, and delete for individual topics_
 You can use browser-based controls to change a name of a topic, move it to another web or delete it to a hidden =Trash= web.
 
 %STARTSECTION{"PowerUserGuide"}%
----++ How to rename, move or delete a topic
+---++ How to rename or move a topic
 
-   1. *Select* the ==[More actions]== link (normally located in an action toolbar at the top or bottom of page) on the topic to be changed. Then, in the new screen, click ==[Rename, move or delete this topic]==. You can now rename and/or move/delete in one operation:
-      * *Move/Delete:* Select the target web if other than the current web - choose =Trash= to [[#DeleteTopic][delete a topic]].
+   1. *Select* the ==[More actions]== link (normally located in an action toolbar at the top or bottom of page) on the topic to be changed. Then, in the new screen, click ==[Rename or move topic...]== or ==[Delete topic...]==. You can now rename and/or move in one operation:
+      * *Move:* Select the target web if other than the current web
       * *Rename:* Enter the new topic name - default is current name
       <blockquote class="foswikiHelp">%X% You'll be warned if any of the topics to be affected are locked (being edited), or if there is a name conflict.</blockquote>
    1. *Prevent updates* by unchecking individual items on the list of referring links - these topics will NOT to be updated with the new name (by default, *only links in the same web* will be updated).
    1. *Click* on ==[Rename]==: the topic will be renamed and links to the topic updated as requested.
       * If any of the referring pages are locked then they will be listed: you can correct these later by again pressing ==[Rename]==.
       <blockquote class="foswikiHelp">%H% There is a *Put back* feature that allows you to undo a ==rename/move/delete== action - an instruction line and an undo link will appear at the bottom of the modified topic. This allows you to revert from the _last modification only_.</blockquote>
 
+---++ How to delete a topic
+Foswiki deletes topics by moving them to the hidden =Trash= web.
+   1. *Select* the ==[More actions]== link (normally located in an action toolbar at the top or bottom of page) on the topic to be changed. Then, in the new screen, click ==[Delete topic...]==. That will bring up the "rename" form prepopulated with the =Trash= web and a suitable topic name.
+   1. *Click* on ==[Delete]==: the topic will be renamed and moved to the =Trash= web as requested.
+
 #CopyTopic
 ---++ How to copy a topic
 \
@@ -51,6 +56,7 @@ they will be able to click through to the new name.
    1. %<nop>SEARCH%, with a special template, finds and displays all occurrences of the topic name in other topics, either web- or site-wide. These referring links are by default automatically changed to the new topic and/or web name. This includes relevant MetaData definitions.
       * User can omit one or more topics from the update list by unchecking them.
       * =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas.
+        %BR% %X% Foswiki will therefore _not_ change any references in [[Macros][macros]] defined in =&lt;pre&gt;= and =&lt;verbatim&gt;= blocks
    2. The topic is moved (if locks allow).
    3. References are changed (locks and permissions permitting).
    4. Any referring topics that cannot be changed due to locks are listed - user can take note and change them at another time.
@@ -59,7 +65,7 @@ they will be able to click through to the new name.
 
 First, matching topics in the current web are listed - matches are to ==topic==.  Next, all webs (including the current one) are listed that match ==web.topic==. _All_ webs will be searched during rename, even if =NOSEARCHALL= is defined on a web, though access permissions will of course be honoured.
 
-Changed references are kept as short as possible, ex: =topic= is used in preference to =web.topic=.
+Changed references are kept as short as possible, for example: =topic= is used in preference to =web.topic=.
 
 ---+++ Effect of user access settings
 
@@ -69,7 +75,7 @@ User permissions affect the 'rename' functions in various ways. To rename a topi
 
 Consider carefully whether to make browser-based *rename/move/delete* widely available, or to restrict it to an administrator/moderator group. Allowing all users to easily manipulate topics can be extremely useful in refactoring a busy web or site. However, there are at least two significant potential drawbacks to take into account: 
    1. When referring links are updated, the modified topics appear in WebChanges, creating the impression that editorial changes were made. This can undermine the usefulness of WebChanges.
-   2. Due to [[#RenameLimitations][current limitations]], fairly heavy use of rename/move/delete functions can lead to an accumulation of minor technical problems (ex: broken links) and usability issues (ex: user confusion). If rename... is used heavily, these negatives will obviously increase, in number and effect.
+   2. Due to [[#RenameLimitations][current limitations]], fairly heavy use of rename/move/delete functions can lead to an accumulation of minor technical problems (such as broken links) and usability issues (e.g. user confusion). If rename... is used heavily, these negatives will obviously increase, in number and effect.
 
 Ultimately, the size, objectives, and policies of your site, the real-world behavior of your user group, and most importantly, the initial Foswiki site management leadership, will determine the most effective implementation of this feature, and the success of the site overall.
 

core/data/System/ManagingWebs.txt

@@ -66,7 +66,7 @@ Before you begin: consider that less webs are better than more webs. Cross-linki
 				%TWISTYTOGGLE{id="infoOnNestedWebs"}%<div class="foswikiHelp">
 					<h4>About hierarchical webs</h4>
 					<p>
-						You can only create hierarchical webs if the ={EnableHierarchicalWebs}= setting in [[%SCRIPTURLPATH{"configure"}%#Store][configure]] is enabled.  %IF{"{EnableHierarchicalWebs}" then='%GREEN% Hierarchical webs are currently enabled %ENDCOLOR%.' else='%RED Hierarchical webs are currently disabled %ENDCOLOR%. Without this setting, Foswiki will only allow a single level of hierarchy. With it, you can use multiple levels, like a directory tree, i.e. webs within webs.'}%
+						You can only create hierarchical webs if the ={EnableHierarchicalWebs}= setting in [[%SCRIPTURLPATH{"configure"}%#Store][configure]] is enabled.  %IF{"{EnableHierarchicalWebs}" then="%GREEN% Hierarchical webs are currently enabled %ENDCOLOR%." else="%RED% Hierarchical webs are currently disabled %ENDCOLOR%. Without this setting, Foswiki will only allow a single level of hierarchy. With it, you can use multiple levels, like a directory tree, i.e. webs within webs."}%
 					</p>
 					<p>
 						You might not need hierarchical webs. Foswiki topics already have a parent/child relationship within a web, which is shown in the breadcrumb. Try to keep the number of webs to a minimum in order to keep search and cross-referencing simple.

core/data/System/TopicsAndWebs.txt

@@ -57,8 +57,8 @@ Foswiki makes it easy to add and edit topics or link between them.
    * Click ==Save== to save.
 
 *To add a new topic* there are three ways in the default PatternSkin:
-   1 Create a link to the topic which doesn't exist yet, Eg. by editing a topic and typing a WikiName. When the topic is saved, the link will be shown with a *?*: click the *?* and a new edit window appears.
-   1 Navigate to the topic which doesn't exist yet, Eg. by typing the name of topic in the [[GoBox][JumpBox]]. Foswiki should display a screen which invites you to create the topic.
+   1 Create a link to the topic which doesn't exist yet, e.g. by editing a topic and typing a WikiName. When the topic is saved, the link will be shown with a *?*: click the *?* and a new edit window appears.
+   1 Navigate to the topic which doesn't exist yet, e.g. by typing the name of topic in the [[GoBox][JumpBox]]. Foswiki should display a screen which invites you to create the topic.
    1 Click the ==Create New Topic== link in the WebLeftBar links down the left side of the page (assuming default PatternSkin). Foswiki should display a screen which invites you to create the topic.
 
 #TopicNames
@@ -101,12 +101,12 @@ If a user navigates to a Foswiki site without specifying a web, the default [[%U
 Each web has:
    * name
       * [[#TopicNames][topic naming rules]] apply to web names
-      * there is no ability to refer to _subwebs_ with a _relative_ path, IE. they must always be _fully qualified_ - referred to in full, with the parent web(s) prefixed
+      * there is no ability to refer to _subwebs_ with a _relative_ path, i.e. they must always be _fully qualified_ - referred to in full, with the parent web(s) prefixed
          * the '.' and '/' characters serve as _path delimiters_ to a web or topic
          * example: [[%SANDBOXWEB%/MySubWeb/MySubSubWeb.MyTopic]]
-         * it is possible in Foswiki to have a subweb which is the same name as a topic. For this reason, if there is a web named =%SANDBOXWEB%/MySubWeb=, navigating to it must be done so using a trailing slash, IE. =%SANDBOXWEB%/MySubWeb/=. Without the trailing slash, Foswiki tries to display the _topic_ named =%SANDBOXWEB%.MySubWeb=
+         * it is possible in Foswiki to have a subweb which is the same name as a topic. For this reason, if there is a web named =%SANDBOXWEB%/MySubWeb=, navigating to it must be done so using a trailing slash, i.e. =%SANDBOXWEB%/MySubWeb/=. Without the trailing slash, Foswiki tries to display the _topic_ named =%SANDBOXWEB%.MySubWeb=
    * WebPreferences topic
-      * sets PreferenceSettings to be inherited by all contained topics, EG. [[AccessControl][access controls]], and:
+      * sets PreferenceSettings to be inherited by all contained topics, e.g. [[AccessControl][access controls]], and:
          * =FINALPREFERENCES= to prevent subwebs and topics from overriding inherited PreferenceSettings
          * =WEBFORMS= to specify a list of DataForms that users should be able to attach to contained topics
          * =WEBCOPYRIGHT= to customise copyright message for all contained topics