Changeset 851


Ignore:
Timestamp:
11/22/08 13:46:51 (4 years ago)
Author:
CrawfordCurrie
Message:

Item175: massive review of use of the T* word and appropriate defusing

Location:
trunk/core/data
Files:
116 edited

Legend:

Unmodified
Added
Removed
  • trunk/core/data/Main/AdminUser.txt

    r682 r851  
    22---+ Wiki Administrator User 
    33 
    4 The %TOPIC% has been added to TWiki 4.2.0 to make it possible to login without needing to create a TWiki User, 
     4The %TOPIC% allows you to login without needing to register a user, 
    55or to temporarily login as %TOPIC% using the password set in configure, and then log back out to the same User and Group as before. 
    66 
     
    1717__%X% NOTE:__ If you lock yourself out of <nop>AdminUser during setup activities or have forgotten the configure password, 
    1818you can unset the configure password by editing the =lib/LocalSite.cfg= file and deleting the line that starts 
    19 with =$TWiki::cfg{Password}= and then set it again by saving your settings in =configure=. 
     19with =Foswiki::cfg{Password}= and then set it again by saving your settings in =configure=. 
    2020%ENDSECTION{"sudo_login"}% 
    2121 
     
    2323   * =Security Setup : Sessions : {UserClientSession}= needs to be enabled in configure 
    2424   * a configure password (otherwise the Admin login is automatically disabled.) 
    25    * If your TWiki is configured to use !ApacheLoginManager, you will need to log in as a valid user first. 
     25   * If your Foswiki is configured to use !ApacheLoginManager, you will need to log in as a valid user first. 
    2626    
    2727__Related topics:__ [[%WIKIUSERSTOPIC%]], [[AdminGroup]], [[WikiGroups]], [[%SYSTEMWEB%.AccessControl][AccessControl]] 
  • trunk/core/data/Main/ProjectContributor.txt

    r733 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1127386324" format="1.1" version="$Rev: 15171 $"}% 
    2 ---+ TWiki Contributor 
     2---+ Project Contributor 
    33 
    4 Not an actual user of this site, but a person devoting some of his/her time to contribute to the Open Source TWiki project. [[%SYSTEMWEB%.ProjectContributor][ProjectContributor]] lists the people involved. 
     4Not an actual user of this site, but a person devoting some of his/her time to contribute to the Foswiki Open Source project. [[%SYSTEMWEB%.ProjectContributor][ProjectContributor]] lists the people involved. 
    55 
    66__Related topics:__ [[%WIKIUSERSTOPIC%]], [[%SYSTEMWEB%.UserRegistration][UserRegistration]] 
  • trunk/core/data/Main/UnknownUser.txt

    r733 r851  
    22---+ The <nop>UnknownUser User 
    33 
    4 !UnknownUser is a reserved name in TWiki. If the !UnknownUser appears, it is probably because author information for a topic could not be recovered, perhaps because a topic has been modified by a non-TWiki tool. 
     4!UnknownUser is a reserved name. If the !UnknownUser appears, it is probably because author information for a topic could not be recovered, perhaps because a topic has been modified by a non-Foswiki tool. 
    55 
    66__Related topics:__ [[%WIKIUSERSTOPIC%]], [[%SYSTEMWEB%.UserRegistration][UserRegistration]] 
  • trunk/core/data/Main/WebHome.txt

    r733 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1120846368" format="1.1" version="$Rev: 15171 $"}% 
    22---+!! Welcome to the <nop>%USERSWEB% web  
    3 Congratulations, you have finished installing TWiki. 
     3Congratulations, you have finished installing Foswiki. 
    44 
    5 This site is running TWiki version *%WIKIVERSION%*, Plugin API version *%PLUGINVERSION{}%* 
     5This site is running Foswiki version *%WIKIVERSION%*, Plugin API version *%PLUGINVERSION{}%* 
    66 
    7 To learn more about TWiki, visit the [[%SYSTEMWEB%.WebHome][TWiki web]]. Please ensure that the read/write 
     7To learn more about Foswiki, visit the [[%SYSTEMWEB%.WebHome][%SYSTEMWEB% web]]. Please ensure that the read/write 
    88permissions for each web on your site match your access control policies (see [[%SYSTEMWEB%.DefaultPreferences]]  
    99and [[%USERSWEB%.SitePreferences]]). Replace this text with a description of your new 
    10 %IF{"defined WIKITOOLNAME" then="<nop>%WIKITOOLNAME%" else="TWiki"}% site.  
     10%IF{"defined WIKITOOLNAME" then="<nop>%WIKITOOLNAME%" else="Foswiki"}% site.  
    1111 
    1212---++ <nop>%WEB% Web Utilities 
  • trunk/core/data/Main/WebPreferences.txt

    r682 r851  
    1515      * Set WEBBGCOLOR = #FFEFA6 
    1616      * Set SITEMAPWHAT = Welcome to <nop>%WIKITOOLNAME%... [[%WEB%.%WIKIUSERSTOPIC%][Users]], [[%WEB%.WikiGroups][Groups]] 
    17       * Set SITEMAPUSETO = ...see who is registered on this TWiki 
     17      * Set SITEMAPUSETO = ...see who is registered on this site 
    1818      * Set SITEMAPLIST = on 
    1919 
  • trunk/core/data/Main/WebStatistics.txt

    r482 r851  
    88__Notes:__ 
    99   * Do not edit this topic, it is updated automatically. (You can also [[%SCRIPTURL{"statistics"}%/%WEB%][force]] an update) 
    10    * [[%SYSTEMWEB%.TWikiSiteTools#WebStatistics_site_statistics][TWikiSiteTools]] tells you how to enable the automatic updates of the statistics. 
     10   * [[%SYSTEMWEB%.SiteTools#WebStatistics_site_statistics][Site tools]] tells you how to enable the automatic updates of the statistics. 
    1111        * Suggestion: You could archive this topic once a year and delete the previous year's statistics from the table. 
    1212 
  • trunk/core/data/Main/WikiGuest.txt

    r733 r851  
    22---+ The <nop>WikiGuest User 
    33 
    4 A guest of this TWiki web, not unlike yourself. You can leave your trace behind you, just add your name in [[%SYSTEMWEB%.UserRegistration][UserRegistration]] and create your own page. 
     4A guest of this web, not unlike yourself. You can leave your trace behind you, just add your name in [[%SYSTEMWEB%.UserRegistration][UserRegistration]] and create your own page. 
    55 
    66__Related topics:__ [[%WIKIUSERSTOPIC%]], [[%SYSTEMWEB%.UserRegistration][UserRegistration]] 
  • trunk/core/data/Sandbox/WebStatistics.txt

    r482 r851  
    88__Notes:__ 
    99   * Do not edit this topic, it is updated automatically. (You can also [[%SCRIPTURL{"statistics"}%/%WEB%][force]] an update) 
    10    * [[%SYSTEMWEB%.TWikiSiteTools#WebStatistics_site_statistics][TWikiSiteTools]] tells you how to enable the automatic updates of the statistics. 
     10   * [[%SYSTEMWEB%.SiteTools#WebStatistics_site_statistics][Site tools]] tells you how to enable the automatic updates of the statistics. 
    1111        * Suggestion: You could archive this topic once a year and delete the previous year's statistics from the table. 
    1212 
  • trunk/core/data/System/AccessControl.txt

    r755 r851  
    1212---++ An Important Control Consideration 
    1313 
    14 Open, freeform editing is the essence of WikiCulture - what makes TWiki different and often more effective than other collaboration tools. For that reason, it is strongly recommended that decisions to restrict read or write access to a web or a topic are made with great care - the more restrictions, the less Wiki in the mix. Experience shows that _unrestricted write access_ works very well because: 
     14Open, freeform editing is the essence of WikiCulture - what makes Foswiki different and often more effective than other collaboration tools. For that reason, it is strongly recommended that decisions to restrict read or write access to a web or a topic are made with great care - the more restrictions, the less Wiki in the mix. Experience shows that _unrestricted write access_ works very well because: 
    1515   * *Peer influence* is enough to ensure that only relevant content is posted. 
    1616   * *Peer editing* - the ability for anyone to rearrange all content on a page - keeps topics focused. 
    17    * In TWiki, content is transparently preserved under *revision control*: 
     17   * In Foswiki, content is transparently preserved under *revision control*: 
    1818      * Edits can be undone by the administrator (per default a member of %USERSWEB%.AdminGroup; see [[#ManagingGroups]]). 
    1919      * Users are encouraged to edit and refactor (condense a long topic), since there's a safety net. 
     
    2222   * Avoid creating view-only Users (if you can read it, you should be able to contribute to it). 
    2323 
    24 ---++ Permissions settings of the webs on this TWiki site 
     24---++ Permissions settings of the webs on this Foswiki site 
    2525%INCLUDE{SitePermissions}% 
    2626 
     
    5050---+++ Managing Groups 
    5151 
    52 The following describes the standard TWiki support for groups. Your local TWiki may have an alternate group mapping manager installed. Check with your Wiki administrator if you are in doubt. 
     52The following describes the standard Foswiki support for groups. Your local Foswiki may have an alternate group mapping manager installed. Check with your Wiki administrator if you are in doubt. 
    5353 
    5454Groups are defined by group topics located in the ==%USERSWEB%== web. To create a new group, visit  %USERSWEB%.WikiGroups and enter the name of the new group ending in ==Group== into the "new group" form field. This will create a new group topic with two important settings: 
     
    6262   * ==Set <nop>ALLOWTOPICCHANGE = %USERSWEB%.<nop>KasabianGroup== 
    6363 
    64 __%X% Note:__ TWiki has strict formatting rules. Make sure you have three spaces, an asterisk, and an extra space in front of any access control rule. 
     64__%X% Note:__ Foswiki has strict formatting rules. Make sure you have three spaces, an asterisk, and an extra space in front of any access control rule. 
    6565 
    6666#SuperAdminGroup 
    6767---+++ The Super Admin Group 
    6868 
    69 A number of TWiki functions (for example, renaming webs) are only available to administrators. Administrators are simply users who belong to the *SuperAdminGroup*. This is a standard user group, the name of which is defined by {SuperAdminGroup} setting in [[%SCRIPTURLPATH{"configure"}%][configure]]. The default name of this group is the =AdminGroup=. The system administrator may have chosen a different name for this group if your local TWiki uses an alternate group mapping manager but for simplicity we will use the default name !AdminGroup in the rest of this topic. 
     69A number of Foswiki functions (for example, renaming webs) are only available to administrators. Administrators are simply users who belong to the *SuperAdminGroup*. This is a standard user group, the name of which is defined by {SuperAdminGroup} setting in [[%SCRIPTURLPATH{"configure"}%][configure]]. The default name of this group is the =AdminGroup=. The system administrator may have chosen a different name for this group if your local Foswiki uses an alternate group mapping manager but for simplicity we will use the default name !AdminGroup in the rest of this topic. 
    7070 
    7171You can create new administrators simply by adding them to the %USERSWEB%.AdminGroup topic. For example, 
    7272   * ==Set <nop>GROUP = <nop>%USERSWEB%.ElizabethWindsor, <nop>%USERSWEB%.TonyBlair== 
    73 A member of the Super Admin Group has unrestricted access throughout the TWiki, so only trusted staff should be added to this group. 
     73A member of the Super Admin Group has unrestricted access throughout the Foswiki, so only trusted staff should be added to this group. 
    7474 
    7575---++ Restricting Access 
     
    102102Creation and renaming of sub-webs is controlled by the WEBCHANGE setting on the parent web (or ROOTCHANGE for [[#RootWebs][root webs]]). Renaming is additionally restricted by the setting of WEBRENAME in the web itself. 
    103103 
    104 __Note:__  For Web level access rights Setting any of these settings to an empty value has the same effect as not setting them at all. Please note that the documentation of TWiki 4.0 and earlier versions of TWiki 4.1 did not reflect the actual implementation, e.g. an empty ALLOWWEBVIEW does _not_ prevent anyone from viewing the web, and an an empty DENYWEBVIEW does _not_ allow all to view the web. 
    105  
    106104---+++ Controlling access to a Topic 
    107105 
     
    120118   * ==Set <nop>ALLOWTOPICVIEW = <nop>== <br />This means the same as not setting it at all. (This was documented wrong in versions 4.0.X, 4.1.0 and 4.1.1) 
    121119 
    122    * ==Set <nop>DENYTOPICVIEW = <nop>== <br />Since TWiki 4.0 this means _do not deny anyone the right to view this topic_. If DENYTOPICVIEW is set to an empty value anyone has access even if ALLOWTOPICVIEW or ALLOWWEBVIEW is defined. This allows to have very restrictive default access rights to an entire web and still allow individual topics to have more open access. 
     120   * ==Set <nop>DENYTOPICVIEW = <nop>== <br />This means _do not deny anyone the right to view this topic_. If DENYTOPICVIEW is set to an empty value anyone has access even if ALLOWTOPICVIEW or ALLOWWEBVIEW is defined. This allows you to have very restrictive default access rights to an entire web and still allow individual topics to have more open access. 
    123121 
    124122The same rules apply to ALLOWTOPICCHANGE/DENYTOPICCHANGE and APPLYTOPICRENAME/DENYTOPICRENAME. Setting ALLOWTOPICCHANGE or ALLOWTOPICRENAME to en empty value means the same as not defining it. Setting DENYTOPICCHANGE or DENYTOPICRENAME to an empty value means that anyone can edit or rename the topic. 
     
    126124%X% If the same setting is defined multiple times the last one overrides the previous. They are not OR'ed together. 
    127125 
    128 %X% _The setting to an empty has caused confusion and great debate and it has been decided that the empty setting syntax will be replaced by something which is easier to understand in a later version of TWiki. A method to upgrade will be provided. Please read the release notes carefully when you upgrade._ 
    129  
    130 See "How TWiki evaluates ALLOW/DENY settings" below for more on how ALLOW and DENY interacts. 
     126%X% _The setting to an empty has caused confusion and great debate and it has been decided that the empty setting syntax will be replaced by something which is easier to understand in a later version of Foswiki. A method to upgrade will be provided. Please read the release notes carefully when you upgrade._ 
     127 
     128See "How Foswiki evaluates ALLOW/DENY settings" below for more on how ALLOW and DENY interacts. 
    131129 
    132130---+++ Controlling access to Attachments 
    133131 
    134 Attachments are referred to directly, and are not normally indirected via TWiki scripts. This means that the above instructions for access control will _not_ apply to attachments. It is possible that someone may inadvertently publicise a URL that they expected to be access-controlled. 
    135  
    136 The easiest way to apply the same access control rules for attachments as apply to topics is to use the Apache =mod_rewrite= module, and configure your webserver to redirect accesses to attachments to the TWiki =viewfile= script. For example, 
     132Attachments are referred to directly, and are not normally indirected via Foswiki scripts. This means that the above instructions for access control will _not_ apply to attachments. It is possible that someone may inadvertently publicise a URL that they expected to be access-controlled. 
     133 
     134The easiest way to apply the same access control rules for attachments as apply to topics is to use the Apache =mod_rewrite= module, and configure your webserver to redirect accesses to attachments to the Foswiki =viewfile= script. For example, 
    137135 
    138136<verbatim> 
     
    141139 
    142140    RewriteEngine on 
    143     RewriteCond %{REQUEST_URI} !^/+twiki/+pub/+TWiki/+.+ 
     141    RewriteCond %{REQUEST_URI} !^/+twiki/+pub/+Foswiki/+.+ 
    144142    RewriteRule ^/+twiki/+pub/+([^/]+)/+((([^/]+)/+)+)(.+) /twiki/bin/viewfile/$1/$4?filename=$5 [L,PT] 
    145143</verbatim> 
     
    158156Note that you do *not* require =ROOTCHANGE= access to rename an existing top-level web. You just need =WEBCHANGE= in the web itself. 
    159157 
    160 ---+++ How TWiki evaluates ALLOW/DENY settings 
    161  
    162 When deciding whether to grant access, TWiki evaluates the following rules in order (read from the top of the list; if the logic arrives at *PERMITTED* or *DENIED* that applies immediately and no more rules are applied). You need to read the rules bearing in mind that VIEW, CHANGE and RENAME access may be granted/denied separately. 
     158---+++ How Foswiki evaluates ALLOW/DENY settings 
     159 
     160When deciding whether to grant access, Foswiki evaluates the following rules in order (read from the top of the list; if the logic arrives at *PERMITTED* or *DENIED* that applies immediately and no more rules are applied). You need to read the rules bearing in mind that VIEW, CHANGE and RENAME access may be granted/denied separately. 
    163161 
    164162   1 If the user is an [[#SuperAdminGroup][administrator]] 
     
    199197__%X% Note:__ Obfuscating a web without view access control is *very* insecure, as anyone who knows the URL can access the web. 
    200198 
    201 ---+++ Restrict Access to Whole TWiki Site 
    202  
    203 For a firewalled TWiki, e.g. an intranet wiki or extranet wiki, you want to allow only invited people to access your TWiki. In this case, enable [[UserAuthentication#ApacheLogin][user authentication with ApacheLogin]] and lock down access to the whole =twiki/bin= and =twiki/pub= directories to all but valid users. In the Apache =.htaccess= file or the appropriate =.conf= file, replace the =&lt;FilesMatch "(attach|edit|...= section with this: 
     199---+++ Restrict Access to Whole Foswiki Site 
     200 
     201For a firewalled Foswiki, e.g. an intranet wiki or extranet wiki, you want to allow only invited people to access your Foswiki. In this case, enable [[UserAuthentication#ApacheLogin][user authentication with ApacheLogin]] and lock down access to the whole =twiki/bin= and =twiki/pub= directories to all but valid users. In the Apache =.htaccess= file or the appropriate =.conf= file, replace the =&lt;FilesMatch "(attach|edit|...= section with this: 
    204202 
    205203<verbatim> 
  • trunk/core/data/System/AdminSkillsAssumptions.txt

    r606 r851  
    33---+ Administrator Skills Assumptions 
    44 
    5 __Note:__ If you aren't already fairly well-skilled in Linux/Unix/Windows, Apache, and so on, consider using TWiki:Codev.TWikiVMDebianStable - this can be installed on Windows or Linux, and makes it possible to get a working TWiki system within 5 minutes (after a fairly big download), ready to use from your browser.  This is ideal for personal use or evaluations - if you decide to go for production use then these !AdminSkillsAssumptions apply to some degree, but you are starting from a working system. 
     5__Note:__ If you aren't already fairly well-skilled in Linux/Unix/Windows, Apache, and so on, consider using TWiki:Codev.TWikiVMDebianStable - this can be installed on Windows or Linux, and makes it possible to get a working Foswiki system within 5 minutes (after a fairly big download), ready to use from your browser.  This is ideal for personal use or evaluations - if you decide to go for production use then these !AdminSkillsAssumptions apply to some degree, but you are starting from a working system. 
    66 
    7 If you need to install TWiki you'll need to either have or learn the following skills (even with !TWikiVMDebianStable, you'll need these for upgrades).  For each of these, the requirement is either pre-existing knowledge/skill, or the willingness to spend significant time (i.e. from hours to days) learning them: 
     7If you need to install Foswiki you'll need to either have or learn the following skills (even with !TWikiVMDebianStable, you'll need these for upgrades).  For each of these, the requirement is either pre-existing knowledge/skill, or the willingness to spend significant time (i.e. from hours to days) learning them: 
    88 
    99   * *Operating system administration:* Ability to use Unix/Linux command line tools (or equivalent Windows tools), including ability to move/copy/delete files, change permissions, view web server log files, set environment variables, use a text editor, etc. 
     
    1212   * *Troubleshooting*: Ability to perform tests, inspect error logs, talk to technical support (whether in an IT department or web hosting provider) and read documentation in order to help with diagnosing installation problems. 
    1313 
    14 Installing TWiki is *not* recommended for people who only know HTML and web design, unless they are willing to learn the above, or team up with someone who can handle the installation. 
     14Installing Foswiki is *not* recommended for people who only know HTML and web design, unless they are willing to learn the above, or team up with someone who can handle the installation. 
    1515 
    1616Although the InstallationGuide is quite complete, there will on occasion be parts that don't work in your local environment (particularly with TWiki:Codev/TWikiOnWebHostingSites, which are sometimes challenging even for those with good OS and web server skills). 
    1717 
    18 There are many excellent resources for learning how to administer your OS and web server, including books, web sites, web forums, IM and e-mail lists.   The TWiki:Support web must *not* be depended on as a resource for this purpose - in other words, it is not there to answer basic questions about operating system and web server administration.  Asking and answering questions is time consuming for all concerned and is best used for specific _TWiki related_ issues, rather than helping you learn the OS and web server. 
     18There are many excellent resources for learning how to administer your OS and web server, including books, web sites, web forums, IM and e-mail lists.   The Foswiki:Support web must *not* be depended on as a resource for this purpose - in other words, it is not there to answer basic questions about operating system and web server administration.  Asking and answering questions is time consuming for all concerned and is best used for specific _Foswiki related_ issues, rather than helping you learn the OS and web server. 
    1919 
    2020To get started with Linux, visit [[http://linuxbasics.org/ LinuxBasics.org]]. !LinuxBasics.org offers Linux tutorials, a mailing-list and an IRC-channel to answer questions, and links to sites with information to install and use Linux. !LinuxBasics.org now also offers a downloadable Linux 'virtual machine' (LBox) that runs on Windows - you can use this as a completely safe learning environment, and feel free to make mistakes without any chance of damaging your Windows setup. 
  • trunk/core/data/System/AdminToolsCategory.txt

    r733 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1163619832" format="1.1" version="$Rev $"}% 
    22---+ Admin tools 
    3 Manage whole <b>TWiki</b> site from one screen. 
     3Manage your whole site from one screen. 
    44 
    55   * %ICON{help}% Documentation: [[ReferenceManual][Reference Manual]] 
    6    * %ICON{wrench}% [[TWikiSiteTools][Site Tools]]: [[%SCRIPTURLPATH{"configure"}%][Configure]], %WIKIPREFSTOPIC%, InterWikis, [[%SYSTEMWEB%.Macros][Macros]], [[DocumentGraphics][Doc Graphics]] 
     6   * %ICON{wrench}% [[Site Tools]]: [[%SCRIPTURLPATH{"configure"}%][Configure]], %WIKIPREFSTOPIC%, InterWikis, [[%SYSTEMWEB%.Macros][Macros]], [[DocumentGraphics][Doc Graphics]] 
    77   * %ICON{persons}% Manage [[%USERSWEB%.%WIKIUSERSTOPIC%][Users]]: [[UserRegistration][Register]], %SYSTEMWEB%.NewUserTemplate, %SYSTEMWEB%.UserForm, ResetPassword, ChangePassword 
    88   * %ICON{indexlist}% Manage Content: [[ManagingTopics][Topics]], [[ManagingWebs][Webs]], YouAreHere 
     
    5454see also: [[Plugins]] 
    5555 
    56 ---++ TWiki Version 
    57    * TWiki engine: %WIKIVERSION% 
     56---++ Version 
     57   * Engine: %WIKIVERSION% 
    5858   * Plugin API: %PLUGINVERSION{}% 
    5959 
    60  
    61  
    6260__Related Topics:__ AdminDocumentationCategory 
  • trunk/core/data/System/AnApplicationWithWikiForm.txt

    r761 r851  
    77---++ Answer: 
    88 
    9    1 Create a TWiki Form and define fields (see DataForms for details) 
     9   1 Create a [[data form]] and define fields 
    1010   1 Add the form in the list of Web Forms. Set the preference WEBFORMS in WebPreferences 
    1111   1 Create a Template Topic 
     
    4242__Related Topics:__ UserDocumentationCategory 
    4343 
    44 -- __Contributors:__ TWiki:Main.MiyokoTakushima - 18 Oct 2004 
  • trunk/core/data/System/AppendixEncodeURLsWithUTF8.txt

    r482 r851  
    66_Use internationalised characters within !WikiWords and attachment names_ 
    77 
    8 This topic addresses implemented UTF-8 support for URLs only. The overall plan for UTF-8 support for TWiki is described in TWiki:Codev.ProposedUTF8SupportForI18N. 
    98 
    109%TOC% 
     
    1211---++ Current Status 
    1312 
    14 To simplify use of internationalised characters within WikiWords and attachment names, TWiki now supports UTF-8 URLs, converting on-the-fly to virtually any character set, including ISO-8859-*, KOI8-R, EUC-JP, and so on. 
     13To simplify use of internationalised characters within WikiWords and attachment names, Foswiki supports UTF-8 URLs, converting on-the-fly to virtually any character set, including ISO-8859-*, KOI8-R, EUC-JP, and so on. 
    1514 
    16 Support for UTF-8 URL encoding avoids having to configure the browser to turn off this encoding in URLs (the default in Internet Explorer, Opera Browser and some Mozilla Browser URLs) and enables support of browsers where only this mode is supported (e.g. Opera Browser for Symbian smartphones).  A non-UTF-8 site character set (e.g. ISO-8859-*) is still used within TWiki, and in fact pages are stored and viewed entirely in the site character set - the browser dynamically converts URLs from the site character set into UTF-8, and TWiki converts them back again. 
     15Support for UTF-8 URL encoding avoids having to configure the browser to turn off this encoding in URLs (the default in Internet Explorer, Opera Browser and some Mozilla Browser URLs) and enables support of browsers where only this mode is supported (e.g. Opera Browser for Symbian smartphones).  A non-UTF-8 site character set (e.g. ISO-8859-*) is still used within Foswiki, and in fact pages are stored and viewed entirely in the site character set - the browser dynamically converts URLs from the site character set into UTF-8, and Foswiki converts them back again. 
    1716 
    1817System requirements are updated as follows: 
    1918   * ASCII or ISO-8859-1-only sites do not require any additional CPAN modules to be installed. 
    2019   * Perl 5.8 sites using any character set do not require additional modules, since CPAN:Encode is installed as part of Perl.  
    21    * This feature still works on Perl 5.005_03 as per TWikiSystemRequirements, or Perl 5.6, as long as CPAN:Unicode::MapUTF8 is installed.   
     20   * This feature still works on Perl 5.005_03 as per SystemRequirements, or Perl 5.6, as long as CPAN:Unicode::MapUTF8 is installed.   
    2221 
    23 The following 'non-ASCII-safe' character encodings are now excluded from use as the site character set, since they interfere with TWiki markup: ISO-2022-*, HZ-*, Shift-JIS, MS-Kanji, GB2312, GBK, GB18030, Johab and UHC. However, many multi-byte character sets work fine, e.g. EUC-JP, EUC-KR, EUC-TW, and EUC-CN. In addition, UTF-8 can already be used, with some limitations, for East Asian languages where EUC character encodings are not acceptable - see TWiki:Codev.ProposedUTF8SupportForI18N. 
     22The following 'non-ASCII-safe' character encodings are now excluded from use as the site character set, since they interfere with Foswiki markup: ISO-2022-*, HZ-*, Shift-JIS, MS-Kanji, GB2312, GBK, GB18030, Johab and UHC. However, many multi-byte character sets work fine, e.g. EUC-JP, EUC-KR, EUC-TW, and EUC-CN. In addition, UTF-8 can already be used, with some limitations, for East Asian languages where EUC character encodings are not acceptable. 
    2423 
    2524It's now possible to override the site character set defined in the ={SiteLocale}= setting in [[%SCRIPTURLPATH{"configure"}%][configure]] - this enables you to have a slightly different spelling of the character set in the server locale (e.g. 'eucjp') and the HTTP header sent to the browser (e.g. 'euc-jp'). 
    26  
    27 This feature should also support use of Mozilla Browser with TWiki:Codev.TWikiOnMainframe (as long as mainframe web server can convert or pass through UTF-8 URLs) - however, this specific combination is not tested.  Other browser-server combinations should not have any problems. 
    28  
    29 Please note that use of UTF-8 as the site character set is not yet supported - see Phase 2 of TWiki:Codev.ProposedUTF8SupportForI18N for plans and work to date in this area. 
    30  
    31 This feature is complete in TWiki releases newer than February 2004. 
    32  
    33 Note for skin developers: <nop>%INTURLENCODE% is no longer required (TWiki:Plugins.InternationalisingYourSkin). 
    34  
    3525 
    3626---++ Details of Implementation 
     
    3929http://www.w3.org/TR/html4/appendix/notes.html#non-ascii-chars 
    4030 
    41 The overall plan for UTF-8 support for TWiki is described in two phases in TWiki:/Codev.ProposedUTF8SupportForI18N - this page addresses the first phase, in which UTF-8 is supported for URLs only. 
     31UTF-8 URL translation to virtually any character set is supported, but full UTF-8 support (e.g. pages in UTF-8) is not supported yet. 
    4232 
    43 UTF-8 URL translation to virtually any character set is supported as of TWiki Release 01 Sep 2004, but full UTF-8 support (e.g. pages in UTF-8) is not supported yet - this will be phase 2. 
     33The code automatically detects whether a URL is UTF-8 or not, taking care to avoid over-long and illegal UTF-8 encodings that could introduce security issues (tested against a comprehensive [[http://www.cl.cam.ac.uk/~mgk25/ucs/examples/UTF-8-test.txt UTF-8 test file]], which IE 5.5 fails quite dangerously, and Opera Browser passes).  Any non-ASCII URLs that are _not_ valid UTF-8 are then assumed to be directly URL-encoded as a single-byte or multi-byte character set (as now), e.g. EUC-JP.   
    4434 
    45 The code automatically detects whether a URL is UTF-8 or not, taking care to avoid over-long and illegal UTF-8 encodings that could introduce TWiki:Codev.MajorSecurityProblemWithIncludeFileProcessing (tested against a comprehensive [[http://www.cl.cam.ac.uk/~mgk25/ucs/examples/UTF-8-test.txt UTF-8 test file]], which IE 5.5 fails quite dangerously, and Opera Browser passes).  Any non-ASCII URLs that are _not_ valid UTF-8 are then assumed to be directly URL-encoded as a single-byte or multi-byte character set (as now), e.g. EUC-JP.   
    46  
    47 The main point is that you can use TWiki with international characters in WikiWords without changing your browser setup from the default, and you can also still use TWiki using non-UTF-8 URLs.  This works on any Perl version from 5.005_03 onwards and corresponds to Phase 1 of TWiki:Codev.ProposedUTF8SupportForI18N.  You can have different users using different URL formats transparently on the same server. 
     35The main point is that you can use Foswiki with international characters in WikiWords without changing your browser setup from the default, and you can also still use Foswiki using non-UTF-8 URLs.  This works on any Perl version from 5.005_03 onwards.  You can have different users using different URL formats transparently on the same server. 
    4836 
    4937UTF-8 URLs are automatically converted to the current [[%SCRIPTURLPATH{"configure"}%#Localisation][{Site}{Charset}]], using modules such as CPAN:Encode if needed. 
    5038 
    51 TWiki generates the whole page in the site charset, e.g. ISO-8859-1 or EUC-JP, but the browser dynamically UTF-8 encodes the attachment's URL when it's used.  Since Apache serves attachment downloads without TWiki being involved, TWiki's code can't do its UTF-8 decoding trick, so TWiki URL-encodes such URLs in ISO-8859-1 or whatever when generating the page, to bypass this URL encoding, ensuring that the URLs and filenames seen by Apache remain in the site charset.   
     39Foswiki generates the whole page in the site charset, e.g. ISO-8859-1 or EUC-JP, but the browser dynamically UTF-8 encodes the attachment's URL when it's used.  Since Apache serves attachment downloads without Foswiki being involved, Foswiki's code can't do its UTF-8 decoding trick, so Foswiki URL-encodes such URLs in ISO-8859-1 or whatever when generating the page, to bypass this URL encoding, ensuring that the URLs and filenames seen by Apache remain in the site charset.   
    5240 
    53 TWiki:Codev.TWikiOnMainframe uses EBCDIC web servers that typically translate their output to ASCII, UTF-8 or ISO-8859-1 (and URLs in the other direction) since there are so few EBCDIC web browsers.  Such web servers don't work with even ISO-8859-1 URLs if they are URL encoded, since the automated translation is bypassed for URL-encoded characters. For TWiki on Mainframe, TWiki assumes that the web server will automatically translate UTF-8 URLs into EBCDIC URLs, as long as URL encoding is turned off in TWiki pages. 
    54  
    55  
    56 ---++ Testing and Limitation 
    57  
    58 It should work with TWiki:Codev.TWikiOnMainframe.  Tested with IE 5.5, Opera 7.11 and Mozilla (Firebird 0.7).  
    59  
    60 Opera Browser on the P800 smartphone is working for page viewing but leads to corrupt page names when editing pages. 
    61  
    62 For up to date information see TWiki:Codev.EncodeURLsWithUTF8 
    6341 
    6442%STOPINCLUDE% 
  • trunk/core/data/System/BeginnersStartHere.txt

    r683 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1199519964" format="1.1" version="1.2"}% 
    2 This is a short introductory training course for TWiki beginners. 
     2This is a short introductory training course for beginners. 
    33 
    44%SLIDESHOWSTART% 
    55 
    6 ---++ A Taste of TWiki 
     6---++ A Taste of Foswiki 
    77<img src="%ATTACHURL%/hula.gif" alt="Hula girl"  width="113" height="111" align="right" /> 
    8 The basic function of TWiki is a Wiki (if that helps!) 
     8The basic function of Foswiki is a Wiki (if that helps!) 
    99 
    1010A Wiki is like a web site, except that you can edit the content in your browser 
     
    1515   * A Wiki is basically a shared, online, persistent whiteboard 
    1616 
    17 ---++ TWiki Wiki 
     17---++ Foswiki 
    1818<img src="%ATTACHURL%/whiteboard.gif" alt="Whiteboard" width="240" height="160" align="right" /> 
    19 TWiki implements the basic Wiki idea of a shared whiteboard 
     19Implements the basic Wiki idea of a shared whiteboard 
    2020 
    2121   * Anyone can add content<br />... or change what is written<br />... or change the organisation of the content 
    2222   * Whatever what you write is<br />... nicely presented<br />... remembered... and never forgotten 
    2323 
    24 TWiki also acts as an "application platform" to integrate a number of other functions. 
    25  
    26 TWiki is an Open-Source development on [[http://twiki.org/][TWiki.org]] 
    27    * led by TWiki:Main.PeterThoeny 
    28    * with over 100 regular contributors in many countries 
     24Foswiki also acts as an "application platform" to integrate a number of other functions. 
    2925 
    3026---++ Where is it used? 
    31 TWiki is mainly used in commercial environments, often on corporate intranets 
    32    * Examples: Disney, British Telecom, SAP, Wind River, Motorola, <a href="http://udn.epicgames.com/Main/WebHome">Epic Games</a><br /> 
    33      <table cellspacing="20"><tr> 
    34      <td><img src="%ATTACHURL%/Disney_logo.gif" alt="Disney logo"  width="80" height="31" /></td> 
    35      <td><img src="%ATTACHURL%/BT_logo.gif" alt="British Telecom logo"  width="80" height="41" /></td> 
    36      <td><img src="%ATTACHURL%/SAP_logo.gif" alt="SAP logo"  width="80" height="40" /></td> 
    37      <td><img src="%ATTACHURL%/Motorola_logo.gif" alt="Motorola logo"  width="80" height="65" /></td> 
    38      <td><img src="%ATTACHURL%/EpicGames_logo.gif" alt="Epic Games logo"  width="80" height="65" /></td> 
    39      </tr></table> 
    40  
    41 A number of public Wiki sites also use TWiki 
    42    * Examples: <br /> https://twiki.cern.ch/twiki/bin/view/ <br /> http://csci.mrs.umn.edu/twiki/view 
    43  
    44 ---++ TWiki Features 
    45 TWiki builds on the original Wiki concept and adds a number of features that make it very useful in a business environment. 
    46    * TWiki pages are fully revision controlled, so a record of every change to every page is kept <table border="0" cellpadding="3" cellspacing="0"><tr><td bgcolor="#D0D0D0"><font color="black" size="-1">r6 <a>&lt;</a> r5 <a>&lt;</a> r4</font></td></tr></table> 
     27Foswiki is mainly used in commercial environments, often on corporate intranets 
     28 
     29A number of public Wiki sites also use Foswiki 
     30 
     31---++ Foswiki Features 
     32Foswiki builds on the original Wiki concept and adds a number of features that make it very useful in a business environment. 
     33   * Foswiki pages are fully revision controlled, so a record of every change to every page is kept <table border="0" cellpadding="3" cellspacing="0"><tr><td bgcolor="#D0D0D0"><font color="black" size="-1">r6 <a>&lt;</a> r5 <a>&lt;</a> r4</font></td></tr></table> 
    4734   * The look-and-feel is highly configurable, through use of templates 
    4835<table width="100%"><tr><td valign="top"> 
     
    5340</td><td align="right"><img src="%ATTACHURL%/lego.gif" alt="" /></td></tr></table> 
    5441 
    55 ---++ Applications of basic TWiki 
    56 Basic TWiki can be used as: 
     42---++ Applications of basic Foswiki 
     43Basic Foswiki can be used as: 
    5744   * A whiteboard 
    5845   * A document repository 
     
    6249 
    6350---++ Extended applications 
    64 TWiki-with-extensions has been used as: 
     51Foswiki-with-extensions has been used as: 
    6552   * A Content Management System (CMS) for websites 
    6653   * A presentation development tool 
     
    7158   * (<i>truth is, we don't really know its limits!</i>) 
    7259 
    73 ---++ Structure of a TWiki page 
    74 TWiki pages are usually organised into three parts: 
     60---++ Structure of a Foswiki page 
     61Foswiki pages are usually organised into three parts: 
    7562   * A header 
    7663   * A body 
     
    7966   * The header and the footer are generated by the system 
    8067   * The body contains the text of the page, as entered by you 
    81 TWiki is very configurable, and the look can change. However the essentials will all be there on the page (somewhere!) 
     68Foswiki is very configurable, and the look can change. However the essentials will all be there on the page (somewhere!) 
    8269 
    8370---++ The Page Header 
    84 The header of a TWiki page is generally highlighted in colour, and will usually contain an icon that gives you an idea of where you are, such as a company logo. 
     71The header of a Foswiki page is generally highlighted in colour, and will usually contain an icon that gives you an idea of where you are, such as a company logo. 
    8572<table width="90%" border="0" cellpadding="3" cellspacing="0" bgcolor="white"> 
    8673 <tr> 
    8774  <td bgcolor="#D0D0D0" rowspan="2" valign="top" width="1%"> 
    88     <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="TWiki home" /> 
     75    <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="Foswiki home" /> 
    8976   </td><td> 
    9077   <font size="+0"> My<nop>Co.My<nop>Topic </font> 
    9178  </td><td align="right"> 
    92     <font size="-1" color="black">Webs:<br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a></font> 
     79    <font size="-1" color="black">Webs:<br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">Foswiki</a> | <a href="non">Sandbox</a></font> 
    9380  </td> 
    9481 </tr> 
     
    10996 <tr> 
    11097  <td bgcolor="#D0D0D0" rowspan="2" valign="top" width="1%"> 
    111     <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="TWiki home" /> 
     98    <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="Foswiki home" /> 
    11299   </td><td> 
    113100    <font size="+0"> My<nop>Co.My<nop>Topic </font> 
    114101  </td><td align="right"> 
    115     <font size="-1" color="black">Webs:<br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a></font> 
     102    <font size="-1" color="black">Webs:<br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">Foswiki</a> | <a href="non">Sandbox</a></font> 
    116103  </td> 
    117104 </tr> 
     
    122109 </tr> 
    123110</table> 
    124 You may also see in the header (usually at the top right) a list of the TWiki "webs". A web is a collection of pages that are related closely together 
     111You may also see in the header (usually at the top right) a list of the Foswiki "webs". A web is a collection of pages that are related closely together 
    125112   * For example, we might have a web called "Enemies", where we keep all we know about our enemies, and another called "Friends" 
    126113   * There's usually a safe play web called something like "Sandbox" or "Scratch", where you can create pages just to try things out 
     
    140127 <tr> 
    141128  <td valign="top"> 
    142     <font size="-1" color="black">Revision r1.2 - 13 Feb 2004 - 09:09 GMT - <a href="none">TWikiPresenter</a> </font> 
     129    <font size="-1" color="black">Revision r1.2 - 13 Feb 2004 - 09:09 GMT - <a href="none">FoswikiPresenter</a> </font> 
    143130  </td> 
    144131  <td width="40%" valign="top"> 
     
    158145 
    159146---++ What's in a page 
    160    * The hieroglyphics are what's known as "TWiki Markup" or "formatting" 
     147   * The hieroglyphics are what's known as "Topic Markup Language" or "formatting" 
    161148   * They are a really simple way of telling the browser how you want the page to look 
    162149   * You don't have to use them 
    163       * TWiki understands pages in plain text just fine.<br /><br /> <code>Actually it is perfectly and absolutely flat</code><br /><br /> appears as <br /><br /> Actually it is perfectly and absolutely flat 
     150      * Foswiki understands pages in plain text just fine.<br /><br /> <code>Actually it is perfectly and absolutely flat</code><br /><br /> appears as <br /><br /> Actually it is perfectly and absolutely flat 
    164151 
    165152---++ Formatting just makes pages prettier 
     
    171158 
    172159---++ Commonly used formatting 
    173 TWiki understands pages in plain text just fine, but you can %RED% __jazz__ %ENDCOLOR%%GREEN% _them_ %ENDCOLOR%%BLUE% *up* %ENDCOLOR% using some simple formatting shortcuts. Here are some of the more commonly used ones: 
     160Foswiki understands pages in plain text just fine, but you can %RED% __jazz__ %ENDCOLOR%%GREEN% _them_ %ENDCOLOR%%BLUE% *up* %ENDCOLOR% using some simple formatting shortcuts. Here are some of the more commonly used ones: 
    174161   * <nop>---+ indicates a heading. Add more +'s for a deeper heading. 
    175162    | *You type* | *You see* | 
     
    206193   * One special hieroglyph that is *very important* is a BumpyWord 
    207194      * a word that starts with uppercase, then some lowercase, then more uppercase (a.k.a <nop>CamelCase) 
    208    * This has a special meaning to TWiki; if it matches the name of another topic, TWiki will automatically create a link to that page for you. 
     195   * This has a special meaning to Foswiki; if it matches the name of another topic, Foswiki will automatically create a link to that page for you. 
    209196   * If there is no such page, then the word is highlighted and a question mark is put after the word, LikeThis 
    210    * If you click on the question mark, then TWiki will invite you to create that page. 
     197   * If you click on the question mark, then Foswiki will invite you to create that page. 
    211198 
    212199   * This lets you enter the names of topics you _think_ should exist, but don't yet 
     
    233220      * Type in the name of the topic in the "Go:" box 
    234221      * Type in the name of the topic in the URL 
    235    * Any time you try to visit a page that doesn't exist, TWiki will invite you to create it. 
     222   * Any time you try to visit a page that doesn't exist, Foswiki will invite you to create it. 
    236223   * Make sure the names of topics are always BumpyWords. 
    237224 
    238225---++ Attachments 
    239    * Attachments are files which have been uploaded and attached to a TWiki page using the 'Attach' function in the footer. 
     226   * Attachments are files which have been uploaded and attached to a Foswiki page using the 'Attach' function in the footer. 
    240227<table border="0" cellspacing="2" cellpadding="1" bgcolor="white"> 
    241228 <tr> 
     
    261248</table> 
    262249   * Attachments are simply files, in whatever format you want. 
    263    * TWiki recognises some file formats, notably image files (.gif) 
     250   * Foswiki recognises some file formats, notably image files (.gif) 
    264251      * Write =%<nop>ATTACHURL%/myco.gif= to see this: %ATTACHURL%/myco.gif 
    265252 
     
    270257      * If someone doesn't want you to edit a page, it's up to them to say so, clearly, on the page 
    271258   * But what if somebody doesn't like my edits? 
    272       * In TWiki, they can always recover the old revision and re-instantiate it if they really want to 
     259      * In Foswiki, they can always recover the old revision and re-instantiate it if they really want to 
    273260      * Otherwise they should regard your changes as an opportunity for discussion 
    274261   * Pages in wiki are (usually) in one of three "modes" 
     
    276263      * Thread<nop>Mode 
    277264      * Structured<nop>Mode 
    278 TWiki doesn't automatically distinguish between these modes; they are purely semantic. 
     265Foswiki doesn't automatically distinguish between these modes; they are purely semantic. 
    279266 
    280267---++ Document<nop>Mode 
     
    310297 
    311298---++ Contributed features 
    312 Basic TWiki is rich with features, but is enriched even further by the addition of optional plug-in modules that may (or may not!) be installed in your TWiki. These are classified as either __skins__ (modules that change the look-and-feel) and __plugins__ (modules that enhance functionality). 
     299Basic Foswiki is rich with features, but is enriched even further by the addition of optional plug-in modules that may (or may not!) be installed in your Foswiki. These are classified as either __skins__ (modules that change the look-and-feel) and __plugins__ (modules that enhance functionality). 
    313300 
    314301Here's a brief description of some of the more common plugins, together with the tags you might expect to see in topics if they are used. You can find out more by visiting the plugin pages. 
     
    316303   * Calendar<nop>Plugin: Show a *monthly calendar* with highlighted events <code>%CALENDAR...%</code> 
    317304   * Comment<nop>Plugin: Support *rapid entry of short comments* (also known as <b>blogging</b>) <code>%COMMENT...</code> 
    318    * Chart<nop>Plugin: Create PNG or GIF *charts to visualize data in TWiki tables* <code>%CHART...</code> 
    319    * Edit<nop>TablePlugin: Edit TWiki tables using *edit fields and drop down boxes* <code>%EDITTABLE...</code> 
     305   * Chart<nop>Plugin: Create PNG or GIF *charts to visualize data in Foswiki tables* <code>%CHART...</code> 
     306   * Edit<nop>TablePlugin: Edit Foswiki tables using *edit fields and drop down boxes* <code>%EDITTABLE...</code> 
    320307   * Interwiki<nop>Plugin: Define *shortcuts* for links to *common external sites* 
    321308 
     
    323310   * Render<nop>ListPlugin: Render *bullet lists in a variety of formats* <code>%RENDERLIST...</code> 
    324311   * Slide<nop>ShowPlugin: *Create web based presentations* based on topics with headings <code>%SLIDESHOWSTART...</code> 
    325    * Spread<nop>SheetPlugin: Add *spreadsheet calculations* like "$SUM( $ABOVE() )" to tables located in TWiki topics <code>%CALC...</code> 
     312   * Spread<nop>SheetPlugin: Add *spreadsheet calculations* like "$SUM( $ABOVE() )" to tables located in Foswiki topics <code>%CALC...</code> 
    326313   * Table<nop>Plugin: Control *presentation and sorting of tables* <code>%TABLE...</code> 
    327314   * TWiki<nop>DrawPlugin: Add *quick sketches* to pages <code>%DRAWING...</code> 
    328 The following plugins are installed on this TWiki: %ACTIVATEDPLUGINS% 
    329  
    330 There are many other plugins, see http://TWiki.org/cgi-bin/view/Plugins 
     315The following plugins are installed on this Foswiki: %ACTIVATEDPLUGINS% 
     316 
     317There are many other plugins, see http://foswiki.org/Extensions 
    331318 
    332319---++ Credits and Acknowledgements 
    333    * This training was developed by TWiki:Main.CrawfordCurrie on behalf of [[http://www.oxamer.com/][Oxamer]], one of the companies in the [[http://www.ogt.co.uk/][Oxford Gene Technology]] group. 
    334    * Valuable contributions were also received from the TWiki Open Source community; special mentions go to: 
    335       * TWiki:Main.WalterMundt 
    336       * TWiki:Main.SvenDowideit 
    337    * The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback 
     320   * This training was developed by Foswiki:Main.CrawfordCurrie on behalf of [[http://www.oxamer.com/][Oxamer]], one of the companies in the [[http://www.ogt.co.uk/][Oxford Gene Technology]] group. 
     321   * Valuable contributions were also received from the Foswiki Open Source community; special mentions go to: 
     322      * Foswiki:Main.WalterMundt 
     323      * Foswiki:Main.SvenDowideit 
     324   * The latest version of this presentation is available at Foswiki:%WEB%.%TOPIC%, where you can also provide feedback 
    338325%SLIDESHOWEND% 
    339326 
  • trunk/core/data/System/CascadingStyleSheets.txt

    r547 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 16175 $"}% 
    22%STARTINCLUDE% 
    3 ---+ Appendix C: TWiki CSS 
     3---+ Appendix C: CSS 
    44 
    5 _Listing of CSS class names emitted from TWiki core code and standard plugins, for the Dakar release._ 
     5_Listing of CSS class names emitted from Foswiki core code and standard plugin._ 
    66 
    77%TOC% 
     
    99---++ Who should read this document? 
    1010 
    11 Most html elements generated by TWiki core code now have Cascading Style Sheet (CSS) tags. __Skin builders__ and others who want to change the appearance of the default TWiki installation or any of the skins can use this document to see what styles can be created for these html elements. 
     11Most html elements generated by Foswiki core code now have Cascading Style Sheet (CSS) tags. __Skin builders__ and others who want to change the appearance of the default TWiki installation or any of the skins can use this document to see what styles can be created for these html elements. 
    1212 
    1313---++ Naming conventions 
    1414 
    15    1 All TWiki class names have the prefix =twiki=. So: twikiAlert, twikiToc, etcetera. Remember that CSS class names are case sensitive - TWiki CSS uses lowercase =tw=. 
     15   1 All Foswiki class names have the prefix =twiki=. So: twikiAlert, twikiToc, etcetera. Remember that CSS class names are case sensitive - TWiki CSS uses lowercase =tw=. 
    1616   1 If you define your own CSS classes, it is preferable that you do not use the =twiki= prefix to prevent undesired overriding effects. 
    1717 
    18 A wide range of standard styles are used in the TWiki core code and topics, and more are used in plugins. The following is an exhaustive list of all styles defined by the Pattern skin. For the most part, the names are the only documentation of the purpose of the style. For more information on how these styles are used, read the code (sorry!) 
     18A wide range of standard styles are used in the Foswiki core code and topics, and more are used in plugins. The following is an exhaustive list of all styles defined by the Pattern skin. For the most part, the names are the only documentation of the purpose of the style. For more information on how these styles are used, read the code (sorry!) 
    1919 
    20 ---+++ TWiki styles in core code 
     20---+++ Styles in core code 
    2121 
    2222|.twikiAlert  |Client.pm, Form.pm, Statistics.pm  | 
     
    3535|.twikiCurrentTopicLink  |Render.pm  | 
    3636|.twikiEmulatedLink  |Preview.pm  | 
    37 |.twikiWebIndent  |TWiki.pm  | 
     37|.twikiWebIndent  |Foswiki.pm  | 
    3838 
    3939|.twikiEditFormDateField  | Form.pm  | 
     
    6363|.twikiDiffDebugLeft  |RDiff.pm  | 
    6464 
    65 |.twikiToc  |TWiki.pm  | 
    66 |.twikiTocTitle  |TWiki.pm  | 
     65|.twikiToc  |Foswiki.pm  | 
     66|.twikiTocTitle  |Foswiki.pm  | 
    6767 
    6868 
    69 ---+++ TWiki Styles in Plugins 
     69---+++ Styles in Plugins 
    7070---++++ TablePlugin 
    7171|=.twikiTable=  |The table  | 
     
    8181 
    8282 
    83 ---+++ TWiki Styles in Templates 
     83---+++ Styles in Templates 
    8484 
    8585|.twikiPage  |twiki.tmpl  | 
     
    128128|.twikiContentFooter  |container around optional html placed after topic text  | 
    129129 
    130 ---+++ TWiki Styles used in =configure= 
     130---+++ Styles used in =configure= 
    131131|#twikiLogin  |CSS.pm  | 
    132132|.twikiFormSteps  |CSS.pm | 
    133133|.twikiFormStep  |CSS.pm | 
    134134 
    135 ---+++ TWiki Styles in topics 
     135---+++ Styles in topics 
    136136 
    137137|.twikiBroadcastMessage  |%SYSTEMWEB%.DefaultPreferences!  | 
    138138|#twikiSearchTable  |%SYSTEMWEB%.WebSearch, %SYSTEMWEB%.WebSearchAdvanced  | 
    139139 
    140 ---+++ TWiki Styles in Skins 
     140---+++ Styles in Skins 
    141141|#twikiLogin  | login.pattern.tmpl  | | 
    142142 
  • trunk/core/data/System/CommandAndCGIScripts.txt

    r711 r851  
    190190 
    191191---+++ =rest= 
    192 This REST ([[http://en.wikipedia.org/wiki/REST][Representational State Transfer]]) script can be invoked via http in the same way as the other scripts (see *Invocation Examples*, below) to execute a function that is associated to a "subject" and a "verb" (see below). These functions are usually registered by plugins using the =TWiki::Func::registerRESTHandler= method. The =rest= script will print the result directly to the browser unless the =endPoint= parameter is specified, in which case it will output a redirect to the given topic. 
     192This REST ([[http://en.wikipedia.org/wiki/REST][Representational State Transfer]]) script can be invoked via http in the same way as the other scripts (see *Invocation Examples*, below) to execute a function that is associated to a "subject" and a "verb" (see below). These functions are usually registered by plugins using the =Foswiki::Func::registerRESTHandler= method. The =rest= script will print the result directly to the browser unless the =endPoint= parameter is specified, in which case it will output a redirect to the given topic. 
    193193 
    194194The =rest= script supports the following parameters: 
     
    208208=http://my.host/bin/rest/&lt;subject&gt;/&lt;verb&gt;= 
    209209 
    210 where =&lt;subject&gt;= must be the WikiWord name of one of the installed [[Plugins]], and the =&lt;verb&gt;= is the alias for the function registered using the =TWiki::Func::registerRESTHandler= method. The =&lt;subject&gt;= and =&lt;verb&gt;= are then used to lookup and call the registered function. 
     210where =&lt;subject&gt;= must be the WikiWord name of one of the installed [[Plugins]], and the =&lt;verb&gt;= is the alias for the function registered using the =Foswiki::Func::registerRESTHandler= method. The =&lt;subject&gt;= and =&lt;verb&gt;= are then used to lookup and call the registered function. 
    211211 
    212212=&lt;subject&gt;= and =&lt;verb&gt;= are checked for illegal characters exactly in the same way as the web and topic names. 
     
    339339| =topic= | redirects (at the beging of the cgi script running) to show the spcified Web.Topic, or, redirects to a URL, if allowed by {AllowRedirectUrl} and {PermittedRedirectHostUrls} | | 
    340340 
    341 %X% For historical reasons, the view script has a special interpretation of the =text= skin. In TWiki < 4.0 the =skin=text= parameter was used like this: 
    342 =http<nop>://.../view/MyWeb/MyTopic?skin=text&contenttype=text/plain&raw=on= 
    343 which shows the topic as plain text; useful for those who want to download plain text for the topic. 
    344 Using =skin=text= this way is *DEPRECATED*, use =raw=text= instead. 
     341%X% For historical reasons, the view script has a special interpretation of the =text= skin. This skin cannot be redefined. 
    345342 
    346343---+++ =viewfile= 
  • trunk/core/data/System/CompleteDocumentation.txt

    r719 r851  
    66%TOC{ depth="2" }% 
    77 
    8 __Related Topics:__ TWikiSite, ReleaseHistory, EnhancementRequests, UserDocumentationCategory, AdminDocumentationCategory 
     8__Related Topics:__ UserDocumentationCategory, AdminDocumentationCategory 
    99 
    1010------ 
     
    9393 
    9494------ 
    95 %INCLUDE{"TWikiFuncDotPm"}% 
     95%INCLUDE{"FoswikiFuncDotPm"}% 
    9696 
    9797[[#PageTop][Back to top]] 
  • trunk/core/data/System/ContributedAddOns.txt

    r706 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1177803014" format="1.1" version="$Rev$"}% 
    22%STARTINCLUDE% 
    3 ---+ TWiki Add-Ons 
     3---+ Add-Ons 
    44 
    5 _Add functionality to TWiki with extensions not based on the TWiki scripts._ 
     5_Add functionality with extensions not based on the Foswiki scripts._ 
    66 
    77%TOC% 
     
    99---++ Overview 
    1010 
    11 An add-on runs separately from the TWiki scripts, e.g. for data import, export to static HTML, etc. Add-Ons normally do not call any TWiki code directly, though may invoke TWiki scripts. There are different types of add-ons, they may be stand alone scripts, browser plugins, office tool extensions, or even a set of TWiki topics that form a TWiki application. 
    12  
    13 __Relevant links on TWiki.org:__ 
    14    * TWiki:Plugins.AddOnPackage - list of all contributed add-on scripts 
    15    * TWiki:Plugins.AddOnDevelopment - discussion and feedback on contributed add-on scripts 
    16    * TWiki:Plugins.AddOnBrainstorming - open forum for new add-on script ideas 
    17    * TWiki:Plugins.AddOnPackageHowTo - instructions and template to create a new add-on topic 
     11An add-on runs separately from the Foswiki scripts, e.g. for data import, export to static HTML, etc. Add-Ons normally do not call any Foswiki code directly, though may invoke Foswiki scripts. There are different types of add-ons, they may be stand alone scripts, browser plugins, office tool extensions, or even a set of topics that form a wiki application. 
    1812 
    1913__See other types of extensions:__ [[Contribs]], [[Plugins]], [[Skins]] 
    2014 
    21 ---++ Add-Ons Installed on this TWiki 
     15---++ Add-Ons Installed on this site 
    2216 
    2317%SEARCH{ "AddOn" scope="topic" topic="*AddOn" nosearch="on" format="   * <b>[[$topic]]</b>: <nop>$pattern(.*?\*\sSet\sSHORTDESCRIPTION\s\=([^\n\r]*).*) <span style=\"color: gray;\">- version $pattern(.*?Version\:?\s*\|([^\n\r\|]*)\|.*)</span> <br /> <span style=\"color: gray; font-size: 80%\"> Author: $pattern(.*?\sAuthors?:\s*\|\s*(.*?)\s*\|.*) - last modified: r$rev - [[%SCRIPTURL{rdiff}%/$web/$topic][$date]] - $wikiusername </span>" }% 
     
    2519---++ Installing Add-Ons 
    2620 
    27    * Download an add-on from TWiki:Plugins.AddOnPackage. 
     21   * Download an add-on from Foswiki:Extensions.AddOnPackage. 
    2822   * Follow the installation instructions in the add-on topic. 
    2923 
    3024---++ Creating new Add-Ons 
    3125 
    32    * Visit TWiki:Plugins.AddOnPackageHowTo and follow the instructions. 
     26   * Visit Foswiki:Extensions.AddOnPackageHowTo and follow the instructions. 
    3327 
    3428%STOPINCLUDE% 
    35 __Related Topics:__ DeveloperDocumentationCategory, AdminDocumentationCategory, TWiki:Support.PluginsSupplement 
     29__Related Topics:__ DeveloperDocumentationCategory, AdminDocumentationCategory 
    3630 
  • trunk/core/data/System/DataForms.txt

    r700 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1177881299" format="1.1" version="$Rev: 13239 $"}% 
    22%STARTINCLUDE% 
    3 ---+ TWiki Forms 
    4  
    5 _Add structure to content with forms attached to twiki topics. TWiki forms (with form fields) and formatted search are the base for building database applications._ 
     3---+ Data Forms 
     4 
     5_Add structure to content with forms attached to topics. Data forms (with form fields) and formatted search are the base for building database applications._ 
    66 
    77%TOC% 
     
    1111By adding form-based input to freeform content, you can structure topics with unlimited, easily searchable categories. A form is enabled for a web and can be added to a topic. The form data is shown in tabular format when the topic is viewed, and can be changed in edit mode using edit fields, radio buttons, check boxes and list boxes. Many different form types can be defined in a web, though a topic can only have one form attached to it at a time. 
    1212 
    13 Typical steps to build an application based on TWiki forms: 
     13Typical steps to build an application based on Foswiki forms: 
    1414   1. Define a form template 
    1515   1. Enable the form for a web 
     
    1919 
    2020---++ Defining a Form 
    21 A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field. 
     21A Form Template specifies the fields in a form. A Form Template is simply a page containing a Foswiki table, where each row of the table specifies one form field. 
    2222   1. Create a new topic with your form name: ==<nop>YourForm==, ==<nop>ExpenseReportForm==, ==<nop>InfoCategoryForm==, ==<nop>RecordReviewForm==, whatever you need. 
    23    1. Create a TWiki table, with each column representing one element of an entry field: ==Name==, ==Type==, ==Size==, ==Values==, ==Tooltip message==, and ==Attributes== _(see sample below)_. 
     23   1. Create a TML table, with each column representing one element of an entry field: ==Name==, ==Type==, ==Size==, ==Values==, ==Tooltip message==, and ==Attributes== _(see sample below)_. 
    2424   1. For each field, fill in a new line; for the type of field, select from the list. 
    2525   1. Save the topic _(you can later choose to [[#EnablingForms][enable/disable]] individual forms)_. 
     
    101101    </form> 
    102102       </verbatim> 
    103    * __%T% Tip:__ For TWiki applications you can [[TemplateTopics#AutomaticallyGeneratedTopicname][automatically generate unique topicnames]]. 
     103   * __%T% Tip:__ For Wiki Applications you can [[TemplateTopics#AutomaticallyGeneratedTopicname][automatically generate unique topicnames]]. 
    104104 
    105105   * __%X% Note:__ Initial values will *not* be set in the form of a new topic if you _only_ use the formtemplate parameter. 
    106106 
    107107---++ Changing a form 
    108    * You can change a form definition, and TWiki will try to make sure you don't lose any data from the topics that use that form.  
     108   * You can change a form definition, and Foswiki will try to make sure you don't lose any data from the topics that use that form.  
    109109 
    110110   * If you change the form definition, the changes will not take affect in a topic that uses that form until you edit and save it. 
     
    114114   * If you delete a field from the form, or change a field name, then the data will not be visible when you edit the topic (the changed form definition will be used). *If you save the topic, the old data will be lost* (though thanks to revision control, you can always see it in older versions of the topic) 
    115115 
    116    * If two people edit the same topic containing a form at exactly the same time, and both change fields in the form, TWiki will try to merge the changes so that no data is lost. 
     116   * If two people edit the same topic containing a form at exactly the same time, and both change fields in the form, Foswiki will try to merge the changes so that no data is lost. 
    117117 
    118118#FormStructure 
    119119---++ Structure of a Form Template 
    120120 
    121 A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field. 
     121A Form Template specifies the fields in a form. A Form Template is simply a page containing a TML table, where each row of the table specifies one form field. 
    122122 
    123123Each *column* of the table is one element of an entry field: ==Name==, ==Type==, ==Size==, ==Values==, ==Tooltip message==, and ==Attributes==. 
     
    156156*Field Name Notes:* 
    157157   * Field names have to be unique. 
    158    * A very few field names are reserved. If you try to use one of these names, TWiki will automatically append an underscore to the name when the form is used. 
     158   * A very few field names are reserved. If you try to use one of these names, Foswiki will automatically append an underscore to the name when the form is used. 
    159159   * You can space out the title of the field, and it will still find the topic e.g. =Aeroplane Manufacturers= is equivalent to =AeroplaneManufacturers=. 
    160160   * If a =label= field has no name, it will *not* be shown when the form is *viewed*, only when it is *edited*. 
     
    179179| AeroplaneManufacturers | select |        | 
    180180</verbatim> 
    181 the TWiki will look for the topic !AeroplaneManufacturers to get the possible values for the =select=. 
     181the Foswiki will look for the topic !AeroplaneManufacturers to get the possible values for the =select=. 
    182182 
    183183The !AeroplaneManufacturers topic must contain a table, where each row of the table describes a possible value. The table only requires one column, ==Name==. Other columns may be present, but are ignored. 
     
    203203---+++ Build an HTML form to create new Form-based topics 
    204204   * New topics with a form are created by simple HTML forms asking for a topic name. For example, you can have a =<nop>SubmitExpenseReport= topic where you can create new expense reports, a =<nop>SubmitVacationRequest= topic, and so on. These can specify the required template topic with its associated form. [[TemplateTopics][Template topics]] has more. 
    205 A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field. 
     205A Form Template specifies the fields in a form. A Form Template is simply a page containing a Foswiki table, where each row of the table specifies one form field. 
    206206#UsingFormData 
    207207---+++ Searching in Form Data 
  • trunk/core/data/System/DefaultPreferences.txt

    r836 r851  
    22---+!! <nop>%WIKITOOLNAME% Site-Level Preferences 
    33 
    4 This topic defines __site-level__ settings that apply to all users and webs on this TWikiSite. 
     4This topic defines __site-level__ settings that apply to all users and webs on this site. 
    55 
    66__%X% Note:__ This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customizations. 
     
    3838 
    3939   * Copyright notice: 
    40       * Set WEBCOPYRIGHT = <span class="twikiRight"> <a href="http://twiki.org/"><img src="%PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/badge.gif" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" border="0" /></a></span>%MAKETEXT{"Copyright &&copy; by the contributing authors. All material on this collaboration platform is the property of the contributing authors." args="1999-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME%%20Feedback%20on%20%BASEWEB%.%BASETOPIC%"}% %IF{"$ WEB= $ SYSTEMWEB" then=""}% 
     40      * Set WEBCOPYRIGHT = <span class="twikiRight"> <a href="http://foswiki.org/"><img src="%PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/badge.gif" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" border="0" /></a></span>%MAKETEXT{"Copyright &copy; by the contributing authors. All material on this site is the property of the contributing authors." args="1999-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME%%20Feedback%20on%20%BASEWEB%.%BASETOPIC%"}% %IF{"$ WEB= $ SYSTEMWEB" then=""}% 
    4141 
    4242   * Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords) 
     
    113113</verbatim> 
    114114 
    115 ---++ TWiki Platform Settings 
    116  
    117    * TWiki site name: 
    118       * Set WIKITOOLNAME = TWiki 
     115---++ Platform Settings 
     116 
     117   * Site name: 
     118      * Set WIKITOOLNAME = Foswiki 
    119119 
    120120   * Image, URL and alternate tooltip text of the logo *for this installation*: you should change these settings for your site, or they can be overwridden in !WebPreferences for individual webs by defining these settings there. 
     
    164164---+++ HTTP-<nop>EQUIV Settings 
    165165 
    166    * %T% *NOTE:* Changing cache behaviour with these settings should not be necessary and may cause cache-related problems (e.g. TWiki:Codev.BackFromPreviewLosesText or TWiki:Codev.RefreshEditPage). These settings do not affect proxy caches. 
     166   * %T% *NOTE:* Changing cache behaviour with these settings should not be necessary and may cause cache-related problems. These settings do not affect proxy caches. 
    167167   * *NOTE:* The current values of these preferences are not displayed in view mode (values are <code>&lt;link&gt;</code>-tags). 
    168168 
     
    180180---++ Skin Settings 
    181181 
    182    * Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)  
     182   * Skin overriding the default templates: (can be overwritten by WebPreferences and user preferences)  
    183183      * Set SKIN = pattern 
    184184 
     
    187187---+++ PatternSkin 
    188188 
    189    * Default TWiki styles        
     189   * Default styles        
    190190      * Set TWIKILAYOUTURL = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/layout.css 
    191191      * Set TWIKISTYLEURL = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/style.css 
     
    245245      * Set BB4 = <br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8226; 
    246246 
    247    * __Hint:__ Above shortcuts are useful in TWiki tables where you cannot use newlines 
     247   * __Hint:__ Above shortcuts are useful in tables where you cannot use newlines 
    248248 
    249249#DocGraphics 
    250    * Macros for graphics used in TWiki documentation - view all images in %ICONTOPIC%: 
     250   * Macros for graphics used in documentation - view all images in %ICONTOPIC%: 
    251251      * Set H = <img src="%ICONURLPATH{help}%" alt="HELP" title="HELP" width="16" height="16" border="0" /> 
    252252      * Set I = <img src="%ICONURLPATH{tip}%" alt="IDEA!" title="IDEA!" width="16" height="16" border="0" /> 
     
    323323       
    324324   * show extra help for !ApacheLogin users for Main.AdminUser login 
    325       * Set ADMINLOGIN = %IF{"{LoginManager} = 'TWiki::LoginManager::ApacheLogin' AND NOT context authenticated" 
    326         then="TWiki is configured using <nop>ApacheLogin, please [[%LOGINURL%][login]] as a normal user first. Then the Admin Login will replace this text" 
     325      * Set ADMINLOGIN = %IF{"{LoginManager} = Foswiki::LoginManager::ApacheLogin' AND NOT context authenticated" 
     326        then="Foswiki is configured using <nop>ApacheLogin, please [[%LOGINURL%][login]] as a normal user first. Then the Admin Login will replace this text" 
    327327        else="[[%SCRIPTURL{login}%?sudo=sudo;origurl=%SCRIPTURL{"view"}%/%BASEWEB%/%BASETOPIC%][internal admin login]] (use the username suggested and the password set in configure)."}% 
    328328 
     
    335335---++ Creating New Preference Settings 
    336336  
    337 You can introduce new [[%SYSTEMWEB%.PreferenceSettings][preference settings]] and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts). 
     337You 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). 
    338338   * 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): 
    339339      * S<nop>et WEBBGCOLOR = #FFFFC0 
     
    357357   * [[%SYSTEMWEB%.Macros][Macros]] has a list of common =%<nop>MACROS%=. 
    358358   * %SYSTEMWEB%.AccessControl explains how to restrict access by users or groups. 
    359    * TWiki:Plugins.PreferencesPlugin makes editing preferences a snap. 
     359   * Foswiki:Extensions.PreferencesPlugin makes editing preferences a snap. 
    360360 
    361361__Note__: Can't edit? 
  • trunk/core/data/System/DeleteOrRenameAnAttachment.txt

    r569 r851  
    77---++ Answer: 
    88 
    9 You can move and delete attachments directly from your browser. Moving lets you transfer an attachment from one topic to another. The soft delete moves an attachment to the special ==TrashAttachment== topic in the ==Trash== web, where it's hidden but can be "undeleted" with system administrator access. Please note that you cannot rename an attachment in the current TWiki release. 
     9You can move and delete attachments directly from your browser. Moving lets you transfer an attachment from one topic to another. The soft delete moves an attachment to the special ==TrashAttachment== topic in the ==Trash== web, where it's hidden but can be "undeleted" with system administrator access. Please note that you cannot rename an attachment in the current Foswiki release. 
    1010 
    1111Click on ==action== on the file in the FileAttachment table, then in the *Update attachment* screen choose ==[Move attachment]==, and make your changes to that screen. 
  • trunk/core/data/System/DocumentGraphics.txt

    r700 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1222844046" format="1.1" version="$Rev: 16040 $"}% 
    2 ---+!! TWiki Documentation Graphics and Filetype icons 
    3  
    4 This is the TWiki icon library. The graphics can be used in topics and by web applications.  
     2---+!! Documentation Graphics and Filetype icons 
     3 
     4This is the Foswiki icon library. The graphics can be used in topics and by web applications.  
    55 
    66%TOC{title="Contents:"}% 
     
    240240| <img src="%ATTACHURLPATH%/web-bg-small.gif" alt="Web" title="Web" />  | =web-bg-small.gif= | Web background, 13x13 | =&lt;img src="%<nop>ICONURL{web-bg-small}%" width="13" height="13" alt="Web" border="0" /&gt;= | 
    241241 
    242 ---+++ %ICON{twiki}% TWiki icons 
     242---+++ %ICON{twiki}% Foswiki icons 
    243243 
    244244%TABLE{headeralign="left" databg="#ffffff,#ffffff" databgsorted="#f5f5f5"}% 
     
    253253| <img src="%ATTACHURLPATH%/searchtag.gif" alt="Search tag" title="Search tag" />  | =searchtag.gif= | Search tag | =%<nop>ICON{searchtag}%= | 
    254254| <img src="%ATTACHURLPATH%/skin.gif" alt="Skin" title="Skin" />  | =skin.gif= | Skin | =%<nop>ICON{skin}%= | 
    255 | <img src="%ATTACHURLPATH%/twiki.gif" alt="TWiki" title="TWiki" />  | =twiki.gif= | TWiki logo | =%<nop>ICON{twiki}%= | 
    256255 
    257256---+++ %ICON{line_ur}% Block graphics 
     
    349348Now you can use the icon by writing =%<nop>H%= 
    350349 
    351 For extended use, check out TWiki:Plugins.SmiliesPlugin that uses a different short hand than =<nop>%MACROS%=. 
     350For extended use, check out Foswiki:Extensions.SmiliesPlugin that uses a different short hand than =<nop>%MACROS%=. 
    352351</blockquote> 
    353352 
  • trunk/core/data/System/DownloadSources.txt

    r569 r851  
    33---++ FAQ: 
    44 
    5 I would like to install TWiki on my server. Can I get the source? 
     5I would like to install Foswiki on my server. Can I get the source? 
    66 
    77---++ Answer: 
    88 
    9 TWiki is distributed under the GnuGeneralPublicLicense. You can get the source from http://TWiki.org/download.html. 
     9Foswiki is distributed under the GnuGeneralPublicLicense. You can get the source from http://foswiki.org/download.html. 
    1010 
    1111__Back to:__ FrequentlyAskedQuestions, AdminDocumentationCategory 
  • trunk/core/data/System/EditingShorthand.txt

    r700 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1176595977" format="1.1" version="$Rev$"}% 
    2 ---++ TWiki Editing Shorthand 
     2---++ Editing Shorthand 
    33 
    44%STARTINCLUDE% 
     
    336336<td> 
    337337 *Anchors:* %BR% 
    338  You can define a reference inside a TWiki topic (called an anchor name) and link to that. To __define__ an anchor write =#AnchorName= at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To __link to__ an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic. 
     338 You can define a reference inside a topic (called an anchor name) and link to that. To __define__ an anchor write =#AnchorName= at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To __link to__ an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic. 
    339339</td><td> 
    340340<verbatim> 
     
    385385<td> 
    386386 *Specific Links:* %BR% 
    387  You can create a link where you specify the link text and the URL separately using nested square brackets =[<nop>[reference][text]]=. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://TWiki.org/) are both supported. 
     387 You can create a link where you specify the link text and the URL separately using nested square brackets =[<nop>[reference][text]]=. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://foswiki.org/) are both supported. 
    388388The rules described under __Forced Links__ apply for internal link references. 
    389389 %BR% %T% Anchor names can be added as well, to create a link to a specific place in a topic. 
     
    458458<td> 
    459459 *Literal content:* %BR% 
    460  TWiki generates HTML code from TWiki shorthand. 
     460 Foswiki generates HTML code from TML shorthand. 
    461461 *Experts* surround anything that must be output literally in the HTML code, without the application of 
    462  TWiki shorthand rules, with =&lt;literal&gt;..&lt;/literal&gt;= tags. %X% any HTML 
     462 shorthand rules, with =&lt;literal&gt;..&lt;/literal&gt;= tags. %X% any HTML 
    463463 within literal tags *must* be well formed i.e. all tags must be properly closed before 
    464464 the end of the literal block. %I% Macros are expanded within literal blocks. 
  • trunk/core/data/System/EnhancementRequests.txt

    r613 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 5385 $"}% 
    2    * Please bring your enhancement requests to TWiki:Development.FeatureProposals 
     2   * Please bring your enhancement requests to Foswiki:Development.FeatureProposals 
    33 
    44__Related Topics:__ 
    5    * ReleaseHistory has a list of added features in TWiki. 
     5   * ReleaseHistory has a list of added features in Foswiki. 
    66   * CompleteDocumentation is the implementation documentation.  
    77 
  • trunk/core/data/System/FileAttachment.txt

    r700 r851  
    3030      * 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.  
    3131      * 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. 
    32       * TWiki can limit the file size. This is defined by the =%<nop>ATTACHFILESIZELIMIT%= [[%SYSTEMWEB%.PreferenceSettings][preference settings]], currently set at %ATTACHFILESIZELIMIT% KB. 
     32      * Foswiki can limit the file size. This is defined by the =%<nop>ATTACHFILESIZELIMIT%= [[%SYSTEMWEB%.PreferenceSettings][preference settings]], currently set at %ATTACHFILESIZELIMIT% KB. 
    3333         * %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. 
    3434   * Automatic attachments: 
  • trunk/core/data/System/FormatTokens.txt

    r693 r851  
    11---++ Formatting Tokens 
    22 
    3 TWiki defines some standard special tokens that can be used to replace characters in some parameters - notably those to FormattedSearch and IfStatements - to defer evaluation of the parameter until later. These special tokens are often called "escapes", because they allow the character to "escape" from its normal meaning.  
     3Foswiki defines some standard special tokens that can be used to replace characters in some parameters - notably those to FormattedSearch and IfStatements - to defer evaluation of the parameter until later. These special tokens are often called "escapes", because they allow the character to "escape" from its normal meaning.  
    44%STARTINCLUDE%| =$n= or =$n()= | New line. Use =$n()= if followed by alphanumeric character, e.g. write =Foo$n()Bar= instead of =Foo$nBar= | 
    55| =$nop= or =$nop()= | Is a "no operation". This token gets removed; useful for nested search | 
  • trunk/core/data/System/FormattedSearch.txt

    r693 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33%STARTINCLUDE% 
    4 ---+ TWiki Formatted Search 
     4---+ Formatted Search 
    55 
    66_Inline search feature allows flexible formatting of search result_ 
     
    109109*Write this:* 
    110110 
    111 =%<nop>SEARCH{ "__Back to\:__ <nop>FrequentlyAskedQuestions" scope="text" type="regex" nosearch="on" nototal="on" header="TWiki FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [<nop>[$topic][Answer...]]" }%= 
    112  
    113 *To get this:* 
    114  
    115 %SEARCH{ "__Back to\:__ FrequentlyAskedQuestions" scope="text" type="regex" nosearch="on" nototal="on" header="TWiki FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }% 
     111=%<nop>SEARCH{ "__Back to\:__ <nop>FrequentlyAskedQuestions" scope="text" type="regex" nosearch="on" nototal="on" header="FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [<nop>[$topic][Answer...]]" }%= 
     112 
     113*To get this:* 
     114 
     115%SEARCH{ "__Back to\:__ FrequentlyAskedQuestions" scope="text" type="regex" nosearch="on" nototal="on" header="FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }% 
    116116 
    117117 
     
    160160   1. Else supress the search hit 
    161161 
    162 This requires the TWiki:Plugins.SpreadSheetPlugin. The following example shows all topics that are up to exactly one week old. 
     162This requires the Foswiki:Extensions.SpreadSheetPlugin. The following example shows all topics that are up to exactly one week old. 
    163163 
    164164*Write this:* 
     
    170170   * The SEARCH has a deferred CALC. The =$percnt= makes sure that the CALC gets executed once for each search hit 
    171171   * The CALC compares the date of the topic with the =weekold= date 
    172    * If topic is older, a =&lt;nop&gt;= is returned, which gets removed at the end of the TWiki rendering process 
     172   * If topic is older, a =&lt;nop&gt;= is returned, which gets removed at the end of the rendering process 
    173173   * Otherwise, the search hit is formatted and returned 
    174174 
  • trunk/core/data/System/FrequentlyAskedQuestions.txt

    r619 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1163619832" format="1.0" version="$Rev: 10463 $"}% 
    2 ---+ Frequently Asked Questions About TWiki 
     2---+ Frequently Asked Questions 
    33 
    44This is a real FAQ, and also a demo of an easily implemented knowledge-base solution. To see how it's done, [[%SCRIPTURL{"view"}%/%WEB%/%TOPIC%?raw=on][view the source of this topic]]. 
     
    99 
    1010%X% __NOTE:__  
    11 These topics are for frequently asked questions __including__ answers; please ask support questions in the TWiki:Support web. 
     11These topics are for frequently asked questions __including__ answers; please ask support questions in the Foswiki:Support web. 
    1212New FAQ topics are based on the FaqTemplate. 
    1313 
     
    2525Other places where you can find answers to your questions: 
    2626 
    27    * CompleteDocumentation: All you need to know to install and configure TWiki 
     27   * CompleteDocumentation: All you need to know to install and configure Foswiki 
    2828   * TwentyMinuteTutorial: Get a jump start on using this wiki  
    2929   * GoodStyle: Things to consider when changing text 
    30    * WikiSyntax, TextFormattingRules: A quick one-two guide to TWiki shorthand basics 
    31    * TextFormattingFAQ: Answers to frequently asked questions about text styling in TWiki 
    32    * If you can't find an answer, ask a question - post it in the TWiki:Support web 
     30   * WikiSyntax, TextFormattingRules: A quick one-two guide to Foswiki shorthand basics 
     31   * TextFormattingFAQ: Answers to frequently asked questions about text styling in Foswiki 
     32   * If you can't find an answer, ask a question - post it in the Foswiki:Support web 
    3333 
  • trunk/core/data/System/GnuGeneralPublicLicense.txt

    r569 r851  
    33---++ FAQ: 
    44 
    5 TWiki has a GPL (GNU General Public License). What is GPL? 
     5Foswiki has a GPL (GNU General Public License). What is GPL? 
    66 
    77---++ Answer: 
    88 
    9 TWiki is distributed under the GNU General Public License, see DownloadSources. GPL is one of the free software licenses that protects the copyright holder, and at the same time allows users to redistribute the software under the terms of the license. Extract: 
     9Foswiki is distributed under the GNU General Public License, see DownloadSources. GPL is one of the free software licenses that protects the copyright holder, and at the same time allows users to redistribute the software under the terms of the license. Extract: 
    1010 
    1111   * This program is open source software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. 
  • trunk/core/data/System/GoodStyle.txt

    r725 r851  
    22---+ <nop>GoodStyle Collaboration Tips 
    33 
    4    * TWiki has a very simple *[[ShortHand][text formatting shorthand]]*. In any case, you won't go wrong if you simply: 
     4   * Foswiki has a very simple *[[ShortHand][text formatting shorthand]]*. In any case, you won't go wrong if you simply: 
    55      * start each line without spaces 
    66      * separate paragraphs with a blank line  
     
    3333   * For *external site links*, you can type URLs directly into the text - =http://etcete.ra/...= - it'll be clear to anyone where they're headed on click.  
    3434 
    35    * TWiki is intended for world-wide use, and an internationally understood date format like ==01 Sep %SERVERTIME{$year}%== or ==%SERVERTIME{$year}%-09-01== is preferred. It's clearer than the xx/xx/xx format, where a date like 9/1/01 can mean either Jan or Sep, depending on the local conventions of the readers. For months, use the first three letters: Jan, Feb, Mar, Apr,... 
     35   * Foswiki is intended for world-wide use, and an internationally understood date format like ==01 Sep %SERVERTIME{$year}%== or ==%SERVERTIME{$year}%-09-01== is preferred. It's clearer than the xx/xx/xx format, where a date like 9/1/01 can mean either Jan or Sep, depending on the local conventions of the readers. For months, use the first three letters: Jan, Feb, Mar, Apr,... 
    3636 
    3737   * *TIP:* Check the source when you want to find out how something is formatted: click ==Edit== on the lower toolbar. To see earlier versions, click ==More==, then check ==Raw text format== and click ==View revision==. A bit of HTML experience can't hurt, but you'll soon see with ShortHand how far that is from necessary.  
  • trunk/core/data/System/IfStatements.txt

    r700 r851  
    22---+ IF Statements 
    33 
    4 The =%<nop>IF%= construct gives TWiki the power to include content in topics based on the value of simple expressions. 
     4The =%<nop>IF%= construct gives Foswiki the power to include content in topics based on the value of simple expressions. 
    55 
    66=%<nop>IF{"CONDITION" then="THEN" else="ELSE"}%= 
     
    88In the example above, if CONDITION evaluates to TRUE, then THEN will be included in the topic; otherwise ELSE will be included. 
    99 
    10 Note that because of the way TWiki evaluates, then whatever is in the THEN and ELSE parameters will already have been expanded by the time the condition is actually evaluated. The standard FormatTokens can be used in the THEN and ELSE parameters when you need to delay evaluation of (for example) a macro. 
     10Note that because of the way Foswiki evaluates, then whatever is in the THEN and ELSE parameters will already have been expanded by the time the condition is actually evaluated. The standard FormatTokens can be used in the THEN and ELSE parameters when you need to delay evaluation of (for example) a macro. 
    1111 
    1212The basic syntax of a condition is the same as [[QuerySearch][the syntax used for queries]], with the addition of the following special operators: 
     
    3232<verbatim> 
    3333You are %IF{ "$ WIKINAME='WikiGuest' and not defined 'OPEN_DAY'" then="not" }% allowed to 
    34 %IF{ "context view" then="view" else="edit"}% this TWiki today. 
     34%IF{ "context view" then="view" else="edit"}% this Foswiki today. 
    3535</verbatim> 
    3636 
     
    9191*Configuration items* are defined in [[%SCRIPTURLPATH{"configure"}%][configure]]. You cannot see the value of a configuration item, you can only see if the item is set or not. 
    9292 
    93 *Context identifiers* are used in TWiki to label various stages of the rendering process. They are especially useful for [[Skins][skin]] authors to find out where they are in the rendering process. The following context identifiers are available: 
     93*Context identifiers* are used in Foswiki to label various stages of the rendering process. They are especially useful for [[Skins][skin]] authors to find out where they are in the rendering process. The following context identifiers are available: 
    9494| *id* | *context* | 
    9595| absolute_urls | Set if absolute URLs are required | 
    96 | attach | in attach script (see TWikiScripts) | 
     96| attach | in attach script (see CommandAndCGIScripts) | 
    9797| authenticated | a user is authenticated | 
    9898| body_text  | when the body text is being processed in a view (useful in plugin handlers) | 
    9999| can_login | current environment supports login | 
    100 | changes | in changes script (see TWikiScripts) | 
     100| changes | in changes script (see CommandAndCGIScripts) | 
    101101| command_line | the running script was run from the command line, and not from CGI | 
    102 | diff | in rdiff script (see TWikiScripts) | 
    103 | edit | in edit script (see TWikiScripts) | 
     102| diff | in rdiff script (see CommandAndCGIScripts) | 
     103| edit | in edit script (see CommandAndCGIScripts) | 
    104104| footer_text | when the footer text is being processed in a view (useful in plugin handlers) | 
    105105| header_text | when the header text is being processed in a view (useful in plugin handlers) | 
    106106| i18n_enabled | when user interface <nop>I18N support is enabled (i.e., user can choose the language for UI) | 
    107107| inactive | if active links such as 'edit' and 'attach' should be disabled | 
    108 | login & logon | in login / logon script (see TWikiScripts) | 
    109 | manage | in manage script (see TWikiScripts) | 
     108| login & logon | in login / logon script (see CommandAndCGIScripts) | 
     109| manage | in manage script (see CommandAndCGIScripts) | 
    110110| mirror | if this is a mirror | 
    111111| new_topic | if the topic doesn't already exist | 
    112 | oops | in oops script (see TWikiScripts) | 
    113 | preview | in preview script (see TWikiScripts) | 
    114 | register | in register script (see TWikiScripts) | 
    115 | rename | in rename script (see TWikiScripts) | 
    116 | resetpasswd | in resetpasswd script (see TWikiScripts) | 
     112| oops | in oops script (see CommandAndCGIScripts) | 
     113| preview | in preview script (see CommandAndCGIScripts) | 
     114| register | in register script (see CommandAndCGIScripts) | 
     115| rename | in rename script (see CommandAndCGIScripts) | 
     116| resetpasswd | in resetpasswd script (see CommandAndCGIScripts) | 
    117117| rss | if this is an RSS skin rendering | 
    118 | save | in save script (see TWikiScripts) | 
    119 | search | in search script (see TWikiScripts) | 
    120 | statistics | in statistics script (see TWikiScripts) | 
     118| save | in save script (see CommandAndCGIScripts) | 
     119| search | in search script (see CommandAndCGIScripts) | 
     120| statistics | in statistics script (see CommandAndCGIScripts) | 
    121121| textareas_hijacked | provided for use by editors that highjack textareas, and want to signal this fact. This is used by skins, for example, so they can suppress extra controls when textareas have been hijacked. | 
    122 | upload | in upload script (see TWikiScripts) | 
    123 | view | in view script (see TWikiScripts) | 
    124 | viewfile | in viewfile script (see TWikiScripts) | 
    125 | rest | in rest script (see TWikiScripts) | 
     122| upload | in upload script (see CommandAndCGIScripts) | 
     123| view | in view script (see CommandAndCGIScripts) | 
     124| viewfile | in viewfile script (see CommandAndCGIScripts) | 
     125| rest | in rest script (see CommandAndCGIScripts) | 
    126126| registration_supported | registration is supported by the current UserMapper | 
    127127| registration_enabled | set if ={Register}{EnableNewUserRegistration}= is on, and registrationis supported | 
  • trunk/core/data/System/IncludeTopicsAndWebPages.txt

    r693 r851  
    22---+!! Include Topics and Web Pages Using =%<nop>INCLUDE{...}%= Macro 
    33 
    4 Use the =%<nop>INCLUDE{...}%= macro to embed the content of another topic or web page inside a TWiki topic. The whole content or only parts of a page can be included. If needed, set a proxy server in %WIKIPREFSTOPIC%. 
     4Use the =%<nop>INCLUDE{...}%= macro to embed the content of another topic or web page inside a topic. The whole content or only parts of a page can be included. If needed, set a proxy server in %WIKIPREFSTOPIC%. 
    55 
    66%TOC% 
     
    2020---++ Usage Examples 
    2121 
    22 ---+++ 1. Display regression test results in a TWiki page 
     22---+++ 1. Display regression test results 
    2323<pre> 
    2424  &lt;pre&gt; 
     
    3333</pre> 
    3434 
    35 ---+++ 3. Display the current time in Tokyo in a TWiki page 
     35---+++ 3. Display the current time in Tokyo 
    3636 
    3737   * You type: 
  • trunk/core/data/System/InstallationGuide.txt

    r761 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1187845362" format="1.1" version="$Rev: 15965 $"}% 
    22%STARTINCLUDE% 
    3 ---+ TWiki Installation Guide 
     3---+ Installation Guide 
    44 
    55*The following is installation instructions for the TWiki 4.2 production release on an Apache web server on Linux.* Visit TWiki:Support.SupplementalDocuments for supplemental information for installing or upgrading TWiki, including notes on installing TWiki on different platforms, environments and web hosting sites. 
     
    1515Before attempting to install TWiki, you are encouraged to review the TWiki:System.AdminSkillsAssumptions. This guide assumes the person installing TWiki has, at a minimum, basic knowledge of server administration on the system on which TWiki is to be installed. While it is possible to install TWiki with FTP access alone (for example, on a hosted site), it is tricky and may require additional support from your hosting service (for example, in setting file ownership and installing missing perl CPAN libraries). 
    1616 
    17 To help setup a correct Apache configuration, you are very much encouraged to use the automatic tool TWiki:Support.ApacheConfigGenerator which generates the contents for an Apache config file for TWiki based on your inputs. 
     17To help setup a correct Apache configuration, you are very much encouraged to use the automatic tool Foswiki:Support.ApacheConfigGenerator which generates the contents for an Apache config file for TWiki based on your inputs. 
    1818 
    1919While this installation guide specifically describes installation on an Apache web server on Linux, TWiki should be fine with any web server and OS that meet the system requirements (see below). For additional notes on installing TWiki on other systems, see TWiki:Support.SupplementalDocuments. 
     
    5656   1 *Configure the webserver* 
    5757      * Unless you are an Apache expert setting up the webserver can be quite difficult. But TWiki has three resources that make setting up Apache easier. 
    58          * The best and easiest way is to use webpage TWiki:Support.ApacheConfigGenerator which contains a tool that can generate a safe and working config file for TWiki on Apache. 
     58         * The best and easiest way is to use webpage Foswiki:Support.ApacheConfigGenerator which contains a tool that can generate a safe and working config file for TWiki on Apache. 
    5959         * In the root of the twiki installation you find an example config file =twiki_httpd_conf.txt= 
    6060         * In the root of the twiki installation and in the =twiki/bin= directory you find example =.htaccess= files you can copy and modify. The files contains help text explaining how to set them up. In =twiki/bin= you find =.htaccess.txt= which can be copied to =.htaccess= and defined access to the CGI scripts. In the root of TWiki you find =pub-htaccess.txt= which you can copy to =pub/.htaccess=, =subdir-htaccess.txt= which you can copy to all directories as =.htaccess= except bin and pub, and you find =root-htaccess.txt= which you can copy to =.htaccess= in the twiki root directory. But again only use .htaccess files if you do not have root priviledges. 
     
    6262      * *Note!* When you use config files you need to restart Apache each time you change a setting to make the new setting active. 
    6363   1 *Protect the configure script* 
    64       * You should never leave the =configure= script open to the public. Limit access to the =twiki/bin/configure= script to either localhost, an IP address or a specific user using basic Apache authentication. The TWiki:Support.ApacheConfigGenerator lets you setup who has access to the configure script. Also the example twiki-httpd-conf.txt and bin/.htaccess.txt files includes the needed setting to protect the configure script. 
    65       * If you limit the access to a particular user then you need to setup a .htpasswd file that contains the user name and password that Apache will authenticate against. Per default both TWiki:Support.ApacheConfigGenerator and the example config files and .htaccess files uses =twiki/data/.htpasswd= but this file does not exist until you have TWiki running and have registered the first user. You therefore have two options. Either limit the access to localhost or an IP address, or make a .htpasswd file. To make a .htpasswd file change directory to =twiki/data= and issue the command =htpasswd -c .htpasswd username= and enter your password when asked. The username must match the =Require user username= directive in the Apache config file or .htaccess file. Do not use a username you will later use to register in TWiki because TWiki will then claim that you are already registered. 
     64      * You should never leave the =configure= script open to the public. Limit access to the =twiki/bin/configure= script to either localhost, an IP address or a specific user using basic Apache authentication. The Foswiki:Support.ApacheConfigGenerator lets you setup who has access to the configure script. Also the example twiki-httpd-conf.txt and bin/.htaccess.txt files includes the needed setting to protect the configure script. 
     65      * If you limit the access to a particular user then you need to setup a .htpasswd file that contains the user name and password that Apache will authenticate against. Per default both Foswiki:Support.ApacheConfigGenerator and the example config files and .htaccess files uses =twiki/data/.htpasswd= but this file does not exist until you have TWiki running and have registered the first user. You therefore have two options. Either limit the access to localhost or an IP address, or make a .htpasswd file. To make a .htpasswd file change directory to =twiki/data= and issue the command =htpasswd -c .htpasswd username= and enter your password when asked. The username must match the =Require user username= directive in the Apache config file or .htaccess file. Do not use a username you will later use to register in TWiki because TWiki will then claim that you are already registered. 
    6666   1 *Run the =configure= script* from your browser (enter =http://yourdomain/twiki/bin/configure= into your browser address bar) 
    6767      * Resolve any errors or warnings it tells you about. 
     
    8080     For those that do not have access to the Apache config files a sample =subdir-htaccess.txt= file can be copied as =.htaccess= to the data, lib, locale, templates, tools and working directories. 
    8181 
    82 The TWiki:Support.ApacheConfigGenerator as well as the example =twiki_httpd_conf.txt= and example =htaccess.txt= files include the needed settings that protect against all 3 security elements. 
     82The Foswiki:Support.ApacheConfigGenerator as well as the example =twiki_httpd_conf.txt= and example =htaccess.txt= files include the needed settings that protect against all 3 security elements. 
    8383 
    8484---++ Next Steps 
     
    111111</verbatim> 
    112112 
    113 The TWiki:Support.ApacheConfigGenerator includes this section when you choose _ApacheLogin_. In the example =twiki_httpd_conf.txt= and =bin/.htaccess.txt= files this section is commented out with #. Uncomment the section when you use _ApacheLogin_. It is important that this section is commented out or removed when you use _TemplateLogin_. 
     113The Foswiki:Support.ApacheConfigGenerator includes this section when you choose _ApacheLogin_. In the example =twiki_httpd_conf.txt= and =bin/.htaccess.txt= files this section is commented out with #. Uncomment the section when you use _ApacheLogin_. It is important that this section is commented out or removed when you use _TemplateLogin_. 
    114114 
    115115#DefineAdminUser    
  • trunk/core/data/System/InstalledPlugins.txt

    r731 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1159249788" format="1.1" version="$Rev: 15598 $"}% 
    22---+ Installed Plugins 
    3 Plugins are mainly user-contributed add-ons that enhance and extend TWiki features and capabilities. A limited number of plugins are included in the core TWiki distribution - and any of those can be removed - while the rest are optional, available from TWiki:Plugins.PluginPackage. 
     3Plugins are (mainly user-contributed) add-ons that enhance and extend Foswiki features and capabilities. A limited number of plugins are included in the core distribution - and any of those can be removed - while the rest are optional, available from Foswiki:Extensions.WebHome. 
    44 
    5 Here is a list of the plugins currently installed and enabled on this TWiki site: 
     5Here is a list of the plugins currently installed and enabled on this site: 
    66 
    77%PLUGINDESCRIPTIONS% 
  • trunk/core/data/System/InstantEnhancements.txt

    r763 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1163619832" format="1.0" version="$Rev: 13096 $"}% 
    2 ---+!! Instant TWiki Site Enhancements 
     2---+!! Instant Site Enhancements 
    33 
    4 These quick enhancements are aimed at improving and customising your TWiki.  New TWiki site administrators are especially encouraged to review this document for ideas before deploying a new TWikiSite. The metaphor of building a house is useful.  The listed enhancements are some of the details possible when moving into a new office or home. These small changes can make a *big* differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes.  No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics. 
     4These quick enhancements are aimed at improving and customising your TWiki.  New site administrators are especially encouraged to review this document for ideas before deploying a new site. The metaphor of building a house is useful.  The listed enhancements are some of the details possible when moving into a new office or home. These small changes can make a *big* differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes.  No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics. 
    55 
    66Many of these tips are based on setting some special [[WebPreferencesHelp][preferences]]. 
     
    88%S% We recommend implementing at least __some__ of these enhancements __right after installation__ to get a taste for what is possible.  Some of these tips and enhancements _should_ be implemented before or during initial roll-out. 
    99 
    10 This may spark your imagination to *really* customize your site so that it's optimal for *your* users.  Slightly more advanced customization tips are listed in TWiki:Support.AdministratorsCookBook. 
     10This may spark your imagination to *really* customize your site so that it's optimal for *your* users.  Slightly more advanced customization tips can be found in Foswiki:Support.SupplementalDocumentation. 
    1111 
    1212%TOC% 
     
    2323*What we are doing* 
    2424 
    25 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 TWiki Web[[ManagingWebs][{*}]]. Each web has its own <nop>WebPreferences, and you can set them differently for each web. 
     25We 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. 
    2626 
    2727*How to do it* 
     
    4949---+++ Simple way to create %RED% colored text %ENDCOLOR% and graphics 
    5050 
    51 This should be enabled, see the "Miscellaneous Settings" in the DefaultPreferences. If not, look at TWiki:TWiki/DefaultPreferences. Look for the settings RED, BLUE etc (which define HTML tag FONT). To copy/paste the definitions of the colors you need to see the source text, but =Edit= is disabled. Instead, view the topic in ==raw== format (if your skin has no button for this, type "?raw=on" at the end of the URL). 
     51This should be enabled, see the "Miscellaneous Settings" in the DefaultPreferences. Look for the settings RED, BLUE etc (which define HTML tag FONT). To copy/paste the definitions of the colors you need to see the source text, but =Edit= is disabled. Instead, view the topic in ==raw== format (if your skin has no button for this, type "?raw=on" at the end of the URL). 
    5252 
    5353---+++ EZ Graphic Icons to Highlight Text 
     
    7474Most images in DocumentGraphics are 16 x 16 pixels. 
    7575 
    76    * __Related:__ There are other approaches for creating more extensive TWiki icon libraries. This is a simply and quick way to get started. See DocumentGraphics for more info. 
     76   * __Related:__ There are other approaches for creating more extensive icon libraries. This is a simply and quick way to get started. See DocumentGraphics for more info. 
    7777 
    7878---+++ Use TOC macro to create table of content 
     
    9797---++ Personal Productivity - Tools and Tips for Working Faster 
    9898 
    99 Although this area applies to all TWiki setups, the initial focus is on TWiki site managers working on a Linux/Apache TWiki site, from a Windows local PC. The assumption being: if you're working with Linux as your desktop, you're probably a programmer or system admin and have these basics handled! 
     99Although this area applies to all setups, the initial focus is on site managers working on a Linux/Apache site, from a Windows local PC. The assumption being: if you're working with Linux as your desktop, you're probably a programmer or system admin and have these basics handled! 
    100100 
    101101---+++ Use your favorite text editor for major edits 
    102102 
    103 When you have a fair bit of TWiki formatting work - for example, compiling new info pages from various cut'n'paste sources, editing multiple TWiki topics or contributed material - it's often easier to use a real *[[TextEditor]]* instead of the browser's text edit box.  There are several methods for doing this.  For Windows, there are several well-recommended text editors. 
     103When you have a fair bit of formatting work - for example, compiling new info pages from various cut'n'paste sources, editing multiple topics or contributed material - it's often easier to use a real *[[TextEditor]]* instead of the browser's text edit box.  There are several methods for doing this.  For Windows, there are several well-recommended text editors. 
    104104 
    105 __Windows&nbsp;Example:__ [[http://textpad.com][TextPad]] is a low-cost, top flight Windows program, with an extended trial period. You can download from a well-stocked library of user-contributed macros, dictionaries, and syntax and clip files. You can also easily create a TWiki clip collection that allows you to format text with TWiki code: select a text string and click for bold, italic, links, bullet lists - just like a regular HTML editor - and also insert blocks of TWiki code, use simple or regex search and replace, more. 
     105__Windows&nbsp;Example:__ [[http://textpad.com][TextPad]] is a low-cost, top flight Windows program, with an extended trial period. You can download from a well-stocked library of user-contributed macros, dictionaries, and syntax and clip files. You can also easily create a clip collection that allows you to format text with TML code: select a text string and click for bold, italic, links, bullet lists - just like a regular HTML editor - and also insert blocks of TML code, use simple or regex search and replace, more. 
    106106 
    107107__Copy&nbsp;&amp;&nbsp;Paste:__ Using the web window this can work very well.  System differences may present difficulties with this method but it is simple and reliable in most cases. 
    108108 
    109 __Browser&nbsp;Integration:__ Some web browsers can be configured to automatically use an external editor.  See your browser documentation for details.  Such a configuration and a small tool for Linux is described in an example on TWiki.org. TWiki:Codev/EditDaemonWithGVimIntegration 
     109__Browser&nbsp;Integration:__ Some web browsers can be configured to automatically use an external editor.  See your browser documentation for details. 
    110110 
    111 __Alternate&nbsp;Browser:__ While your main browser might not have the features for TWiki topic editing, another one might. 
     111__Alternate&nbsp;Browser:__ While your main browser might not have the features for topic editing, another one might. 
    112112   * An example on the Linux platform is the =w3m= pager/browser for Linux.  This is a text based version similar to =lynx= but it includes text editor features and a configurable command set to act like =lynx= if you are more accustomed to it. 
    113113 
     
    122122__Here's a list of topics I've been involved in recently:__ 
    123123 
    124 ---++++ Codev 
     124---++++ Project Web 
    125125 
    126 %SEARCH{ "%TOPIC%" web="Codev" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}% 
    127 ---++++ Support 
    128  
    129 %SEARCH{ "%TOPIC%" web="Support" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}% 
    130  
    131 ---++++ TWiki 
    132  
    133 %SEARCH{ "%TOPIC%" web="TWiki" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="10"}% 
     126%SEARCH{ "%TOPIC%" web="Project" scope="text" nosearch="on" nosummary="on" noheader="on" nototal="on" order="modified" reverse="on" limit="20"}% 
    134127 
    135128</verbatim> 
     
    157150---++ Change the Default Logo 
    158151 
    159 If you want to change the logo per TWiki web, simply attach a new logo.gif to the web's <nop>WebPreferences, and change the logo's filename by overriding the name using WEBLOGONAME in <nop>WebPreferences:   
     152If you want to change the logo per web, simply attach a new logo.gif to the web's <nop>WebPreferences, and change the logo's filename by overriding the name using WEBLOGONAME in <nop>WebPreferences:   
    160153   * =Set WEBLOGONAME = filename.gif= 
    161154 
     
    186179 
    187180---- 
    188 %T% __NOTE:__ Feel free to add your own tips to TWiki:%WEB%.%TOPIC% as quick notes at the end of the list, following the existing format! 
    189181 
    190182__Related Topics:__ AdminDocumentationCategory 
    191183 
    192 -- __Contributors:__ TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny, TWiki:Main.MattWilkie, TWiki:Main.AmandaSmith 
  • trunk/core/data/System/Macros.txt

    r702 r851  
    88Macros are text strings - =%<nop>MACRONAME%= or =%<nop>MACRONAME{ parameter="value" }%= - that expand into content whenever a topic is rendered for viewing. There are two types of macros: 
    99   1 Preference settings: Can be defined and changed by the user 
    10    1 Predefined macros: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin introduces a =%<nop>CALC{}%= macro) 
     10   1 Predefined macros: Defined by the system or by Plugins (for example, the SpreadSheetPlugin introduces a =%<nop>CALC{}%= macro) 
    1111 
    1212%TOC% 
     
    5151Settings at higher-numbered levels override settings of the same macro at lower numbered levels, unless the macro was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level. 
    5252 
    53 If you are setting a preference and using it in the same topic, note that TWiki reads all the [[%SYSTEMWEB%.PreferenceSettings][preference settings]] from the saved version of the topic before it displays anything.  This means you can use a macro anywhere in the topic, even if you set it somewhere inconspicuous near the end. *But beware:*  it also means that if you change the setting of a macro you are using in the same topic, ==Preview== will show the wrong thing, and you must ==Save== the topic to see it correctly. 
     53If you are setting a preference and using it in the same topic, note that Foswiki reads all the [[%SYSTEMWEB%.PreferenceSettings][preference settings]] from the saved version of the topic before it displays anything.  This means you can use a macro anywhere in the topic, even if you set it somewhere inconspicuous near the end. *But beware:*  it also means that if you change the setting of a macro you are using in the same topic, ==Preview== will show the wrong thing, and you must ==Save== the topic to see it correctly. 
    5454 
    55 The syntax for setting macros is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): <br /> =[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value= 
     55The syntax for setting macros is the same anywhere: <br /> =[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value= 
    5656<blockquote> 
    5757*Examples:* 
     
    9696---++ Predefined Macros 
    9797 
    98 Most predefined macros return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like =%<nop>SEARCH%=, are powerful and general tools. 
     98Most predefined macros return values that were either set in the configuration when Foswiki was installed, or taken from server info (such as current username, or date and time). Some, like =%<nop>SEARCH%=, are powerful and general tools. 
    9999 
    100100   * %X% Predefined macros can be overridden by [[%SYSTEMWEB%.PreferenceSettings][preference settings]] (except TOPIC and WEB) 
     
    102102   * %T% *Take the time to thoroughly read through ALL preference macros.* If you actively configure your site, review macros periodically. They cover a wide range of functions, and it can be easy to miss the one perfect macro for something you have in mind. For example, see =%<nop>INCLUDINGTOPIC%=, =%<nop>INCLUDE%=, and the mighty =%<nop>SEARCH%=. 
    103103 
    104 This version of TWiki - %WIKIVERSION% - predefines the following macros: 
     104This version of Foswiki - %WIKIVERSION% - predefines the following macros: 
    105105 
    106106%SEARCH{ 
  • trunk/core/data/System/MacrosQuickStart.txt

    r700 r851  
    1111[[%SYSTEMWEB%.PreferenceSettings][preference settings]] at the entire site, individual web, or individual topic level. For more information, see *[[Macros]]* 
    1212 
    13 Macros are fully expanded _before_ any of the TWiki text formatting rules are applied. 
     13Macros are fully expanded _before_ any of the text formatting rules are applied. 
    1414 
    1515*Documentation Graphics:* There are many graphics available to use in your topics. Use =%<nop>ICON{"help"}%=, =%<nop>ICON{"tip"}%=, and =%<nop>ICON{"warning"}%= to get: %H%, %T%, and %X%, respectively. DocumentGraphics lists them all. 
  • trunk/core/data/System/MainFeatures.txt

    r733 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 13096 $"}% 
    2 ---+ Main Features of TWiki 
     2---+ Main Features 
    33 
    44   * *Any web browser:* Edit existing pages or create new pages by using any web browser. There is no need to upload pages. 
     
    66   * *Auto links:* Web pages are [[WikiWord][linked automatically]]. You do not need to learn HTML commands to link pages. 
    77   * *Text formatting:* Simple, powerful and easy-to-learn [[WikiSyntax][text formatting rules]]. Basically you write text like you would write an e-mail. 
    8    * *Webs:* Pages are grouped into [[%SYSTEMWEB%.SiteMap][TWiki webs]] (or collections). This allows you to set up separate collaboration groups. 
    9    * *Search:* [[WebSearch][Full text search]] with/without regular expressions. See a sample [[%SCRIPTURLPATH{"search"}%/TWiki/?scope=text&search=learn][search result]]. 
    10    * *E-mail notification:* Get [[WebChangesAlert][automatically notified]] when something has changed in a TWiki web. 
     8   * *Webs:* Pages are grouped into [[%SYSTEMWEB%.SiteMap][webs]] (or collections). This allows you to set up separate collaboration groups. 
     9   * *Search:* [[WebSearch][Full text search]] with/without regular expressions. See a sample [[%SCRIPTURLPATH{"search"}%/%SYSTEMWEB%/?scope=text&search=learn][search result]]. 
     10   * *E-mail notification:* Get [[WebChangesAlert][automatically notified]] when something has changed in a web. 
    1111   * *Structured content:* Use DataForms to classify and categorize unstructured web pages and to create simple workflow systems. 
    1212   * *File attachments:* [[FileAttachment][Upload]] and download any file as an attachment to a page by using your browser. This is similar to file attachments in an e-mail, but it happens on web pages. 
     
    1414   * *Access control:* Define groups and impose fine-grained read and write [[AccessControl][access restrictions]] based on groups and users. 
    1515   * *Macros:* Use [[macros]] to dynamically compose your pages. This allows you for example to include other pages, or show a search result embedded in a page. 
    16    * *TWiki plugins:* Easily install program enhancements using external [[Plugins][plug-in modules]]. Developers can create plug-ins in Perl using the TWiki Plugin API. 
     16   * *Plugins:* Easily install program enhancements using external [[Plugins][plug-in modules]]. Developers can create plug-ins in Perl using the TWiki Plugin API. 
    1717   * *Templates and skins:* A flexible [[SkinTemplates][templating system]] separates program logic and presentation. [[Skins]] overwrite template headers and footers; page content is unaffected. 
    1818   * *Managing pages:* Individual pages can be renamed, moved and deleted through the browser. 
    1919   * *Managing users:* Web-based [[UserRegistration][user registration]] and [[ChangePassword][change of password]]. 
    20    * *Statistics:* Create statistics of TWiki webs. Find out most popular pages and top contributors. 
     20   * *Statistics:* Extract statistics of webs. Find out most popular pages and top contributors. 
    2121   * *Preferences:* Multiple levels of preferences: DefaultPreferences for site-level, WebPreferences for each web, user level preferences, individual topics etc. 
    2222   * *[[SimultaneousEdits][simultaneous page editing]]:*  
  • trunk/core/data/System/ManagingTopics.txt

    r611 r851  
    1010---++ Overview 
    1111 
    12 You can use browser-based controls to change a topic's name, move it to another TWiki web, or delete it to a hidden =Trash= web. 
     12You can use browser-based controls to change a topic's name, move it to another web, or delete it to a hidden =Trash= web. 
    1313 
    1414---++ How to Rename/Move/Delete a Topic 
     
    6969   * 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. 
    7070 
    71 Ultimately, the size, objectives, and policies of your TWiki site, the real-world behavior of your user group, and most importantly, the initial TWiki site management leadership, will determine the most effective implementation of this feature, and the success of the site overall. 
     71Ultimately, the size, objectives, and policies of your site, the real-world behavior of your user group, and most importantly, the initial TWiki site management leadership, will determine the most effective implementation of this feature, and the success of the site overall. 
    7272 
    7373#RenameLimitations 
    7474---++ Known Issues 
    7575 
    76 *Rename/Move* is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist in TWiki at present.  Instead, %<nop>SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is that =search= can show matches that will not be updated due to case differences. Other mismatches with actual rendered output are also possible as the approaches are so different. 
     76*Rename/Move* is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist at present.  Instead, %<nop>SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is that =search= can show matches that will not be updated due to case differences. Other mismatches with actual rendered output are also possible as the approaches are so different. 
    7777 
    7878The following shows some limitations of square bracket processing. 
  • trunk/core/data/System/ManagingWebs.txt

    r700 r851  
    99---++ Overview 
    1010 
    11 A TWikiSite is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs. 
     11A site is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs. 
    1212 
    1313#WebTemplate 
     
    4444---++ Hierarchical Webs 
    4545 
    46 You can only create hierarchical webs (webs within webs) if the ={EnableHierarchicalWebs}= setting in [[%SCRIPTURLPATH{"configure"}%][configure]] is enabled. Hierarchical webs are currently %IF{"{EnableHierarchicalWebs}" then="enabled." else="disabled. Without this setting, TWiki will only allow a single level of hierarchy. With it, you can use multiple levels, like a directory tree, i.e. webs within webs."}% 
     46You can only create hierarchical webs (webs within webs) if the ={EnableHierarchicalWebs}= setting in [[%SCRIPTURLPATH{"configure"}%][configure]] is enabled. Hierarchical webs are currently %IF{"{EnableHierarchicalWebs}" then="enabled." else="disabled. 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."}% 
    4747 
    48 __%T% Note:__ You might not need hierarchical webs. TWiki 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. 
     48__%T% Note:__ 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. 
    4949 
    5050You can create hierarchical webs via the _Adding a New Web_ form above, by using a slash- or dot-separated path name which is based on an existing web name in the _Name of new web:_ field. 
     
    8484   * If you move the web to another parent web you must be allowed to create and change topics in the new parent web. 
    8585    
    86 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.  
     86When you rename a web Foswiki 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 Foswiki installation it is generally best to let an administrator rename webs to avoid too many broken links.  
    8787 
    8888---+++ Edit Conflicts 
     
    9494It is possible, though not recommended, to change the names of the webs in the distribution. 
    9595 
    96 If you plan to rename the %USERSWEB% web, remember that TWiki stores user topics in this web. That means that every WikiName signature - =%USERSWEB%.<nop>SomeUserName= - points to it and would need updating (unless the macro style =%<nop>USERSWEB%.<nop>SomeUserName=, is used throughout). This potentially large change can be performed automatically if you rename the web from the Tools section of %WEBPREFSTOPIC%, as described above. 
     96If you plan to rename the %USERSWEB% web, remember that Foswiki stores user topics in this web. That means that every WikiName signature - =%USERSWEB%.<nop>SomeUserName= - points to it and would need updating (unless the macro style =%<nop>USERSWEB%.<nop>SomeUserName=, is used throughout). This potentially large change can be performed automatically if you rename the web from the Tools section of %WEBPREFSTOPIC%, as described above. 
    9797 
    98 %X% If you want to rename the %SYSTEMWEB% or %USERSWEB% webs, remember they are referred to in the TWiki configuration. You will need to change the ={SystemWebName}=, ={UsersWebName}= and/or ={LocalSitePreferences}= settings in the configuration using the [[%SCRIPTURL{configure}%][configure]] interface. 
     98%X% If you want to rename the %SYSTEMWEB% or %USERSWEB% webs, remember they are referred to in the Foswiki configuration. You will need to change the ={SystemWebName}=, ={UsersWebName}= and/or ={LocalSitePreferences}= settings in the configuration using the [[%SCRIPTURL{configure}%][configure]] interface. 
    9999 
    100100%X% Renaming the webs in the distribution is not recommended because it makes upgrades much more complicated. 
  • trunk/core/data/System/PlainSkin.txt

    r788 r851  
    44The plain skin is used to get the rendered topic text without any page decoration such as side, top or bottom bars. The text is shown without any markup styles. It can be used to display topic content inside an [[http://www.htmlhelp.com/reference/html40/special/iframe.html][IFRAME]]. 
    55 
    6 This skin is part of every TWiki distribution. 
     6This skin is part of every distribution. 
    77 
    88This skin has been used to show topics in a pop-up window; this has been replaced with template =viewplain=. 
     
    1515|  Preview: | [[%SCRIPTURL{view}%/%WEB%/%TOPIC%?skin=plain][Preview with this topic]] | 
    1616|  Base Name: | plain | 
    17 |  Skin Author: | TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie | 
     17|  Skin Author: | TWiki:Main.PeterThoeny, Foswiki:Main.CrawfordCurrie | 
    1818|  Skin Version: | 04 Jan 2006 (v8096) | 
    1919|  Change History: | <!-- specify latest version first -->&nbsp; | 
  • trunk/core/data/System/Plugins.txt

    r812 r851  
    1919Foswiki plugins are developed and contributed by interested members of the community. Plugins are provided on an 'as is' basis; they are not a part of Foswiki, but are independently developed and maintained. 
    2020 
    21 Most TWiki&trade; plugins can also be used with Foswiki if the TWikiCompatibilityPlugin is installed. 
     21Most TWiki<sup>&reg;</sup> plugins can also be used with Foswiki if the TWikiCompatibilityPlugin is installed. 
    2222 
    2323__See other types of extensions:__ ContributedAddOns, [[Contribs]], [[Skins]] 
  • trunk/core/data/System/PrintSkin.txt

    r788 r851  
    44The print skin, useful to print pages with a small header and footer. Other skins, such as PatternSkin, may introduce their own print skin. 
    55 
    6 This skin is part of every TWiki distribution. 
     6This skin is part of every distribution. 
    77 
    88---++ Skin Info 
  • trunk/core/data/System/ProjectContributor.txt

    r577 r851  
    55--> 
    66 
    7 ---+ TWiki Contributor 
     7---+ Project Contributor 
    88 
    99%INCLUDE{"%ATTACHURL%/AUTHORS"}% 
    1010 
    11 On a personal note, I would like to take this opportunity to express my sincere appreciation and thanks to all who contributed ideas, code, fixes and documentation and anything else to the Open Source TWiki project. -- TWiki:Main.PeterThoeny 
    12   
    13 __Note:__ Please contact us at http://TWiki.org if you contributed to TWiki and your name is not on this list! 
     11__Note:__ Please contact us at http://foswiki.org if you contributed to Foswiki and your name is not on this list! 
    1412 
    15 __Disclaimer:__ TWiki gets installed on many public web sites. The TWiki contributors are not affiliated in any way with those sites. 
    16  
    17 __Releated Topics:__ %SYSTEMWEB%.ReleaseHistory, and the List of Production Releases in TWiki:Codev/TWikiReleases 
     13__Disclaimer:__ Foswiki gets installed on many public web sites. The Foswiki contributors are not affiliated in any way with those sites. 
    1814 
    1915%META:FILEATTACHMENT{name="AUTHORS" attr="" comment="" date="1111932261" path="AUTHORS~" size="117" user="ProjectContributor" version="1.1"}% 
  • trunk/core/data/System/ProjectLogos.txt

    r815 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1215477335" format="1.1" version="$Rev: 15474 $"}% 
    2 ---+ TWiki Logos  
     2---+ Logos  
    33 
    4 The official TWiki logo is a big "T" in a speech bubble conveying "working together", and has a "collaborate with TWiki" tag line. 
     4The official Foswiki logo is attached to this page. 
    55 
    6 ---++ TWiki.org Logo Artwork 
     6---++ Logo Artwork 
    77 
    88%STARTINCLUDE% 
     
    1515    <img src="%ATTACHURLPATH%/large.gif" /> 
    1616 
     17=banner.gif=: <br /> 
     18    <img src="%ATTACHURLPATH%/banner.gif" /> 
     19 
     20=badge.gif=: <br /> 
     21    <img src="%ATTACHURLPATH%/badge.gif" /> 
     22 
     23There is also an SVG file. 
    1724 
    1825</td></tr></table> 
     
    2330The logo can be changed by redefining the =WIKILOGOIMG= [[%SYSTEMWEB%.PreferenceSettings][preference setting]]. 
    2431 
    25 If you use the official TWiki.org artwork on your own site you can link back to TWiki.org. Use this HTML (with any logo file on this page): 
     32If you use the official artwork on your own site you must link back to Foswiki.org. Use this HTML (with any logo file on this page): 
    2633 
    27 =&lt;a href="http://twiki.org/"&gt;&lt;img src="%<nop>PUBURL%/%<nop>SYSTEMWEB%/ProjectLogos/smallPowered.gif" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" border="0" /&gt;&lt;/a&gt;= 
     34=&lt;a href="http://foswiki.org/"&gt;&lt;img src="%<nop>PUBURL%/%<nop>SYSTEMWEB%/ProjectLogos/smallPowered.gif" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" border="0" /&gt;&lt;/a&gt;= 
    2835 
    29 If you create your own skin you are encouraged to add the small 80x31 pixel logo at the bottom of your skin: 
     36If you create your own skin you are encouraged to add this small logo at the bottom of your skin. 
    3037 
    31 =&lt;a href="http://twiki.org/"&gt;&lt;img src="%<nop>PUBURL%/%<nop>SYSTEMWEB%/ProjectLogos/smallPowered.gif" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" border="0" /&gt;&lt;/a&gt;= 
     38---++ Right to use Artwork 
    3239 
    33 ---++ Right to use Trademarked Artwork 
     40The logo artwork of Foswiki.org should be used "as is" in order to get consistent branding for Foswiki. 
    3441 
    35 The logo artwork of TWiki.org should be used "as is" in order to get consistent branding for TWiki. 
    36  
    37 You may NOT use any original artwork from TWiki.org, nor make or use modified versions of such artwork, except under the following conditions: 
    38  
    39    * You may use the 'collaborate with TWiki' logo on a Web site that is powered by the TWiki collaboration platform. 
    40    * You may use the 'collaborate with TWiki' logo in product description and promotional material IF and ONLY IF such use can in no way be interpreted as anything other than an attribution. Using the TWiki name and artwork in a manner that implies endorsement of a product or service is not allowed. 
    41  
    42 TWiki<sup>&reg;</sup> is a registered trademark of Peter Thoeny. The TWiki logo and the "Collaborate with TWiki" tagline are trademarks of Peter Thoeny. The TWiki logo is Copyright 2005 by TWiki:Main.PeterThoeny, TWiki:Main.ArthurClemens and ProjectContributors. 
    43  
    44 ---++ Background and Feedback 
    45  
    46 The logo was created by Peter Thoeny and Arthur Clemens in September 2005, based on a lot of feedback from the TWiki community. 
     42You may NOT use any original artwork from Foswiki.org, nor make or use modified versions of such artwork, except under the following conditions: 
     43   * You may use the Foswiki artwork on a web site, in product description and promotional material IF and ONLY IF such use can in no way be interpreted as anything other than an attribution. Using the Foswiki name and artwork in a manner that implies endorsement of a product or service is not allowed. 
    4744 
    4845%STOPINCLUDE% 
  • trunk/core/data/System/QuerySearch.txt

    r700 r851  
    7878| =X/Y= | accesses =Y= from the topic specified by the _value_ of =X=. =X= must evaluate to a topic name | =parent.name/(form.name='ExampleForm')= will evaluate to true if (1) the topic has a parent, (2) the parent topic has the main form type =ExampleForm=. | 
    7979 
    80 Note: at some point TWiki may support multiple forms in the same topic. For this reason you are recommended *not* to use the =fields= shortcut when accessing form fields, but always use the name of the form instead. 
     80Note: at some point Foswiki may support multiple forms in the same topic. For this reason you are recommended *not* to use the =fields= shortcut when accessing form fields, but always use the name of the form instead. 
    8181 
    8282There is a shortcut for accessing form fields. If you use the name of a field (for example, =LastName=) in the query without a . before it, that is taken to mean "the value of the field named this". This works if and only if the field name isn't the same as of the top level entry names or their aliases described above. For example, the following expressions will all evaluate to the same thing: 
     
    102102| =lc(x)= | Converts x to lower case, Use for caseless comparisons. | 
    103103| =uc(x)= | Converts x to UPPER CASE. Use for caseless comparisons. | 
    104 | =d2n(x)= | Converts a date (expressed in [[TimeSpecifications][one of the formats that TWiki can parse]]) to a number of seconds since 1st Jan 1970. This is the format dates are stored in inside TWiki, and you have to convert a string date using =d2n= before you can compare it with - for example - the date an attachment was uploaded. Times without a timezone are assumed to be in server local time. If you have date fields in your forms, note that they are *not* stored in TWiki's internal format, but are stored as text strings. You should still use =d2n= to convert them to numbers for comparisons, though. | 
     104| =d2n(x)= | Converts a date (expressed in [[TimeSpecifications][one of the formats that Foswiki can parse]]) to a number of seconds since 1st Jan 1970. This is the format dates are stored in inside Foswiki, and you have to convert a string date using =d2n= before you can compare it with - for example - the date an attachment was uploaded. Times without a timezone are assumed to be in server local time. If you have date fields in your forms, note that they are *not* stored in TWiki's internal format, but are stored as text strings. You should still use =d2n= to convert them to numbers for comparisons, though. | 
    105105| =NOT= | Invert the result of the subquery | 
    106106| =AND= | Combine two subqueries | 
  • trunk/core/data/System/ReferenceManual.txt

    r832 r851  
    99 
    1010Manual sections in separate pages: 
    11    1. [[TWikiSystemRequirements][System Requirements]] 
     11   1. [[System Requirements]] 
    1212   1. [[InstallationGuide][Installation Guide]] 
    1313   1. [[UpgradeGuide][Upgrade Guide]] 
     
    2626   1. [[Contribs][Contribs]] 
    2727   1. [[Plugins][Plugins]] 
    28    1. [[TWikiFuncDotPm][TWiki::Func Module]] 
    29    1. [[TWikiScripts][TWiki CGI and Command Line Scripts]] 
    30    1. [[TWikiSiteTools][TWiki Site Tools]]  
    31    1. [[ManagingTopics][Managing Topics]]  
    32    1. [[ManagingWebs][Managing Webs]] 
    33    1. [[ManagingUsers][Managing Users]] 
     28   1. [[FoswikiFuncDotPm][Foswiki::Func Module]] 
     29   1. [[CommandAndCGIScripts][CGI and Command Line Scripts]] 
     30   1. [[Site Tools]]  
     31   1. [[Managing Topics]]  
     32   1. [[Managing Webs]] 
     33   1. [[Managing Users]] 
    3434   * *Appendices* 
    3535      * [[ReleaseHistory][A: Development Timeline]] 
     
    3737      * [[CascadingStyleSheets][C: Cascading Style Sheets]] 
    3838 
    39  %T% *ADMINS:* In less than an hour, you can read through and customize the [[UsersGuide][User's Guide]] to reflect the exact feature set enabled on your own TWiki site. See also other enhancement pages:  
     39 %T% *ADMINS:* In less than an hour, you can read through and customize the [[UsersGuide][User's Guide]] to reflect the exact feature set enabled on your own site. See also other enhancement pages:  
    4040   * InstantEnhancements: Simple tips (using just browser, no install needed) and quick (max couple of minutes). 
    4141   * AdminToolsCategory: Topics an admin typically needs, all in one page 
    42    * DocumentGraphics: Collection of useful icons for TWiki applications 
     42   * DocumentGraphics: Collection of useful icons 
    4343 
    4444__Related Topics:__ UserDocumentationCategory, AdminDocumentationCategory 
  • trunk/core/data/System/RegularExpression.txt

    r482 r851  
    2222| =[A-Z][A-Z]*= | Matches one or more uppercase letters | 
    2323| =[0-9]{3}-[0-9]{2}-[0-9]{4}= | US social security number, e.g. *123-45-6789* | 
    24 | =PNG;Chart= | Search for topics containing the words *PNG* _and_ *Chart*. The =";"= _and_ separator is TWiki-specific and is not a regular expression; it is a useful facility that is enabled when regular expression searching is enabled. | 
     24| =PNG;Chart= | Search for topics containing the words *PNG* _and_ *Chart*. The =";"= _and_ separator is Foswiki-specific and is not a regular expression; it is a useful facility that is enabled when regular expression searching is enabled. | 
    2525 
    2626---++ Searches with "and" combinations 
    2727 
    28    * TWiki extends the regular expressions with an _and_ search. The delimiter is a semicolon =;=. Example search for "form" _and_ "template": =form;template= 
     28   * Foswiki extends the regular expressions with an _and_ search. The delimiter is a semicolon =;=. Example search for "form" _and_ "template": =form;template= 
    2929 
    30    * Use Google if your TWiki site is public. Example search for "form" _and_ "template" at TWiki.org: =site:twiki.org +form +template= 
     30   * Use Google if your Foswiki site is public. 
    3131 
    3232---++ Advanced 
  • trunk/core/data/System/ReleaseNotes01x00.txt

    r761 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1177700623" format="1.1" version="$Rev$"}% 
    2 ---+!! TWiki Release 4.2.2 (Freetown), %$DATE% 
     2---+!! Foswiki Release 1.0.0, %$DATE% 
    33 
    44%TOC% 
  • trunk/core/data/System/SearchPatternCookbook.txt

    r688 r851  
    33---+!! Search Pattern Cookbook 
    44 
    5 The Search function in TWiki is very powerful. Especially searches using a RegularExpression play an important part of tapping TWiki's full potential. Unfortunately RegularExpressions can be incredibly obscure to the uninitiated.  
     5The Search function is very powerful. Searches using a RegularExpression play an important part of tapping Foswiki's full potential. Unfortunately RegularExpressions can be incredibly obscure to the uninitiated.  
    66 
    77Most people not familiar (enough) with Regular Expressions mostly cut and paste (and maybe tweak) from existing examples. This page intends to collect lots of examples together. 
     
    1515---+++ Problem definition 
    1616 
    17 Suppose there is a topic with a table defining entries in a !TWikiForm. I.e. they define select menu items in a form template. They are then formatted like: 
     17Suppose there is a topic with a table defining entries in a [[data form]]. I.e. they define select menu items in a form template. They are then formatted like: 
    1818 
    1919<verbatim> 
     
    5252---+++ Problem 
    5353 
    54 Imagine a TWiki form-based topic classification, i.e. every page has a form with several fields. How to: 
     54Imagine a form-based topic classification, i.e. every page has a form with several fields. How to: 
    5555   1. create a search to display all topics where one form field is set to a certain value 
    5656   1. create a search to filter the list above based on the values of a second form field 
     
    5959 
    6060In practice: %BR% 
    61 Image a TWiki form with two fields: 
     61Image a form with two fields: 
    6262   * !TopicClassification = One, Two or Three 
    6363   * !TopicStatus = Test or Final 
     
    7070 
    7171<verbatim> 
    72 %SEARCH{"[T]opicClassification.*value\=.*Two;[T]opicStatus.*value\=.*%URLPARAM{type}%" 
    73 type="regex" casesensitive="on" nosearch="on"  
     72%SEARCH{"TopicClassification='%URLPARAM{type}%'" type="query" nosearch="on"  
    7473format="   * $topic - <font face=\"arial,helvetica\" size=\"1\">  
    7574_last modified by_ $wikiusername _on_ $date </font> %BR% &nbsp;&nbsp;&nbsp;  
     
    9291</verbatim> 
    9392 
    94 This will create similar functionality as TWiki:Plugins.TopicClassificationAddOn 
    95  
    96  
    97 <!-- ============================== --> 
    98 #SearchUsernames 
    99 ---++ Pattern 3: Creating lists of TWiki usernames 
    100  
    101 ---+++ Problem 
    102  
    103 How to populate a list box with all usernames of registered TWiki users 
    104  
    105 ---+++ Solution 1: Appropriate for Sep 2004 TWiki (Cairo) 
    106  
    107 <verbatim> 
    108 <form name="testing" action="%SCRIPTURLPATH{"view"}%/%USERSWEB%" method="get"> 
    109 <select name="topic"> 
    110 <option>Select user...</option> 
    111 %SEARCH{ "Name:;Email:;Country:" web="%USERSWEB%" type="regex" nosearch="on" nototal="on" format="<option>$topic</option>" }% 
    112 </select> 
    113 <input type="submit" value="Go" /> 
    114 </form> 
    115 </verbatim> 
    116  
    117 Which expands to this: (here limited to all Z* users because TWiki.org has so many) 
    118  
    119 <form name="testing" action="%SCRIPTURLPATH{"view"}%/%USERSWEB%" method="get"> 
    120 <select name="topic"> 
    121 <option>Select user...</option> 
    122 %SEARCH{ "Name:;Email:;Country:" web="%USERSWEB%" type="regex" topic="Z*" nosearch="on" nototal="on" format="<option>$topic</option>" }% 
    123 </select> 
    124 <input type="submit" value="Go" /> 
    125 </form> 
    126  
    127 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%.WikiUsers]] topic. 
    128  
    129 ---+++ Solution 2: As Solution 1, but with possibility for multi-selecting usernames 
    130  
    131 The example of Solution 1 produces the list box.  Add a MULTIPLE to the _select_ statement, i.e.: 
    132 <verbatim> 
    133 <select name="topic" size="2" MULTIPLE> 
    134 </verbatim> 
    135  
    136 Please note that the Search pattern is unchanged compared to Solution 1. The change is in the HTML form element. 
    137  
    138 The abovementioned modification is, in effect: 
    139 <form name="testing" action="%SCRIPTURLPATH{"view"}%/%USERSWEB%" method="get"> 
    140 <select name="topic" size="2" MULTIPLE> 
    141 <option>Select user...</option> 
    142 %SEARCH{ "Name:;Email:;Country:" web="%USERSWEB%" type="regex" topic="Z*" nosearch="on" nototal="on" format="<option>$topic</option>" }% 
    143 </select> 
    144 <input type="submit" value="Go" /> 
    145 </form> 
    146  
    147 ---+++ Solution 3: Appropriate for TWiki 4 (Dakar) 
    148  
    149 When the User information is stored in a UserForm (as is default in Dakar) then this list can be generated as follows: 
    150  
    151 <verbatim> 
    152 <form name="testing" action="%SCRIPTURLPATH{"view"}%/%USERSWEB%" method="get"> 
    153 <select name="topic"> 
    154 <option>Select user...</option> 
    155 %SEARCH{"%META:FORM.*[U]serForm" web="%USERSWEB%" type="regex" casesensitive="on" nosearch="on" format="<option>$topic</option>" sort="topic" excludetopic="Test*, TWiki*"}% 
    156 </select> 
    157 <input type="submit" value="Go" /> 
    158 </form> 
    159 </verbatim> 
    160  
    161 In the above example: 
    162    * ==META:FORM.*[U]serForm== will search for all topics with a UserForm attached - change this if you have a different form where userdata is stored. Please note that this search does not actually extract anything from the form - it just uses it to identify the appropriate pages 
    163    * ==excludetopic="Test*, TWiki*"== allows to skip all topics starting with Test and TWiki, such as !TestUser or !WikiAdmin. Use this if you have any special users who you do not want appearing in this list 
     93This will create similar functionality as Foswiki:Extensions.TopicClassificationAddOn 
    16494 
    16595 
    16696<!-- ============================== --> 
    16797#SearchTopicParent 
    168 ---++ Pattern 4: Extract the parent of a given topic 
     98---++ Pattern 3: Extract the parent of a given topic 
    16999 
    170100---+++ Problem 
     
    174104---+++ Solution 1: Using META 
    175105 
    176 Since TWiki 4.0 you can now use the META macro: 
     106Use the META macro: 
    177107 
    178108=%<nop>META{ "parent" dontrecurse="on" }%= 
    179109 
    180110 
    181 ---+++ Solution 2: Using !SpreadSheetPlugin 
    182  
    183 You might think that the following Search would do the trick: 
    184 <verbatim> 
    185 %SEARCH{ "^%BASETOPIC%$" scope="topic" nosearch="on" type="regex" nonoise="on" format="   * $parent" }% 
    186 </verbatim> 
    187  
    188 However, the =$parent= link fails if the topic has no parent set (=$parent= will be empty). You can use some TWiki:Plugins/SpreadSheetPlugin magic to conditionally link to the parent or to =WebHome=: 
    189  
    190 <verbatim> 
    191 $percntCALC{$IF($EXACT($parent,),<nop>,$NOP(   * $parent))}$percnt 
    192 </verbatim> 
    193  
    194 So the total Search query to find a topic's parent topic is: 
    195 <verbatim> 
    196 %SEARCH{ "^%BASETOPIC%$" scope="topic" type="regex" nonoise="on" format="$percntCALC{$IF($EXACT($parent,),<nop>,$NOP(   * $parent))}$percnt" }% 
    197 </verbatim> 
    198  
    199 ---++++ Test Case 
    200  
    201 The parent topic of this topic is: 
    202 %SEARCH{ "^%BASETOPIC%$" scope="topic" type="regex" nonoise="on" format="$percntCALC{$IF($EXACT($parent,),<nop>,$NOP(   * $parent))}$percnt" }% 
    203  
    204 ---+++ Solution 3: Using IF statement 
    205 This pattern can be rewritten using =%<nop>IF%=, removing the dependency on !SpreadSheetPlugin: 
    206 <verbatim> 
    207 %SEARCH{ "^%BASETOPIC%$" web="%BASEWEB%" scope="topic" type="regex" nonoise="on" format="$percntIF{$quot$parent$quot then=$quot   * $parent$quot else=$quot<nop>$quot}$percnt" }% 
    208 </verbatim> 
    209  
    210 ---++++ Test Case 
    211 The parent topic of this topic is: %BR% 
    212 %SEARCH{ "^%BASETOPIC%$" web="%BASEWEB%" scope="topic" type="regex" nonoise="on" format="$percntIF{$quot$parent$quot then=$quot   * $parent$quot else=$quot<nop>$quot}$percnt" }% 
    213  
    214  
    215111<!-- ============================== --> 
    216112#SearchTopicChildren 
    217 ---++ Pattern 5: Show all Children of a given topic 
     113---++ Pattern 4: Show all Children of a given topic 
    218114 
    219115---+++ Problem 
     
    223119---+++ Solution 
    224120 
    225 The parent information is stored in the META:TOPICPARENT meta data. Do a SEARCH to find all topic parent meta data pointing to the current topic: 
     121The parent information is stored in the topic meta data. Do a SEARCH to find all topic parent meta data pointing to the current topic: 
    226122 
    227123<verbatim> 
    228124Children: 
    229 %SEARCH{ "META\:TOPICPARENT.*\"%TOPIC%\"" type="regex" nonoise="on" format="[[$topic]]" separator=", " }% 
     125%SEARCH{ "parent.name='%TOPIC%'" type="query" nonoise="on" format="[[$topic]]" separator=", " }% 
    230126</verbatim> 
    231127 
     
    235131<!-- ============================== --> 
    236132#SearchPublicWebsList 
    237 ---++ Pattern 6: Search and display the home topics of public webs in a list 
     133---++ Pattern 5: Search and display the home topics of public webs in a list 
    238134 
    239135---+++ Problem 
     
    242138 
    243139---+++ Solution 
    244  
    245 _Thanks to Peter Thoeny for these solutions._ 
    246140 
    247141<verbatim> 
     
    257151---+++ Test case 
    258152 
    259 Public webs of TWiki. 
    260  
    261 <form> 
    262 <select name="topic"> 
    263 <option value="%TOPIC%">Select...</option> 
    264 %SEARCH{ "%HOMETOPIC%" scope="topic" web="all" topic="%HOMETOPIC%" format="<option value=\"$web.$topic\">$web</option>" separator=" " }% 
    265 </select> 
    266 <input type="submit"  value="Go" /> 
    267 </form> 
    268  
    269 %T% For private webs, or any other webs you wish to exclude from the display, use "on" for the =Exclude web from a web="all" search= setting in the relevant web's !WebPreferences topic. 
    270  
    271 ---+++ Alternative solution 
    272  
    273 This result can also be accomplished with the %<nop>WEBLIST% macro. 
     153Public webs can be found with the %<nop>WEBLIST% macro. 
    274154 
    275155<form> 
     
    284164<!-- ============================== --> 
    285165#SearchBulletList 
    286 ---++ Pattern 7: Create a select box with values from a bullet list 
     166---++ Pattern 6: Create a select box with values from a bullet list 
    287167 
    288168---+++ Problem 
     
    315195<!-- ============================== --> 
    316196#SearchNamedBulletList 
    317 ---++ Pattern 8: Extract a value from a named bullet list item 
     197---++ Pattern 7: Extract a value from a named bullet list item 
    318198 
    319199---+++ Problem 
     
    339219%SEARCH{"   * [N]ame: " topic="%TOPIC%" type="regex" casesensitive="on" nosummary="on" nosearch="on" noheader="on" nototal="on" format="---+!! $pattern(.*   \* Name: ([^\n]*).*)"}% 
    340220 
    341  
    342 <!-- ============================== --> 
    343 #SearchMetaData 
    344 ---++ Pattern 9: Search for Form and Meta data: explained 
    345  
    346 ---+++ Problem 
    347  
    348 Below is an example of a search that searches form data. The questions are: 
    349    * why is this searching the metadata, shouldn't it just search the text? 
    350    * what is the meaning of the =td..td= in the search expression?  
    351  
    352 <pre> 
    353 %<nop>SEARCH{ "[S]tatus.*(td..td|value\=).*[W]aiting" casesensitive="on" type="regex"  
    354 nosearch="on" nototal="on" format="| [[$topic]]&lt;br /> ($date - $rev -  
    355 [[%<nop>SCRIPTURLPATH{rdiff}%/$web/$topic][Diffs]]) |"}% 
    356 </pre> 
    357  
    358 ---+++ Solution 
    359  
    360 %SEARCH depends on grep, and grep searches the whole file, including the meta data. 
    361  
    362 An example meta data form field is: 
    363 <pre> 
    364 %<nop>META:<nop>FIELD{name="OperatingSystem" title="OperatingSystem" value="Os<nop>Win"}% 
    365 </pre> 
    366 So a search for a form field could look like: 
    367 <pre> 
    368 %<nop>SEARCH{ "[O]peratingSystem.*value\=.*[O]sWin" type="regex" ... }% 
    369 </pre> 
    370    * Using square brackets is a trick to avoid a hit on the topic doing the search. 
    371    * The =.*= indicate that there can be any number of any character between =OperatingSystem= and =value= in the (whole) file 
    372  
    373 Now the original file format of the category table (the predecessor of the TWiki forms) looks like this: 
    374 <verbatim> 
    375 <td valign="top" align="right"> OperatingSystem:  </td><td>  OsWin </td> 
    376 </verbatim> 
    377 The following search finds topics in the old and new format: 
    378 <pre> 
    379 %<nop>SEARCH{ "[O]peratingSystem.*(td..td|value\=).*[O]sWin" type="regex" ... }% 
    380 </pre> 
    381  
    382 The =td..td= matches =td&lt;&gt;td=; a simple search on ="[O]peratingSystem.*[O]sWin"= could find a hit in the topic text by coincidence. 
    383  
    384 A simple =%<nop>SEARCH{ "[O]peratingSystem.*value\=<nop>.*[O]sWin" ...}%= search is sufficient if you do not have topics in the old format. 
    385  
    386  
    387221<!-- ============================== --> 
    388222#MovedTopics 
    389 ---++ Pattern 10: Search all topics that have been moved 
     223---++ Pattern 8: Search all topics that have been moved 
    390224 
    391225---+++ Problem 
     
    395229---+++ Solution 
    396230 
    397 Search for the META:TOPICMOVED meta data. Type this:  
    398  
    399 =Moved topics: %<nop>SEARCH{ "%META\:TOPICMOVED" type="regex" format="$topic, " nosearch="on" noheader="on" nosummary="on" }%= 
    400  
    401 to get this (limited to 10 results): 
    402  
    403 Moved topics: %SEARCH{ "%META\:TOPICMOVED" type="regex" format="$topic, " nosearch="on" noheader="on" nosummary="on" limit="10"}% 
     231Search for the 'moved' meta data. Type this:  
     232 
     233=Moved topics: %<nop>SEARCH{ "moved.to!=''" type="query" format="$topic, " nosearch="on" noheader="on" nosummary="on" }%= 
    404234 
    405235__Related Topics:__ UserDocumentationCategory, SearchHelp, [[Macros]], FormattedSearch, RegularExpression 
  • trunk/core/data/System/ShortHand.txt

    r725 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1154748686" format="1.1" version="$Rev: 9744 $"}% 
    2 ---+ TWiki Shorthand 
     2---+ Shorthand 
    33%INCLUDE{"WikiSyntax"}% 
  • trunk/core/data/System/SimultaneousEdits.txt

    r569 r851  
    77---++ Answer: 
    88 
    9 TWiki allows multiple simultaneous edits of the same topic, and then merges the different changes automatically. You probably won't even notice this happening unless there is a conflict that cannot be merged automatically. In this case, you may see TWiki inserting "change marks" into the text to highlight conflicts between your edits and another person's. These change marks are only used if you edit the same part of a topic as someone else, and they indicate what the text used to look like, what the other person's edits were, and what your edits were. 
     9Foswiki allows multiple simultaneous edits of the same topic, and then merges the different changes automatically. You probably won't even notice this happening unless there is a conflict that cannot be merged automatically. In this case, you may see Foswiki inserting "change marks" into the text to highlight conflicts between your edits and another person's. These change marks are only used if you edit the same part of a topic as someone else, and they indicate what the text used to look like, what the other person's edits were, and what your edits were. 
    1010 
    11 TWiki will warn if you attempt to edit a topic that someone else is editing. It will also warn if a merge was required during a save. 
     11Foswiki will warn if you attempt to edit a topic that someone else is editing. It will also warn if a merge was required during a save. 
    1212 
    1313__Back to:__ FrequentlyAskedQuestions 
  • trunk/core/data/System/SiteMap.txt

    r482 r851  
    22---+ <nop>%WIKITOOLNAME% Site Map 
    33%STARTINCLUDE% 
    4 | *TWiki Web* | *Description of Web* | *Used to...* | *Links* | 
     4| *Web* | *Description of Web* | *Used to...* | *Links* | 
    55%SEARCH{ "\* Set SITEMAPLIST \= on" type="regex" web="%MAINWEB%, %SYSTEMWEB%, all" topic="%WEBPREFSTOPIC%" nototal="on" nosearch="on" format="| <div style=\"white-space: nowrap\"><span style=\"background-color:$pattern(.*?\* Set WEBBGCOLOR\s*=\s*([^\s]*).*)\"><img src=\"%ICONURL{blank-bg}%\" alt=\"Web color\" width=\"16\" height=\"16\" border=\"0\" /></span> <b>[[$web.%HOMETOPIC%][$web]]</b></div> |$pattern(.*?\* Set SITEMAPWHAT\s*=([^\n\r]*).*)  |$pattern(.*?\* Set SITEMAPUSETO\s*=([^\n\r]*).*)  | <div style=\"white-space: nowrap\">[[$web.%HOMETOPIC%][<img src=\"%ICONURL{home}%\" alt=\"Home of $web web\" width=\"16\" height=\"16\" border=\"0\" />]] [[$web.WebSearch][<img src=\"%ICONURL{searchtopic}%\" alt=\"Search $web web\" width=\"16\" height=\"16\" border=\"0\" />]] [[$web.WebChanges][<img src=\"%ICONURL{recentchanges}%\" alt=\"Recent changes in the $web web\" width=\"16\" height=\"16\" border=\"0\" />]] [[$web.%NOTIFYTOPIC%][<img src=\"%ICONURL{notify}%\" alt=\"Get notified of changes to the $web web\" width=\"16\" height=\"16\" border=\"0\" />]]</div> |" }% 
    66| You can use color coding by web for identification and reference. This table is updated automatically based on <nop>WebPreferences settings of the individual webs. Contact %WIKIWEBMASTER% if you need a separate collaboration web for your team. See also %SYSTEMWEB%.AdminToolsCategory. |||| 
  • trunk/core/data/System/SitePermissions.txt

    r664 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1171739081" format="1.1" version="$Rev$"}% 
    2 ---+ Permissions settings of the webs on this TWiki site 
     2---+ Permissions settings of the webs on this Foswiki site 
    33%STARTINCLUDE% 
    44| *Web* | *Sitemap* | *VIEW* || *CHANGE* || *RENAME* || 
     
    1010   * A blank in the the above table may mean _either_ the corresponding control is absent or commented out _or_ that it has been set to a null value.  The two conditions have dramatically different and possibly opposed semantics. 
    1111   * %USERSWEB%.WikiGuest is the guest account - used by unauthenticated users. 
    12    * The TWiki web must not deny view to %USERSWEB%.WikiGuest; otherwise, people will not be able to register. 
     12   * The web must not deny view to %USERSWEB%.WikiGuest; otherwise, people will not be able to register. 
    1313 
    1414%STOPINCLUDE% 
  • trunk/core/data/System/SiteTools.txt

    r733 r851  
    1717 
    1818#WebSearch 
    19 ---++ <nop>WebSearch - search TWiki site 
     19---++ <nop>WebSearch - search the site 
    2020 
    2121WebSearch is a flexible search facility, part of the core feature set. WebSearchAdvanced offers more options, including: 
     
    9090---++ Log Files 
    9191 
    92 TWiki generates monthly log files which are used by the statistics script 
     92Foswiki generates monthly log files which are used by the statistics script 
    9393   * The log file is defined by the *{LogFileName}* setting in [[%SCRIPTURLPATH{"configure"}%][configure]] 
    9494   * The file name is =log&lt;year&gt;&lt;month&gt;.txt= 
     
    123123Outgoing mail is required for UserRegistration and for [[#WebNotify][recent changes alert]]. 
    124124 
    125 TWiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== [[preference setting]]. 
     125Foswiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== [[preference setting]]. 
    126126 
    127127The notify e-mail uses the default =changes.tmpl= template, or a skin if activated by a [[%SYSTEMWEB%.PreferenceSettings][preference setting]]. 
     
    151151 
    152152   * AccessControl describes how to restrict read and write access to topics and webs, by users and groups 
    153    * SitePermissions lists the permissions settings of the webs on this TWiki site 
     153   * SitePermissions lists the permissions settings of the webs on this site 
    154154 
    155155---++ Help with crontab 
  • trunk/core/data/System/SkinBrowser.txt

    r731 r851  
    1111</style> 
    1212 
    13 __Tip:__ Additional skins can be downloaded from TWiki:Extensions.SkinPackage 
     13__Tip:__ Additional skins can be downloaded from Foswiki:Extensions.SkinPackage 
    1414 
    1515__Note:__ [[Skins]] describes how to install and activate a skin 
  • trunk/core/data/System/Skins.txt

    r813 r851  
    33---+ Skins 
    44 
    5 _Skins overlay regular templates to give different looks and feels to TWiki screens._ 
     5_Skins overlay regular templates to give different looks and feels to Foswiki screens._ 
    66 
    77%TOC% 
     
    99---++ Overview 
    1010 
    11 TWiki uses [[skin templates]] as the basis of all the screens it uses to interact with users. Each screen has an associated template file that contains the basic layout of the screen. This is then filled in by the code to generate what you see in the browser. 
    12  
    13 TWiki ships with a default set of template files that give a very basic, CSS-themable, look-and-feel. TWiki also includes support for _skins_ that can be selected to give different, more sophisticated, look and feels. A default TWiki installation will usually start up with the PatternSkin already selected. Skins may also be defined by third parties and loaded into a TWiki installation to give more options. To see how TWiki looks when *no* skin is selected, [[%SCRIPTURL{"view"}%/%WEB%/%TOPIC%?skin=not_a_skin][view this topic with a non-existant skin]]. 
     11Foswiki uses [[skin templates]] as the basis of all the screens it uses to interact with users. Each screen has an associated template file that contains the basic layout of the screen. This is then filled in by the code to generate what you see in the browser. 
     12 
     13Foswiki ships with a default set of template files that give a very basic, CSS-themable, look-and-feel. Foswiki also includes support for _skins_ that can be selected to give different, more sophisticated, look and feels. A default Foswiki installation will usually start up with the PatternSkin already selected. Skins may also be defined by third parties and loaded into a Foswiki installation to give more options. To see how Foswiki looks when *no* skin is selected, [[%SCRIPTURL{"view"}%/%WEB%/%TOPIC%?skin=not_a_skin][view this topic with a non-existant skin]]. 
    1414 
    1515Topic text is not affected by the choice of skin, though a skin can be defined to use a CSS (Cascading Style Sheet), which can sometimes give a radically different appearance to the text. 
    1616 
    17 __Relevant links on TWiki.org:__ 
     17__Relevant links__ 
    1818   * TWiki:Support.SkinsSupplement - __%T% tip:__ supplemental documentation on skins 
    19    * TWiki:Plugins.SkinPackage - list of all contributed skin packages 
    20    * TWiki:Plugins.SkinDevelopment - discussion and feedback on contributed skins 
    21    * TWiki:Plugins.SkinBrainstorming - open forum for new skin ideas 
    22    * TWiki:Plugins.SkinPackageHowTo - template to create a new skin package 
     19   * Foswiki:Extensions.SkinPackage - list of all contributed skin packages 
    2320 
    2421__See other types of extensions:__ ContributedAddOns, [[Contribs]], [[Plugins]] 
    2522 
    26 ---++ Changing the default TWiki skin 
     23---++ Changing the default skin 
    2724 
    2825%WIKITOOLNAME% by default ships with the skin PatternSkin activated. You can set the skin for the whole site, a single web or topic, or for each user individually, by setting the SKIN setting to the name of a skin. If the skin you select doesn't exist, then %WIKITOOLNAME% will pick up the default templates. 
     
    3229You may want to define your own skin, for example to comply with corporate web guidelines, or because you have a aesthetic vision that you want to share. There are a couple of places you an start doing this. 
    3330 
    34 The [[skin templates]] used for skins are located in the =twiki/templates= directory and are named according to the skin: ==&lt;scriptname&gt;.&lt;skin&gt;.tmpl==. Skin files may also be defined in TWiki topics - see SkinTemplates for details. 
    35  
    36 To start creating a new skin, copy the default skin templates (like =view.tmpl=), or copy an existing skin to use as a base for your own skin. You should only need to copy the files you intend to customise, as TWiki can be configured to fall back to another skin if a template is not defined in your skin. Name the files as described above (for example =view.myskin.tmpl=. 
     31The [[skin templates]] used for skins are located in the =twiki/templates= directory and are named according to the skin: ==&lt;scriptname&gt;.&lt;skin&gt;.tmpl==. Skin files may also be defined in Foswiki topics - see SkinTemplates for details. 
     32 
     33To start creating a new skin, copy the default skin templates (like =view.tmpl=), or copy an existing skin to use as a base for your own skin. You should only need to copy the files you intend to customise, as Foswiki can be configured to fall back to another skin if a template is not defined in your skin. Name the files as described above (for example =view.myskin.tmpl=. 
    3734 
    3835If you use PatternSkin as your starting point, and you want to modify the layout, colors or even the templates to suit your own needs, have a look first at the topics PatternSkinCustomization and PatternSkinCssCookbook. 
     
    4643__%X% Note:__ Two skin names have _reserved_ meanings; =text= skin, and skin names starting with =rss= have [[#HardCodedSkins][hard-coded meanings]]. 
    4744 
    48 The following template files are used for TWiki screens, and are referenced in the TWiki core code. If a skin doesn't define its own version of a template file, then TWiki will fall back to the next skin in the skin path, or finally, to the default version of the template file. 
     45The following template files are used for Foswiki screens, and are referenced in the Foswiki core code. If a skin doesn't define its own version of a template file, then Foswiki will fall back to the next skin in the skin path, or finally, to the default version of the template file. 
    4946 
    5047(Certain template files are expected to provide certain TMPL:DEFs - these are listed in sub-bullets) 
     
    119116| =%<nop>WIKILOGOALT%= | Alt text of page logo | 
    120117| =%<nop>WEBBGCOLOR%= | Web-specific background color, defined in the WebPreferences | 
    121 | =%<nop>WIKITOOLNAME%= | The name of your TWiki site | 
    122 | =%<nop>SCRIPTURL%= | The script URL of TWiki | 
     118| =%<nop>WIKITOOLNAME%= | The name of your Foswiki site | 
     119| =%<nop>SCRIPTURL%= | The script URL of Foswiki | 
    123120| =%<nop>SCRIPTURLPATH%= | The script URL path | 
    124121| =%<nop>SCRIPTSUFFIX%= | The script suffix, ex: =.pl=, =.cgi= | 
     
    153150<select name="sel" onchange="this.form.topic.value=this.options[this.selectedIndex].value; this.form.submit()"> 
    154151<option selected="selected" value="">...</option> 
    155 <option value="http://twiki.org/">Intranet home</option> 
     152<option value="http://foswiki.org/">Intranet home</option> 
    156153<option value="%USERSWEB%.%WIKIUSERSTOPIC%">Employee index</option> 
    157154<option value="%USERSWEB%.%HOMETOPIC%">%USERSWEB% web</option> 
     
    173170CSS files are gererally attachments to the skin topic that are included in the the skin templates - in the case of PatternSkin in the template =styles.pattern.tmpl=. 
    174171 
    175    * To see how CSS is used in the default TWiki skin, see: PatternSkin 
     172   * To see how CSS is used in the default Foswiki skin, see: PatternSkin 
    176173   * If you write a complete new skin, this is the syntax to use in a template file: 
    177174<verbatim> 
     
    180177 
    181178---++ Attachment Tables 
    182 Controlling the look and feel of attachment tables is a little bit more complex than for the rest of a skin. By default, the attachment table is a standard TWiki table, and the look is controlled in the same way as other tables. In a very few cases you may want to change the _content_ of the table as well. 
    183  
    184 The format of standard attachment tables is defined through the use of special _TWiki template macros_ which by default, are defined in the =attachtables.tmpl= template using the =%TMPL:DEF= macro syntax described in SkinTemplates. These macros are: 
     179Controlling the look and feel of attachment tables is a little bit more complex than for the rest of a skin. By default, the attachment table is a standard Foswiki table, and the look is controlled in the same way as other tables. In a very few cases you may want to change the _content_ of the table as well. 
     180 
     181The format of standard attachment tables is defined through the use of special _template directives_ which by default, are defined in the =attachtables.tmpl= template using the =%TMPL:DEF= directive syntax described in SkinTemplates. These macros are: 
    185182| *Macro* | *Description* | 
    186183| =ATTACH:files:header= | Standard title bar | 
     
    219216---++ Activating Skins 
    220217 
    221 TWiki uses a _skin search path_, which lets you combine skins additively. The skin path is defined using a combination of [[macros]] and URL parameters. 
    222  
    223 TWiki works by asking for a template for a particular function - for example, 'view'. The detail of how templates are searched for is described in SkinTemplates, but in summary, the templates directory is searched for a file called <code>view.</code><i>skin</i><code>.tmpl</code>, where _skin_ is the name of the skin e.g. =pattern=. If no template is found, then the fallback is to use =view.tmpl=. Each skin on the path is searched for in turn. For example, if you have set the skin path to =local,pattern= then =view.local.tmpl= will be searched for first, then =view.pattern.tmpl= and finally =view.tmpl=. 
     218Foswiki uses a _skin search path_, which lets you combine skins additively. The skin path is defined using a combination of [[macros]] and URL parameters. 
     219 
     220Foswiki works by asking for a template for a particular function - for example, 'view'. The detail of how templates are searched for is described in SkinTemplates, but in summary, the templates directory is searched for a file called <code>view.</code><i>skin</i><code>.tmpl</code>, where _skin_ is the name of the skin e.g. =pattern=. If no template is found, then the fallback is to use =view.tmpl=. Each skin on the path is searched for in turn. For example, if you have set the skin path to =local,pattern= then =view.local.tmpl= will be searched for first, then =view.pattern.tmpl= and finally =view.tmpl=. 
    224221 
    225222The basic skin is defined by a =SKIN= setting: 
     
    244241---++ Hard-Coded Skins 
    245242 
    246 The =text= skin is reserved for TWiki internal use. 
     243The =text= skin is reserved for Foswiki internal use. 
    247244 
    248245Skin names starting with =rss= also have a special meaning; if one or more of the skins in the skin path starts with 'rss' then 8-bit characters will be encoded as XML entities in the output, and the =content-type= header will be forced to =text/xml=. 
    249246 
    250 __Related Topics:__ SkinBrowser, AdminDocumentationCategory, DeveloperDocumentationCategory, TWiki:Support.SkinsSupplement 
    251  
     247__Related Topics:__ SkinBrowser, AdminDocumentationCategory, DeveloperDocumentationCategory 
     248 
  • trunk/core/data/System/StartingPoints.txt

    r725 r851  
    66   * WelcomeGuest: A brief intro for first-time visitors 
    77   * *[[TwentyMinuteTutorial]]*: A compact, 20-minute primer 
    8    * %HOMETOPIC%: Entry point for this TWiki web. 
    9    * TWikiSite: Explains what a TWiki site is 
     8   * %HOMETOPIC%: Entry point for this web. 
    109   * WebChanges: Newest topic changes in the <nop>%WEB% web 
    1110   * FrequentlyAskedQuestions: Common questions about how to use the program 
     
    1413   * ShortHand: Easy to learn rules for editing text 
    1514   * TextFormattingRules: The complete set of text formatting rules  
    16    * TextFormattingFAQ: Common how-to questions about posting in TWiki 
     15   * TextFormattingFAQ: Common how-to questions about posting 
    1716 
    1817   * [[%SYSTEMWEB%.Macros][Macros]]: How to easily embed text, graphics, dynamic content  
    1918 
    20    * MainFeatures: The main features of the TWiki collaboration platform 
     19   * MainFeatures: The main features of Foswiki 
    2120   * FileAttachments: Browser-upload files for distribution or display 
    2221   * WebChangesAlert: Get e-mail alerts linking to the latest page changes 
  • trunk/core/data/System/SystemRequirements.txt

    r761 r851  
    55_Server and client requirements_ 
    66 
    7 Low client and server base requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.  Many extensions exist which enhance and expand TWiki's capabilities; they may have additional requirements. 
     7Low client and server base requirements are core features that keep Foswiki widely deployable, particularly across a range of browser platforms and versions.  Many extensions exist which enhance and expand TWiki's capabilities; they may have additional requirements. 
    88 
    99%TOC% 
     
    1212 
    1313The code is written in Perl 5, and uses a number of shell commands from perl. 
    14 The default package requires [[http://www.gnu.org/software/rcs/rcs.html][RCS (Revision Control System)]], a GNU Free Software package. TWiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements. 
     14The default package requires [[http://www.gnu.org/software/rcs/rcs.html][RCS (Revision Control System)]], a GNU Free Software package. Foswiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements. 
    1515 
    1616| *Resource* | *Required Server Environment *<nop>* | 
    1717| Perl | 5.6.1 or higher (5.8.4 or higher is recommended) | 
    18 | RCS | 5.7 or higher (including GNU =diff=) %BR% Optional, TWiki includes a pure perl implementation of RCS that can be used instead (although it's slower) | 
     18| RCS | 5.7 or higher (including GNU =diff=) %BR% Optional, Foswiki includes a pure perl implementation of RCS that can be used instead (although it's slower) | 
    1919| GNU =diff= | GNU =diff= 2.7 or higher is required when not using the all-Perl <nop>RcsLite.  %BR% Install on PATH if not included with RCS (check version with =diff -v=)  %BR% Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to =diff= | 
    2020| GNU =patch= | For upgrades only: GNU =patch= is required when patching the code using patches in diff format submitted by the community. | 
     
    4242CSS and Javascript are used in most skins. Some skins will require more recent releases of browsers. The default skin is tested on IE 6, 7, Safari 3.0, and recent Mozilla based browsers (such as Firefox). 
    4343 
    44 You can easily select a balance of browser capability versus look and feel. Try the installed skins at %SYSTEMWEB%.SkinBrowser and more at TWiki:Plugins.SkinPackage. 
     44You can easily select a balance of browser capability versus look and feel. Try the installed skins at %SYSTEMWEB%.SkinBrowser and more at Foswiki:Extensions.SkinPackage. 
    4545 
    4646---++ Important note about Plugins 
  • trunk/core/data/System/TemplateWeb.txt

    r482 r851  
    77---++ Purpose 
    88 
    9 Template webs were created to act as templates in creating webs.  It is now possible to create webs via the %SYSTEMWEB%.ManagingWebs topic.  In the not so distant past TWiki webs were created by hand.  The data directory contains the different webs such as *Main* and *TWiki*.  A web that begins with an underscore &quot;_&quot; character is considered invisible and a template.  All files in the *_default* (or any other web that begins with an underscore) template web will be copied into your new web.  The [[_default.%HOMETOPIC%][_default]] web template contains the following topics: =<nop>%HOMETOPIC%, <nop>WebChanges, <nop>WebIndex, <nop>WebNotify, <nop>WebPreferences, <nop>WebSearch, <nop>WebStatistics and <nop>WebTopicList.= 
     9Template webs were created to act as templates in creating webs.  It is now possible to create webs via the %SYSTEMWEB%.ManagingWebs topic.  In the not so distant past webs were created by hand.  The data directory contains the different webs such as *Sandbox* and *System*.  A web that begins with an underscore &quot;_&quot; character is considered invisible and a template.  All files in the *_default* (or any other web that begins with an underscore) template web will be copied into your new web.  The [[_default.%HOMETOPIC%][_default]] web template contains the following topics: =<nop>%HOMETOPIC%, <nop>WebChanges, <nop>WebIndex, <nop>WebNotify, <nop>WebPreferences, <nop>WebSearch, <nop>WebStatistics and <nop>WebTopicList.= 
    1010 
    1111---++ Customizing 
  • trunk/core/data/System/TextFormattingFAQ.txt

    r813 r851  
    22---++ Text Formatting FAQ 
    33 
    4 The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TWiki shorthand system on one quick reference page. 
     4The most frequently asked questions about text formatting are answered. Also, TextFormattingRules contains the complete TML shorthand system on one quick reference page. 
    55 
    66%TOC% 
     
    2222---+++ Text enclosed in angle brackets like &lt;filename&gt; is not displayed. How can I show it as it is? 
    2323 
    24 TWiki interprets text as HTML, and the '&lt;' and '&gt;' characters define where HTML commands start and end. Text _inside_ angle brackets is treated as HTML, and ignored if it doesn't actually do anything - either way, the brackets and its contents are not displayed. 
     24Foswiki interprets text as HTML, and the '&lt;' and '&gt;' characters define where HTML commands start and end. Text _inside_ angle brackets is treated as HTML, and ignored if it doesn't actually do anything - either way, the brackets and its contents are not displayed. 
    2525 
    2626If you want to display angle brackets, enter them as HTML codes instead of typing them in directly: 
     
    3434---+++ Some words appear highlighted, with a "?" link at the end. How can I prevent that? 
    3535 
    36 A question mark after a word is a link to a topic that doesn't yet exist - click it to create the new page. This is a TWiki feature - typing a MeaningfulTitle in a comment is an invitation for someone else to add a new branch to the topic.   
     36A question mark after a word is a link to a topic that doesn't yet exist - click it to create the new page. This is a Foswiki feature - typing a MeaningfulTitle in a comment is an invitation for someone else to add a new branch to the topic.   
    3737 
    3838To prevent auto-linking - say you want to enter a word like <nop>JavaScript - prefix the WikiStyleWord with an exclamation point:  
     
    5959---+++ Text I enter gets wrapped around. How can I keep the formatting as it is? 
    6060 
    61 TWiki interprets text as HTML, so you can use the =preformatted= HTML option to keep the new line of text as is. Enclose the text in &lt;pre&gt; &lt;/pre&gt;, or in TWiki's own &lt;verbatim&gt; &lt;/verbatim&gt; tag: 
     61Foswiki interprets text as HTML, so you can use the =preformatted= HTML option to keep the new line of text as is. Enclose the text in &lt;pre&gt; &lt;/pre&gt;, or in Foswiki's own &lt;verbatim&gt; &lt;/verbatim&gt; tag: 
    6262<pre> 
    6363This text will keep its format as it is: 
     
    6969</pre> 
    7070 
    71 The =pre= tag is standard HTML; =verbatim= is a special TWiki tag that forces text to fixed font mode, and also prevents other tags and TWiki shortcuts from being expanded. 
     71The =pre= tag is standard HTML; =verbatim= is a special Foswiki tag that forces text to fixed font mode, and also prevents macros from being expanded. 
    7272 
    7373__NOTE:__ [[%SYSTEMWEB%.PreferenceSettings][preference settings]] still work within verbatim tags (this is a historical peculiarity) 
  • trunk/core/data/System/TextFormattingRules.txt

    r774 r851  
    33---+ Text Formatting 
    44 
    5 Working in TWiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below. 
     5Working in Foswiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And Foswiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below. 
    66 
    77%TOC{depth="4"}% 
     
    1818---++ Hyperlinks 
    1919 
    20 Being able to create links without any special formatting is a core TWiki feature, made possible with WikiWords and inline URLs. 
     20Being able to create links without any special formatting is a core Foswiki feature, made possible with WikiWords and inline URLs. 
    2121 
    2222---+++ Internal Links 
     
    5050%INCLUDE{"MacrosQuickStart"}% 
    5151 
    52 ---++ <nop>TWikiPlugin Formatting Extensions 
     52---++ Plugin Formatting Extensions 
    5353 
    54 Plugins can extend the functionality of TWiki into many other areas. There are a huge number of TWiki plugins available from the [[http://twiki.org/cgi-bin/view/Plugins][Plugins]] web on TWiki.org. 
     54Plugins can extend the functionality of TWiki into many other areas. There are a huge number of plugins available from the [[Foswiki::Extensions.WebHome][foswiki site]]. 
    5555 
    56 Currently enabled plugins on this TWiki installation, as listed by =%<nop>PLUGINDESCRIPTIONS%=: 
     56Currently enabled plugins on this installation, as listed by =%<nop>PLUGINDESCRIPTIONS%=: 
    5757%PLUGINDESCRIPTIONS% 
    5858 
     
    6161---++ Common Editing Errors 
    6262 
    63 TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ: 
     63Foswiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ: 
    6464 
    6565   * *Q:* Text enclosed in angle brackets like =&lt;filename&gt;= is not displayed. How can I show it as it is? 
  • trunk/core/data/System/TimeSpecifications.txt

    r482 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 12314 $"}% 
    22---++ Time Specifications 
    3 TWiki recognises the following formats for date/time strings. For all strings the time is optional. 
     3Foswiki recognises the following formats for date/time strings. For all strings the time is optional. 
    44   * 31 Dec 2001 - 23:59 
    55   * 2001/12/31 23:59:59 
     
    1515---++ Time Intervals 
    1616 
    17 Some features of TWiki, such as searches, permit the specification of _time intervals_. A time interval is a period of time, such as "1337 to 1451" (the Hundred Years War) or "9th February 2005 to 26th March 2005" (the Christian season of Lent). 
     17Some features of Foswiki, such as searches, permit the specification of _time intervals_. A time interval is a period of time, such as "1337 to 1451" (the Hundred Years War) or "9th February 2005 to 26th March 2005" (the Christian season of Lent). 
    1818 
    1919The recognised format is a [[#RestrictedInterpretation][restricted]] interpretation of the [[http://www.iso.ch/iso/en/prods-services/popstds/datesandtime.html][ISO standard 8601]]. 
     
    5151| =2003=                   | the whole year 2003 | 
    5252| =2003-03-28T/2003-05-15= | from March 28th to May 15th of the year 2003 | 
    53 | =P3w/$today=             | three weeks until today | 
     53| =P3w/$today=             | three weeks before today | 
    5454| 2003-12-12               | 12th Dec 2003, from 0:00 to 23:59:59 | 
    5555| 2003                     | any time in the year 2003 | 
     
    6666---+++ Limitations 
    6767 
    68 If you are entering a date at both ends of the time interval string, the end date must include all leading fields, even if these are the same as in the start date. This limitation forms a proper restriction to the ISO8601 standard. i.e. ISO8601 specifies that =2003-12-12/14= means 12th Dec 2003 00:00 to 14th Dec 2003 23:59:59. However this shorthand is not supported by TWiki and must be written as =2003-12-12/2003-12-14= 
     68If you are entering a date at both ends of the time interval string, the end date must include all leading fields, even if these are the same as in the start date. This limitation forms a proper restriction to the ISO8601 standard. i.e. ISO8601 specifies that =2003-12-12/14= means 12th Dec 2003 00:00 to 14th Dec 2003 23:59:59. However this shorthand is not supported by Foswiki and must be written as =2003-12-12/2003-12-14= 
  • trunk/core/data/System/TopicsAndWebs.txt

    r693 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 13096 $"}% 
    22%META:TOPICPARENT{name="WebHome"}% 
    3 ---+!! TWiki Topics 
     3---+!! Topics 
    44%TOC% 
    55 
    6 The basic building block of a TWiki site is called a __topic__, identified by a unique, hopefully descriptive, %SYSTEMWEB%.WikiWord title. It may seem easier just to call them pages, but specifically a topic is the content of a page.  The distinction seems small but will become more important as your skill using TWiki increases.  TWikiSites are built using topics. 
     6The basic building block of a Foswiki site is called a __topic__, identified by a unique, hopefully descriptive, %SYSTEMWEB%.WikiWord title. It may seem easier just to call them pages, but specifically a topic is the content of a page.  The distinction seems small but will become more important as your skill using Foswiki increases. 
    77 
    88---++ Characteristics 
    99 
    10 A TWiki topic is a rich information unit. *Each* topic has: 
     10A topic is a rich information unit. *Each* topic has: 
    1111 
    1212   * name 
     
    1616      * edited by simply clicking the [[#PageBottom][edit link]] 
    1717      * enter plain text, leaving a blank space between paragraphs like e-mail (all you need) 
    18       * enter simple TWiki shorthand to represent complex HTML and special macros 
     18      * enter simple shorthand to represent complex HTML and special macros 
    1919      * enter HTML if you are familiar with it 
    2020      * include links to other topics, URLs, Web sites, files, images, sounds, or anything else you can put on a regular Web page 
     
    2424      * independently determine who can see, edit, rename, move or delete topics 
    2525      * set permissions by individual users and user groups 
    26       * over-ride topic, TWiki web or site 
     26      * over-ride topic, web or site 
    2727   * revision control 
    2828      * topic changes are automatically saved 
     
    3030      * lets you compare and retrieve changes between any two versions, or review them all 
    3131      * displays any previous version as a regular Web page or as raw topic text 
    32    * TWiki web 
    33       * a TWiki organizational unit to which the topic belongs 
     32   * web 
     33      * an organizational unit (collection) to which the topic belongs 
    3434      * relevant when searching for a topic, referencing it or typing in its URL 
    3535   * meta-data 
     
    4949      * default and user selectable per session 
    5050      * fully configurable look and feel 
    51       * apply skins across an entire TWiki web, or to a single displayed page 
     51      * apply skins across an entire web, or to a single displayed page 
    5252      * use included skins and easily create new ones 
    5353      * try the ==Printable== skin below: stripped down headers and footers suitable for clean hard copy  
     
    5858      * enhanced capability without an interface to users 
    5959   * FileAttachment  
    60       * upload files through your browser to the TWiki server 
     60      * upload files through your browser to the server 
    6161      * attach any type of file (documents, images, applications) for viewing online, storage or sharing downloads with others 
    6262      * upload revisions of existing files with automatic backup of all previous revisions 
     
    6666   * macros 
    6767      * site wide and locally defined macros 
    68       * over-ride topic, TWiki web or site 
     68      * over-ride topic, web or site 
    6969   * [[%SYSTEMWEB%.DataForms][forms]] 
    7070      * store database-style info alongside the free-form topic content 
     
    7474   * [[#RenamingTopics][renaming, moving, and deleting]] 
    7575      * rename a topic and automatically update all of the links to it, site-wide 
    76       * move a topic from one TWiki web to another 
     76      * move a topic from one web to another 
    7777      * safely delete a topic to a special Trash web (invisible, but recoverable from the Web server if necessary) 
    7878   * many more features...  
    7979  
    80 The configuration of your TWiki site, skins and your personal user account can modify the way these features are used and presented to you. 
     80The configuration of your site, skins and your personal user account can modify the way these features are used and presented to you. 
    8181 
    8282#EditingPages 
    8383---++ Creating and editing topics 
    8484 
    85 A primary purpose of TWiki is to make it incredibly easy for you to add and edit information on existing topics, create new topics, and link between TWiki topics. 
     85A primary purpose of Foswiki is to make it incredibly easy for you to add and edit information on existing topics, create new topics, and link between TWiki topics. 
    8686 
    8787   * *To modify a topic*: click the ==Edit== link in the toolbar at the bottom left of every page (using the Default skin). An editing window appears. Type away. Use the GoodStyle and TextFormattingRules links to get pop-up window help. 
     
    9292      * Go back to the topic where you started, and you'll see the *?* has disappeared, and your WikiWord name is now a regular link. Type it anywhere on any topic in that web, and it will be turned into a link. 
    9393      * %H% *One little links rule: each topic, and its WikiWord link, belong to one unique web only.* To link _between_ webs, you must first enter the topic's web name. <br /> 
    94          __Example:__ This is %TOPIC%, in the ==TWiki== web, so that's all you need to type on any topic in this web. But to link to <nop>%TOPIC% from a topic in the ==%USERSWEB%== web, you have to type ==%SYSTEMWEB%.<nop>%TOPIC%== - ==Webname.<nop>TopicName==. It's easy. 
     94         __Example:__ This is %TOPIC%, in the ==%WEB%== web, so that's all you need to type on any topic in this web. But to link to <nop>%TOPIC% from a topic in the ==%USERSWEB%== web, you have to type ==%SYSTEMWEB%.<nop>%TOPIC%== - ==Webname.<nop>TopicName==. It's easy. 
    9595 
    9696Another way to add a topic is to type a new topic name in the Go box or an unknown topic URL.  You can type in either a WikiName to create the topic in the current web or <nop>Web.TopicName to create a topic in a different web than the current page.  Topics created with the Go box or URLs do not have parent meta-data defined. 
     
    102102The color-coded toolbar at the bottom of every topic displays a series of links, including: 
    103103   * ==Attach== - pops a new screen for FileAttachments 
    104    * ==Backlinks== - displays all the TWiki topics with links to the current topic 
     104   * ==Backlinks== - displays all the topics with links to the current topic 
    105105   * ==History== - generates a page showing every change made to the current topic, with names, dates, and changes made (diffs) 
    106106   * ==r3 &gt; r2 &gt; r1== - view most recent revision and changes 
    107107   * ==More== - opens up a new screen containing additional controls  
    108108 
    109 It looks complicated, but the basics you need to begin with are very simple to use.  The flexible and optional features are ready when you care to learn about them - the only way to confuse yourself or your site set-up and users is by using features you really don't need.  Unlike the usual expensive, complex collaboration and project management packages, TWiki is fully functional and effective just by typing in text and making WikiWord links.  All the additional features are there, but only if you need them! 
     109It looks complicated, but the basics you need to begin with are very simple to use.  The flexible and optional features are ready when you care to learn about them - the only way to confuse yourself or your site set-up and users is by using features you really don't need.  Unlike the usual expensive, complex collaboration and project management packages, Foswiki is fully functional and effective just by typing in text and making WikiWord links.  All the additional features are there, but only if you need them! 
    110110 
    111111   * Some controls are self-explanatory and also include instructions and help links. 
    112112   * *Experiment*. You can always ==Cancel== an edit or (using revision control) go Back whenever you like. 
    113    * Get *in-depth info* from the [[%SYSTEMWEB%.%HOMETOPIC%][complete documentation]], including the User's Guide, Configuration Manual and TWiki Reference.  
     113   * Get *in-depth info* from the [[%SYSTEMWEB%.%HOMETOPIC%][complete documentation]], including the User's Guide, Configuration Manual and Foswiki Reference.  
    114114 
    115115#RenamingTopics 
  • trunk/core/data/System/TwentyMinuteTutorial.txt

    r733 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 13239 $"}% 
    22%STARTINCLUDE% 
    3 ---+ 20-Minute TWiki Tutorial 
     3---+ 20-Minute Tutorial 
    44 
    5 This step-by-step, hands-on tutorial gets you up to speed with all the TWikiSite basics, in _mere minutes_... 
     5This step-by-step, hands-on tutorial gets you up to speed with all the basics, in _mere minutes_... 
    66 
    77%TOC% 
     
    1111 
    1212---++ 2. Take a quick tour... 
    13 A TWikiSite is divided into webs; each one usually represents one area of collaboration. You can navigate the webs from the upper right corner of each web page. 
     13A Foswiki site is divided into webs; each one usually represents one area of collaboration. You can navigate the webs from the upper right corner of each web page. 
    1414   * Each web has hyperlinked topics, displayed as pages in your browser.  
    1515   * The home page in each web is the %HOMETOPIC% topic. 
    16    * To browse a TWiki web, just click on any highlighted link. These links are called WikiWords and comprise two or more words with initial capitals, run together.  
     16   * To browse a web, just click on any highlighted link. These links are called WikiWords and comprise two or more words with initial capitals, run together.  
    1717   * Follow the WikiWord link and learn what it is. 
    1818   * If you know the name of a topic, you can jump directly to it by typing its name into the *Go* field on the top of the page. Type =WebSearch= to jump to the search page. __Hint:__ Do not confuse the *Go* field with search. 
    19    * You can search each TWiki web. Enter a search string in the %HOMETOPIC% topic or the WebSearch topic accessible from the =Search= link on each topic. TWiki searches for an exact match; optionally, you can also use RegularExpressions. 
     19   * You can search each web. Enter a search string in the %HOMETOPIC% topic or the WebSearch topic accessible from the =Search= link on each topic. TWiki searches for an exact match; optionally, you can also use RegularExpressions. 
    2020 
    2121---++ 3. Open a private account... 
    22 To edit topics, you need to have a TWiki account. 
    23    * Go to the UserRegistration page to create your TWiki account. Fill in a couple of lines and you're set! 
     22To edit topics, you need to have a login account. 
     23   * Depending on how your site is configured, you may already be authorised. Ask your system administrator. If not, Go to the UserRegistration page to create your account. 
    2424 
    2525---++ 4. Check out TWiki users, groups. 
    26    * Go to the %USERSWEB%.%WIKIUSERSTOPIC% topic; it has a list of all users of TWiki. Your WikiName will be in this list after you register. 
    27    * Go to the %USERSWEB%.WikiGroups topic in the %USERSWEB% web; it has a list of groups which can be used to define fine grained AccessControl in TWiki. 
     26   * Go to the %USERSWEB%.%WIKIUSERSTOPIC% topic; it has a list of all users. Your WikiName will be in this list after you register. 
     27   * Go to the %USERSWEB%.WikiGroups topic in the %USERSWEB% web; it has a list of groups which can be used to define fine grained AccessControl. 
    2828 
    2929---++ 5. Test the page controls... 
     
    6969 
    7070---++ 8. Get e-mail alerts whenever pages are changed... 
    71 %NOTIFYTOPIC% is a subscription service that automatically notifies you by e-mail when topics change in a TWiki web. This is a convenience service - for many people, checking e-mail is easier than checking the Web. 
    72    * If you're using TWiki to collaborate on a project, it's important to know when anyone on your team posts an update. If you're following a specific discussion, it's convenient to know when there's new input. 
     71%NOTIFYTOPIC% is a subscription service that automatically notifies you by e-mail when topics change in a web. This is a convenience service - for many people, checking e-mail is easier than checking the Web. 
     72   * If you're using Foswiki to collaborate on a project, it's important to know when anyone on your team posts an update. If you're following a specific discussion, it's convenient to know when there's new input. 
    7373   * Alerts are e-mailed as links to individual topics that've been changed in a set period: each day, every hour, whatever is configured for your system. 
    74    * It's strongly recommended that you try out the service by subscribing to each TWiki web that's relevant to you. You can subscribe and unsubscribe instantly, on a per web basis using %NOTIFYTOPIC%.  
     74   * It's strongly recommended that you try out the service by subscribing to each web that's relevant to you. You can subscribe and unsubscribe instantly, on a per web basis using %NOTIFYTOPIC%.  
    7575 
    76 That's it! You're now equipped with all the TWiki essentials. You are ready to roll. 
     76That's it! You're now equipped with all the essentials. You are ready to roll. 
    7777 
    78 __NOTE:__ When first using TWiki, it will probably seem strange to be able to change other people's postings - we're used to _separating_ individual messages, with  e-mail, message boards, non-Wiki collaboration platforms. __Don't worry about it.__ You can't accidentally delete important stuff - you can always check previous versions, and copy-and-paste from them if you want to undo any changes. After a short while, TWiki-style free-form communication becomes second-nature. You'll expect it everywhere! 
     78__NOTE:__ When first using Foswiki, it will probably seem strange to be able to change other people's postings - we're used to _separating_ individual messages, with  e-mail, message boards, non-Wiki collaboration platforms. __Don't worry about it.__ You can't accidentally delete important stuff - you can always check previous versions, and copy-and-paste from them if you want to undo any changes. After a short while, TWiki-style free-form communication becomes second-nature. You'll expect it everywhere! 
    7979 
    8080__Related Topics:__ UserDocumentationCategory 
  • trunk/core/data/System/UpgradeGuide.txt

    r755 r851  
    5151      * TWiki:Support.UpgradingPatchReleases 
    5252      * TWiki:Support.InstallingOnSpecificPlatforms 
    53       * TWiki:Support.ApacheConfigGenerator 
     53      * Foswiki:Support.ApacheConfigGenerator 
    5454      * TWiki:Support.SettingFileAccessRightsLinuxUnix 
    5555      * If you upgrade from an older TWiki your =lib/TWiki.cfg= from the old TWiki installation is a good resource for some of the settings you will need but you cannot reuse the old TWiki.cfg. 
     
    251251%STOPINCLUDE% 
    252252 
    253 __Related Topics:__ AdminDocumentationCategory, TWiki:TWiki.UpgradingTWiki, TWiki:TWiki.UpgradingTWiki04x00PatchReleases, TWiki:TWiki.InstallingTWiki#OtherPlatforms, TWiki:TWiki.ApacheConfigGenerator, TWiki:TWiki.SettingFileAccessRightsLinuxUnix 
     253__Related Topics:__ AdminDocumentationCategory, TWiki:TWiki.UpgradingTWiki, TWiki:TWiki.UpgradingTWiki04x00PatchReleases, TWiki:TWiki.InstallingTWiki#OtherPlatforms, Foswiki:Support.ApacheConfigGenerator, TWiki:TWiki.SettingFileAccessRightsLinuxUnix 
  • trunk/core/data/System/UserAuthentication.txt

    r832 r851  
    2626Please note FileAttachments are not protected by %WIKITOOLNAME% User Authentication.  
    2727 
    28 __%T% Tip:__ Foswiki:Support.UserAuthenticationFAQ on TWiki.org has supplemental documentation on user authentication. 
    29  
    3028#PasswordManagement 
    3129---++ Password Management 
     
    6664 
    6765#TemplateLogin 
    68 ---+++ Template Login (select =TWiki::LoginManager::TemplateLogin=) 
     66---+++ Template Login (select =Foswiki::LoginManager::TemplateLogin=) 
    6967 
    7068Template Login asks for a username and password in a web page, and processes them using whatever Password Manager you choose. Users can log in and log out. Client Sessions are used to remember users. Users can choose to have their session remembered so they will automatically be logged in the next time they start their browser. 
     
    7270---++++ Enabling Template Login 
    7371   1 Use the [[%SCRIPTURLPATH{"configure"}%][configure]] interface to 
    74       1 select the =TWiki::LoginManager::TemplateLogin= login manager (on the Security Settings pane). 
     72      1 select the =Foswiki::LoginManager::TemplateLogin= login manager (on the Security Settings pane). 
    7573      1 select the appropriate password manager for your system, or provide your own. 
    7674      1 %H% there is also an EXPERT configure setting ={TemplateLogin}{PreventBrowserRememberingPassword}= that you can set to prevent Browsers from remembering username and passwords if you are concerned about public terminal usage. 
     
    9088 
    9189#ApacheLogin 
    92 ---+++ Apache Login (select =TWiki::LoginManager::ApacheLogin=) 
     90---+++ Apache Login (select =Foswiki::LoginManager::ApacheLogin=) 
    9391 
    9492Using this method %WIKITOOLNAME% does not authenticate users internally. Instead it depends on the =REMOTE_USER= environment variable, which is set when you enable authentication in the webserver. 
     
    106104---++++ Enabling Apache Login using =mod_auth= 
    107105You can use any other Apache authentication module that sets REMOTE_USER. 
    108    1 Use [[%SCRIPTURLPATH{"configure"}%#LoginManager][configure]] to select the =TWiki::LoginManager::ApacheLogin= login manager. 
     106   1 Use [[%SCRIPTURLPATH{"configure"}%#LoginManager][configure]] to select the =Foswiki::LoginManager::ApacheLogin= login manager. 
    109107   1 Use [[%SCRIPTURLPATH{"configure"}%#PasswordManager][configure]] to set up %WIKITOOLNAME% to create the right kind of =.htpasswd= entries. 
    110108   1 Create a =.htaccess= file in the =twiki/bin= directory.<br />%H% There is an template for this file in =twiki/bin/.htaccess.txt= that you can copy and change. The comments in the file explain what need to be done.<br />%H% If you got it right, the browser should now ask for login name and password when you click on the <u>Edit</u>. If =.htaccess= does not have the desired effect, you may need to "AllowOverride All" for the directory in =httpd.conf= (if you have root access; otherwise, e-mail web server support) 
     
    159157This section applies only if you are using authentication with existing login names (i.e. mapping from login names to WikiNames). 
    160158 
    161 <nop>%WIKITOOLNAME% internally manages two usernames: Login Username and TWiki Username. 
    162  
    163    * *Login Username:* When you login to the intranet, you use your existing login username. This name is normally passed to TWiki by the ==REMOTE_USER== environment variable, and used internally. Login Usernames are maintained by your system administrator. 
    164  
    165    * *TWiki Username:* Your name in WikiNotation, ex: ==PeterThoeny==, is recorded when you register using UserRegistration; doing so also generates a personal home page in the %USERSWEB% web. 
    166  
    167 TWiki can automatically map an Intranet (Login) Username to a TWiki Username if the {AllowLoginName} is enabled in [[%SCRIPTURLPATH{"configure"}%][configure]]. The default is to use your WikiName as a login name. 
     159<nop>%WIKITOOLNAME% internally manages two usernames: Login Username and Foswiki Username. 
     160 
     161   * *Login Username:* When you login to the intranet, you use your existing login username. This name is normally passed to Foswiki by the ==REMOTE_USER== environment variable, and used internally. Login Usernames are maintained by your system administrator. 
     162 
     163   * *Foswiki Username:* Your name in WikiNotation, ex: ==JohnSmith==, is recorded when you register using UserRegistration; doing so also generates a personal home page in the %USERSWEB% web. 
     164 
     165Foswiki can automatically map an Intranet (Login) Username to a Foswiki Username if the {AllowLoginName} is enabled in [[%SCRIPTURLPATH{"configure"}%][configure]]. The default is to use your WikiName as a login name. 
    168166 
    169167<blockquote> 
     
    177175If your {PasswordManager} supports password changing, you can change and reset passwords using forms on regular pages. 
    178176 
    179    * The ChangePassword form ( ==TWiki/ChangePassword== ) 
    180    * The ResetPassword form ( ==TWiki/ResetPassword== ) 
     177   * The ChangePassword form ( ==Foswiki/ChangePassword== ) 
     178   * The ResetPassword form ( ==Foswiki/ResetPassword== ) 
    181179 
    182180#ChangingEmails 
     
    185183If the active {PasswordManager} supports storage and retrieval of user e-mail addresses, you can change your e-mail using a regular page. As shipped, this is true only for the Apache 'htpasswd' password manager. 
    186184 
    187    * The ChangeEmailAddress form ( ==TWiki/ChangeEmailAddress== ) 
     185   * The ChangeEmailAddress form ( ==Foswiki/ChangeEmailAddress== ) 
    188186 
    189187#IndividualScripts 
     
    195193---++ How to choose an authentication method 
    196194 
    197 One of the key features of TWiki is that it is possible to add HTML to topics. No authentication method is 100% secure on a website where end users can add HTML, as there is always a risk that a malicious user can add code to a topic that gathers user information, such as session IDs. The TWiki developers have been forced to make certain tradeoffs, in the pursuit of efficiency, that may be exploited by a hacker. 
     195One of the key features of Foswiki is that it is possible to add HTML to topics. No authentication method is 100% secure on a website where end users can add HTML, as there is always a risk that a malicious user can add code to a topic that gathers user information, such as session IDs. The Foswiki developers have been forced to make certain tradeoffs, in the pursuit of efficiency, that may be exploited by a hacker. 
    198196 
    199197This section discusses some of the known risks. You can be sure that any potential hackers have read this section as well! 
    200198 
    201 At one extreme, the most secure method is to use TWiki via SSL (Secure Sockets Layer), with a login manager installed and Client Sessions turned *off*. 
    202  
    203 Using TWiki with sessions turned off is a pain, though, as with all the login managers there are occasions where TWiki will forget who you are. The best user experience is achieved with sessions turned *on*. 
    204  
    205 As soon as you allow the server to maintain information about a logged-in user, you open a door to potential attacks. There are a variety of ways a malicious user can pervert TWiki to obtain another users session ID, the most common of which is known as a [[http://www.perl.com/pub/a/2002/02/20/css.html][cross-site scripting]] attack. Once a hacker has an SID they can pretend to be that user. 
    206  
    207 To help prevent these sorts of attacks, TWiki supports *IP matching*, which ensures that the IP address of the user requesting a specific session is the same as the IP address of the user who created the session. This works well as long as IP addresses are unique to each client, and as long as the IP address of the client can't be faked. 
    208  
    209 Session IDs are usually stored by TWiki in cookies, which are stored in the client browser. Cookies work well, but not all environments or users permit cookies to be stored in browsers. So TWiki also supports two other methods of determining the session ID. The first method uses the client IP address to determine the session ID. The second uses a rewriting method that rewrites local URLs in TWiki pages to include the session ID in the URL.  
     199At one extreme, the most secure method is to use Foswiki via SSL (Secure Sockets Layer), with a login manager installed and Client Sessions turned *off*. 
     200 
     201Using Foswiki with sessions turned off is a pain, though, as with all the login managers there are occasions where Foswiki will forget who you are. The best user experience is achieved with sessions turned *on*. 
     202 
     203As soon as you allow the server to maintain information about a logged-in user, you open a door to potential attacks. There are a variety of ways a malicious user can pervert Foswiki to obtain another users session ID, the most common of which is known as a [[http://www.perl.com/pub/a/2002/02/20/css.html][cross-site scripting]] attack. Once a hacker has an SID they can pretend to be that user. 
     204 
     205To help prevent these sorts of attacks, Foswiki supports *IP matching*, which ensures that the IP address of the user requesting a specific session is the same as the IP address of the user who created the session. This works well as long as IP addresses are unique to each client, and as long as the IP address of the client can't be faked. 
     206 
     207Session IDs are usually stored by Foswiki in cookies, which are stored in the client browser. Cookies work well, but not all environments or users permit cookies to be stored in browsers. So Foswiki also supports two other methods of determining the session ID. The first method uses the client IP address to determine the session ID. The second uses a rewriting method that rewrites local URLs in Foswiki pages to include the session ID in the URL.  
    210208 
    211209The first method works well as long as IP addresses are *unique* to each individual client, and client IP addresses can't be faked by a hacker. If IP addresses are unique and can't be faked, it is almost as secure as cookies + IP matching, so it ranks as the *fourth most secure method*. 
     
    213211If you have to turn IP matching off, and cookies can't be relied on, then you may have to rely on the second method, URL rewriting. This method exposes the session IDs very publicly, so should be regarded as "rather dodgy". 
    214212 
    215 Most TWiki sites don't use SSL, so, as is the case with *most* sites that don't use SSL, there is always a possibility that a password could be picked out of the aether. Browsers do not encrypt passwords sent over non-SSL links, so using Apache Login is no more secure than Template Login. 
     213Most Foswiki sites don't use SSL, so, as is the case with *most* sites that don't use SSL, there is always a possibility that a password could be picked out of the aether. Browsers do not encrypt passwords sent over non-SSL links, so using Apache Login is no more secure than Template Login. 
    216214 
    217215Of the two shipped login managers, Apache Login is probably the most useful. It lets you do this sort of thing: 
     
    223221Finally, it would be really neat if someone was to work out how to use certificates to identify users..... 
    224222 
    225 See TWiki:Support.SecuringTWikiSite for more information. 
     223See Foswiki:Support.SupplementalDocumentation for more information. 
    226224 
    227225%STOPINCLUDE% 
    228 __Related Topics:__ AdminDocumentationCategory, AccessControl, TWiki:Support.UserAuthenticationSupplement, TWiki:Support.SecuringTWikiSite 
     226__Related Topics:__ AdminDocumentationCategory, AccessControl 
  • trunk/core/data/System/UserDocumentationCategory.txt

    r703 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1122323947" format="1.1" version="$Rev$"}% 
    22%META:TOPICPARENT{name="BookView"}% 
    3 ---+ A List of TWiki User Documentation 
     3---+ A List of User Documentation 
    44 
    55%SEARCH{"%TOPIC%" excludetopic="%TOPIC%,WebLeftBar" nonoise="on" format="   * [[$web.$topic][$percntSPACEOUT{$quot$topic$quot}$percnt]]$n      * $summary(100, noheader)"}% 
  • trunk/core/data/System/UsersGuide.txt

    r733 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1120842601" format="1.1" version="$Rev$"}% 
    22%META:TOPICPARENT{name="WebHome"}% 
    3 ---+ TWiki User's Guide 
     3---+ User's Guide 
    44 
    5 _Documentation for TWiki users._ 
     5_Documentation for users._ 
    66 
    7    * *TWiki Quick Start* 
     7   * *Quick Start* 
    88      * WelcomeGuest: A fast track intro covering all the basics 
    99      * BeginnersStartHere: A short introduction training course for beginners 
     
    1111 
    1212   * *One-Page Primers* 
    13       * TWikiSite: Ultra-compact, 2-minute TWiki primer 
     13      * TWikiSite: Ultra-compact, 2-minute primer 
    1414      * TwentyMinuteTutorial: A compact, 20-minute primer<p /> 
    1515      * SearchHelp: Tips and help on search 
    1616      * GoodStyle: Working tips for an open collaboration environment 
    1717      * ShortHand: All of the shorthand basics 
    18       * TextFormattingRules: Scan all TWiki text formatting rules on one page 
     18      * TextFormattingRules: Scan all text formatting rules on one page 
    1919      * [[%SYSTEMWEB%.Macros][Macros]]: How to easily embed text, graphics, dynamic content 
    2020      * FileAttachments: Browser-upload files for distribution or display 
     
    2323 
    2424   * *Help FAQs* 
    25       * FrequentlyAskedQuestions: The first things people ask about TWiki 
    26       * TextFormattingFAQ: Common how-to questions about posting in TWiki  
     25      * FrequentlyAskedQuestions: The first things people ask 
     26      * TextFormattingFAQ: Common how-to questions about posting  
    2727      * Frequent users should also browse the full [[ReferenceManual][Reference Manual]]! 
    2828 
  • trunk/core/data/System/UsingHTML.txt

    r725 r851  
    33 
    44%STARTINCLUDE% 
    5 You can use most HTML tags in TWiki topics without a problem. This is useful where you want to 
     5You can use most HTML tags in topics without a problem. This is useful where you want to 
    66add some content that is formatted in a way that is not supported using [[ShortHand][short hand]], for example, 
    77you can write =&lt;strike&gt;deleted text&lt;/strike&gt;= to get <strike>deleted text</strike>. 
     
    1717Recommendations when pasting HTML from other sources (using the plain-text editor): 
    1818   * Copy only text between =&lt;body&gt;= and =&lt;/body&gt;= tags. 
    19    * Remove all empty lines. TWiki inserts =&lt;p /&gt;= paragraph tags on empty lines, which causes problems if done between HTML tags that do not allow paragraph tags, like for example between table tags. 
    20    * Remove leading spaces. TWiki might interpret some text as lists. 
    21    * Do not span a tag over more than one line. TWiki requires that the opening and closing angle brackets - ==&lt;...&gt;== - of a HTML tag are on the same line, or the tag will be broken. 
     19   * Remove all empty lines. Foswiki inserts =&lt;p /&gt;= paragraph tags on empty lines, which causes problems if done between HTML tags that do not allow paragraph tags, like for example between table tags. 
     20   * Remove leading spaces. Foswiki might interpret some text as lists. 
     21   * Do not span a tag over more than one line. Foswiki requires that the opening and closing angle brackets - ==&lt;...&gt;== - of a HTML tag are on the same line, or the tag will be broken. 
    2222   * In your HTML editing program, save without hard line breaks on text wrap. 
    2323 
  • trunk/core/data/System/VarEDITACTION.txt

    r700 r851  
    77   * Syntax: Set EDITACTION = text|form 
    88   * Expands to: %EDITACTION% 
    9    * Related: TWikiScripts#edit 
     9   * Related: CommandAndCGIScripts#edit 
    1010   * %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. 
  • trunk/core/data/System/VarENCODE.txt

    r688 r851  
    66      * all non-printable ASCII characters below space, except newline (="\n"=) and linefeed (="\r"=) 
    77      * HTML special characters ="<"=, =">"=, ="&"=, single quote (='=) and double quote (="=) 
    8       * TWiki special characters ="%"=, ="["=, ="]"=, ="@"=, ="_"=, ="*"=, ="="= and ="|"= 
     8      * TML special characters ="%"=, ="["=, ="]"=, ="@"=, ="_"=, ="*"=, ="="= and ="|"= 
    99   * Syntax: =%<nop>ENCODE{"string"}%= 
    1010   * Supported parameters: 
  • trunk/core/data/System/VarENV.txt

    r693 r851  
    33#VarENV 
    44---+++ ENV{"varname"} -- inspect the value of an environment variable 
    5    * Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is the environment that the TWiki scripts run in on the web server. 
     5   * Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is the environment that the CommandAndCGIScripts are running in. 
    66   * __Note:__ For security reasons, only those environment variables whose names match the regular expression in ={AccessibleENV}= in the *Security Settings/Miscellaneous* section of =configure= can be displayed. Any other variable will just be shown as an empty string, irrespective of its real value. 
    77   * Example: =%<nop>ENV{MOD_PERL}%= displays as: %ENV{MOD_PERL}% 
  • trunk/core/data/System/VarICONURL.txt

    r683 r851  
    33#VarICONURL 
    44---+++ ICONURL{"name"} -- URL of small documentation graphic or icon 
    5    * Generates the full URL of a DocumentGraphics image, which TWiki renders as an image. The related =%<nop>ICON{"name"}%= generates the full HTML img tag. Specify image name or full filename (see [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]] for details on filenames.) 
     5   * Generates the full URL of a DocumentGraphics image, which Foswiki renders as an image. The related =%<nop>ICON{"name"}%= generates the full HTML img tag. Specify image name or full filename (see [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]] for details on filenames.) 
    66   * Syntax: =%<nop>ICONURL{"name"}%= 
    77   * Examples: 
  • trunk/core/data/System/VarINCLUDE.txt

    r693 r851  
    88     | ="SomeTopic"= | The name of a topic located in the current web, i.e. =%<nop>INCLUDE{"WebNotify"}%= | | 
    99     | ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%SYSTEMWEB%.SiteMap"}%= | | 
    10      | ="http://..."= | A full qualified URL, i.e. =%<nop>INCLUDE{"http://twiki.org:80/index.html"}%=. Supported content types are =text/html= and =text/plain=. <br /> %I% if the URL resolves to an attachment file on the server this will _automatically_ translate to a server-side include. | | 
     10     | ="http://..."= | A full qualified URL, i.e. =%<nop>INCLUDE{"http://foswiki.org:80/index.html"}%=. Supported content types are =text/html= and =text/plain=. <br /> %I% if the URL resolves to an attachment file on the server this will _automatically_ translate to a server-side include. | | 
    1111     | =pattern="..."= |Include a subset of a topic or a web page. Specify a RegularExpression that scans from start (='^'=) to end and contains the text you want to keep in parenthesis, e.g., =pattern="^.*?(from here.*?to here).*"=. IncludeTopicsAndWebPages has more. | none | 
    1212     | =rev="2"= | Include a previous topic revision; N/A for URLs | top revision | 
  • trunk/core/data/System/VarLANGUAGE.txt

    r683 r851  
    33#VarLANGUAGE 
    44---+++ LANGUAGE -- current user's language 
    5    * Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization (e.g. in user interface). 
     5   * Returns the language code for the language used as the current user. This is the language actually used by Foswiki (e.g. in user interface). 
    66   * The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it: 
    77      * If the =LANGUAGE= preference is set, it's used as user's language instead of any language detected from the browser. 
  • trunk/core/data/System/VarLANGUAGES.txt

    r688 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarLANGUAGES 
    4 ---+++ LANGUAGES -- list available TWiki languages 
    5    * List the languages available (as =PO= files) to TWiki. 
    6      Those are the languages in which TWiki's user interface is available. 
     4---+++ LANGUAGES -- list available languages 
     5   * List the languages available (as =PO= files). 
     6     These are the languages in which the user interface is available. 
    77   * Syntax: =%<nop>LANGUAGES{...}%= 
    88   * Supported parameters: 
  • trunk/core/data/System/VarMAKETEXT.txt

    r693 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarMAKETEXT 
    4 ---+++ MAKETEXT -- creates text using TWiki's <nop>I18N infrastructure 
     4---+++ MAKETEXT -- creates text using Foswiki's <nop>I18N infrastructure 
    55   * Syntax: =%<nop>MAKETEXT{"string" args="..."}%= 
    66   * Supported parameters: 
     
    1919        <em> %MAKETEXT{"Did you want to [[[_1]][reset [_2]'s password]]?" args="%SYSTEMWEB%.ResetPassword,%WIKIUSERNAME%"}% </em> 
    2020   * __Notes:__ 
    21       * TWiki will translate the =string= to the current user's language _only_ 
     21      * Foswiki will translate the =string= to the current user's language _only_ 
    2222        if it has such string in its translation table for that language. 
    2323      * Amperstands (<code>&amp;</code>) followed by one letter (one of a...z, A...Z) 
  • trunk/core/data/System/VarPLUGINVERSION.txt

    r683 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarPLUGINVERSION 
    4 ---+++ PLUGINVERSION -- the version of a TWiki Plugin, or the TWiki Plugins API 
     4---+++ PLUGINVERSION -- the version of a Foswiki Plugin, or the Foswiki Plugins API 
    55   * Syntax: =%<nop>PLUGINVERSION{"name"}%= to get the version of a specific plugin 
    66   * Example: =%<nop>PLUGINVERSION{"InterwikiPlugin"}%= expands to =%PLUGINVERSION{"InterwikiPlugin"}%= 
  • trunk/core/data/System/VarSCRIPTURL.txt

    r683 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarSCRIPTURL 
    4 ---+++ SCRIPTURL -- base URL of TWiki scripts 
     4---+++ SCRIPTURL -- base URL of scripts 
    55   * Syntax: =%<nop>SCRIPTURL%= 
    66   * Expands to: =%SCRIPTURL%= 
  • trunk/core/data/System/VarSCRIPTURL2.txt

    r683 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarSCRIPTURL2 
    4 ---+++ SCRIPTURL{"script"} -- URL of TWiki script 
     4---+++ SCRIPTURL{"script"} -- URL of script 
    55   * Syntax: =%<nop>SCRIPTURL{"script"}%= 
    66   * Expands to: =%SCRIPTURL{"script"}%= 
  • trunk/core/data/System/VarSCRIPTURLPATH.txt

    r683 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarSCRIPTURLPATH 
    4 ---+++ SCRIPTURLPATH -- base URL path of TWiki scripts 
     4---+++ SCRIPTURLPATH -- base URL path of scripts 
    55   * As =%<nop>SCRIPTURL%=, but doesn't include the protocol and host part of the URL 
    66   * Syntax: =%<nop>SCRIPTURLPATH%= 
  • trunk/core/data/System/VarSCRIPTURLPATH2.txt

    r683 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarSCRIPTURLPATH2 
    4 ---+++ SCRIPTURLPATH{"script"} -- URL path of TWiki script 
     4---+++ SCRIPTURLPATH{"script"} -- URL path of script 
    55   * As =%<nop>SCRIPTURL{"script"}%=, but doesn't include the protocol and host part of the URL 
    66   * Syntax: =%<nop>SCRIPTURLPATH{"script"}%= 
  • trunk/core/data/System/VarSEARCH.txt

    r693 r851  
    3737   * Example: =%<nop>SEARCH{"wiki" web="%USERSWEB%" scope="topic"}%= 
    3838   * Example with format: =%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"}%= _(displays results in a table with header - [[FormattedSearch][details]])_ 
    39    * %H% Hint: If the TWiki:Plugins.TablePlugin is installed, you may put a =%<nop>TABLE{}%= macro just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: =%<nop>TABLE{ tablewidth="90%" }%= 
     39   * %H% Hint: If the Foswiki:Extensions.TablePlugin is installed, you may put a =%<nop>TABLE{}%= macro just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: =%<nop>TABLE{ tablewidth="90%" }%= 
    4040   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarMETASEARCH][METASEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTOPICLIST][TOPICLIST]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWEBLIST][WEBLIST]], FormattedSearch, QuerySearch, SearchHelp, SearchPatternCookbook, RegularExpression 
  • trunk/core/data/System/VarSTARTSECTION.txt

    r683 r851  
    1616     | =type="..."= | Type of the section; type ="section"=, ="include"= or ="templateonly"= | ="section"= | 
    1717   * __%X% Note:__ If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with =_SECTION0= for the first unnamed section in the topic, =_SECTION1= for the second, etc.. 
    18    * __%X% Note:__ You can define nested sections. It is not recommended to overlap sections, although it is valid in TWiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are *not* displayed when a topic is viewed. 
     18   * __%X% Note:__ You can define nested sections. It is not recommended to overlap sections, although it is valid in Foswiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are *not* displayed when a topic is viewed. 
    1919   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENDSECTION][ENDSECTION]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarINCLUDE][INCLUDE]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarNOP][NOP]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSTARTINCLUDE][STARTINCLUDE]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSTOPINCLUDE][STOPINCLUDE]] 
    2020 
  • trunk/core/data/System/VarSYSTEMWEB.txt

    r700 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarSYSTEMWEB 
    4 ---+++ SYSTEMWEB -- name of TWiki documentation web 
     4---+++ SYSTEMWEB -- name of documentation web 
    55   * The web containing all documentation and default [[%SYSTEMWEB%.PreferenceSettings][preference settings]] 
    66   * Syntax: =%<nop>SYSTEMWEB%= 
  • trunk/core/data/System/VarTOC2.txt

    r683 r851  
    1313   * Example: =%<nop>TOC{depth="2"}%= 
    1414   * Example: =%<nop>TOC{"CompleteDocumentation" web="%SYSTEMWEB%" title="Contents:"}%= 
    15    * Example: see TWiki:Sandbox.TestTopicInclude 
     15   * Example: see Foswiki:Sandbox.TestTopicInclude 
    1616   * %T% Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, <tt>---+ Heading &lt;!--5--&gt;</tt>. 
    1717   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTOC][TOC]] 
  • trunk/core/data/System/VarURLPARAM.txt

    r693 r851  
    2020      * Double quotes in URL parameters must be escaped when passed into other macros.%BR% Example: =%<nop>SEARCH{ "%<nop>URLPARAM{ "search" encode="quotes" }%" noheader="on" }%= 
    2121      * When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
    22       * Watch out for TWiki internal parameters, such as =rev=, =skin=, =template=, =topic=, =web=; they have a special meaning in TWiki. Common parameters and view script specific parameters are documented at TWikiScripts. 
     22      * Watch out for internal parameters, such as =rev=, =skin=, =template=, =topic=, =web=; they have a special meaning in TWiki. Common parameters and view script specific parameters are documented at TWikiScripts. 
    2323      * If you have =%<nop>URLPARAM{= in the value of a URL parameter, it will be modified to =%&lt;nop&gt;URLPARAM{=. This is to prevent an infinite loop during expansion. 
    2424      * There is a risk that this macro could be misused for cross-site scripting. 
  • trunk/core/data/System/VarUSERINFO.txt

    r683 r851  
    1111      * Example: =%<nop>USERINFO{ "WikiGuest" format="$username is really $wikiname" }%= 
    1212      * Expands to: <code>%USERINFO{ "WikiGuest" format="$username is really !$wikiname" }%</code> 
    13       * __Note:__ The parameter should be the wikiname of a user. Since TWiki 4.2.1, you can also pass a login name. You can only get information about another user if the ={AntiSpam}{HideUserDetails}= configuration option is not enabled, or if you are an admin. %IF{"{AntiSpam}{HideUserDetails}" then=" _(User details are hidden in this TWiki)_ "}% 
     13      * __Note:__ The parameter should be the wikiname of a user. You can also pass a login name. You can only get information about another user if the ={AntiSpam}{HideUserDetails}= configuration option is not enabled, or if you are an admin. %IF{"{AntiSpam}{HideUserDetails}" then=" _(User details are hidden in this TWiki)_ "}% 
    1414   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERNAME][USERNAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKINAME][WIKINAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKIUSERNAME][WIKIUSERNAME]], UserAuthentication, ChangeEmailAddress 
  • trunk/core/data/System/VarUSERNAME.txt

    r693 r851  
    33#VarUSERNAME 
    44---+++ USERNAME -- your login username 
    5    * TWiki makes names available in three formats: USERNAME like =jsmith=, WIKINAME like =JohnSmith= and WIKIUSERNAME like =%USERSWEB%.JohnSmith=. Un-authenticated users are all %USERSWEB%.WikiGuest. 
     5   * Foswiki makes names available in three formats: USERNAME like =jsmith=, WIKINAME like =JohnSmith= and WIKIUSERNAME like =%USERSWEB%.JohnSmith=. Un-authenticated users are all %USERSWEB%.WikiGuest. 
    66   * Syntax: =%<nop>USERNAME%= 
    77   * Expands to: =%USERNAME%= 
  • trunk/core/data/System/VarVBAR.txt

    r700 r851  
    44 
    55---+++ VBAR -- vertical bar 
    6    * The vertical bar macro can be used in TWiki tables. 
     6   * The vertical bar macro can be used in TML tables. 
    77   * Current value: VBAR = %VBAR% 
    88   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBR][BR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBULLET][BULLET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB][BB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB2][BB2]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB3][BB3]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB4][BB4]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarCARET][CARET]] 
  • trunk/core/data/System/VarWIKITOOLNAME.txt

    r683 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarWIKITOOLNAME 
    4 ---+++ WIKITOOLNAME -- name of your TWiki site 
     4---+++ WIKITOOLNAME -- name of your site 
    55   * Syntax: =%<nop>WIKITOOLNAME%= 
    66   * Expands to: =%WIKITOOLNAME%= 
  • trunk/core/data/System/VarWIKIVERSION.txt

    r683 r851  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarWIKIVERSION 
    4 ---+++ WIKIVERSION -- the version of the installed TWiki engine 
     4---+++ WIKIVERSION -- the version of the installed Foswiki engine 
    55   * Syntax: =%<nop>WIKIVERSION%= 
    66   * Expands to: =%WIKIVERSION%= 
  • trunk/core/data/System/WabiSabi.txt

    r482 r851  
    2222For more about wabi-sabi, see http://www.art.unt.edu/ntieva/artcurr/asian/wabisabi.html 
    2323 
    24 __Related Topics:__ WikiCulture, TWikiSite 
     24__Related Topics:__ WikiCulture 
    2525 
    2626%META:FILEATTACHMENT{name="wabisabi.gif" attr="h" comment="Wabi Sabi" date="984123900" path="C:\DATA\wabisabi.gif" size="994" user="ProjectContributor" version=""}% 
  • trunk/core/data/System/WebAtomBase.txt

    r786 r851  
    44---++ Find out What's New 
    55 
    6 There are several ways to find out what's new in each TWiki web: 
     6There are several ways to find out what's new in each web: 
    77   1. Visit WebChanges to see recent changes 
    88   1. Subscribed in WebNotify get notified of recent changes by e-mail 
    9    1. Use a news readers such as TWiki:Plugins/HeadlinesPlugin to display the recent changes 
     9   1. Use a news readers such as Foswiki:Extensions.HeadlinesPlugin to display the recent changes 
    1010      * The source can be a RSS 1.0 feed (WebRss) or ATOM 1.0 feed (WebAtom) 
    11       * Learn more on RSS at WebRssBase and TWiki:Codev/TWikiSyndication 
    12       * Learn more on ATOM at TWiki:Codev/AtomSyndication 
     11      * Learn more at WebRssBase and Foswiki::Support.SupplementalDocumentation 
    1312 
    1413---++ ATOM Feed Usage 
     
    2019---++ ATOM Feed Internals 
    2120 
    22 Each web has a WebAtom topic which includes part of this <nop>%TOPIC% topic. This topic is the base for the ATOM feed and generates an WebAtom 1.0 feed for TWiki:Codev/AtomSyndication. 
     21Each web has a WebAtom topic which includes part of this <nop>%TOPIC% topic. This topic is the base for the ATOM feed and generates an WebAtom 1.0 feed. 
    2322 
    2423The WebAtom topic in each web contains the following text: 
     
    4746----- 
    4847 
    49 __See also__: WebRssBase, TWiki:Codev/AtomSyndication  
     48__See also__: WebRssBase 
    5049 
  • trunk/core/data/System/WebChangesAlert.txt

    r482 r851  
    22---+++ Web Changes Notification Service 
    33 
    4 Each TWiki web has an automatic e-mail notification service that sends you an e-mail with links to all of the topics modified since the last alert.  
     4Each Foswiki web has an automatic e-mail notification service that sends you an e-mail with links to all of the topics modified since the last alert.  
    55 
    66%INCLUDE{"MailerContrib"}% 
    77 
    8 __Note for System Administrators:__ Notification is supported by an add-on to the TWiki kernel called the !MailerContrib. See the [[%SYSTEMWEB%.MailerContrib][MailerContrib]] topic for details of how to set up this service. 
     8__Note for System Administrators:__ Notification is supported by an add-on to the Foswiki kernel called the !MailerContrib. See the [[%SYSTEMWEB%.MailerContrib][MailerContrib]] topic for details of how to set up this service. 
    99 
    1010__Note:__ If you prefer a news feed, point your reader to [[%INCLUDINGWEB%.WebRss][WebRss]] (for RSS 1.0 feeds) or [[%INCLUDINGWEB%.WebAtom][WebAtom]] (for ATOM 1.0 feeds). Learn more at [[%SYSTEMWEB%.WebRssBase][WebRssBase]] and [[%SYSTEMWEB%.WebAtomBase][WebAtomBase]], respectively. 
  • trunk/core/data/System/WebHome.txt

    r850 r851  
    22<div style="float:right;width:255px;padding:1em;text-align:center;"> 
    33<a href="http://twiki.org"><img src="%PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/large.gif" style="margin:.3em 0;" alt="Visit Foswiki.org" title="Visit Foswiki.org" border="0" /></a> 
    4 <br />The main Foswiki<sup>&reg;</sup> site is <a href="http://twiki.org"><span class="twikiLinkLabel">foswiki.org</span></a> 
     4<br />The main Foswiki site is <a href="http://foswiki.org"><span class="twikiLinkLabel">foswiki.org</span></a> 
    55</div> 
    66---+!! Welcome to the %WEB% Web 
  • trunk/core/data/System/WebPreferences.txt

    r836 r851  
    1515      * #Set WEBHEADERART =  
    1616      * Set SITEMAPLIST = on 
    17       * Set SITEMAPWHAT = [[%WEB%.WelcomeGuest][Welcome]], [[%WEB%.UserRegistration][Registration]], and other %WEB%.StartingPoints; TWiki history &amp; Wiki style; All the docs... 
    18       * Set SITEMAPUSETO = ...discover TWiki details, and how to start your own site. 
     17      * Set SITEMAPWHAT = [[%WEB%.WelcomeGuest][Welcome]], [[%WEB%.UserRegistration][Registration]], and other %WEB%.StartingPoints; Foswiki history &amp; Wiki style; All the docs... 
     18      * Set SITEMAPUSETO = ...discover Foswiki details, and how to start your own site. 
    1919      * Hide Table of Contents if the topic is included 
    2020         * Set TOC_HIDE_IF_INCLUDED = on 
     
    2323      * The first header level to appear in the TOC: 
    2424         * Set TOC_MIN_DEPTH = 2 
    25       * Use auto linking for the TWiki documentation pages: 
     25      * Use auto linking for the Foswiki documentation pages: 
    2626         * Set NOAUTOLINK = 0 
    2727 
     
    3333 
    3434   * Copyright notice for the web. 
    35       * Set WEBCOPYRIGHT = <span class="twikiRight"> <a href="http://twiki.org/"><img src="%PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/badge.gif" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" border="0" /></a></span>%MAKETEXT{"Copyright &&copy; by the contributing authors. All material on this collaboration platform is the property of the contributing authors." args="1999-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME%%20Feedback%20on%20%BASEWEB%.%BASETOPIC%"}% %IF{"$ WEB= $ SYSTEMWEB" then=""}% 
     35      * Set WEBCOPYRIGHT = <span class="twikiRight"> <a href="http://foswiki.org/"><img src="%PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/badge.gif" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" border="0" /></a></span>%MAKETEXT{"Copyright &copy; by the contributing authors. All material on this site is the property of the contributing authors." args="1999-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME%%20Feedback%20on%20%BASEWEB%.%BASETOPIC%"}% %IF{"$ WEB= $ SYSTEMWEB" then=""}% 
    3636 
    3737   * Users or groups who __are not__ / __are__ allowed to __view__ / __change__ / __rename__ topics in the <nop>%WEB% web: (See %SYSTEMWEB%.AccessControl). 
  • trunk/core/data/System/WebRssBase.txt

    r482 r851  
    44---++ Find out What's New 
    55 
    6 There are several ways to find out what's new in each TWiki web: 
     6There are several ways to find out what's new in each web: 
    77   1. Visit WebChanges to see recent changes 
    88   1. Subscribed in WebNotify get notified of recent changes by e-mail 
    9    1. Use a news readers such as TWiki:Plugins/HeadlinesPlugin to display the recent changes 
     9   1. Use a news readers such as Foswiki:Extensions/HeadlinesPlugin to display the recent changes 
    1010      * The source can be a RSS 1.0 feed (WebRss) or ATOM 1.0 feed (WebAtom) 
    1111      * Learn more on RSS at TWiki:Codev/TWikiSyndication 
  • trunk/core/data/System/WebSiteTools.txt

    r482 r851  
    1414%STOPINCLUDE% 
    1515--- 
    16    * The list above provides the TWikiSiteTools used to navigate, search and maintain a particular web. It is included within other topics using the following directive: <p /> 
     16   * The list above provides the SiteTools used to navigate, search and maintain a particular web. It is included within other topics using the following directive: <p /> 
    1717     =%<nop>INCLUDE{"%<nop>SYSTEMWEB%.WebSiteTools"}%= 
    1818 
  • trunk/core/data/System/WebStatistics.txt

    r482 r851  
    88__Notes:__ 
    99   * Do not edit this topic, it is updated automatically. (You can also [[%SCRIPTURL{"statistics"}%/%WEB%][force]] an update) 
    10    * [[%SYSTEMWEB%.TWikiSiteTools#WebStatistics_site_statistics][TWikiSiteTools]] tells you how to enable the automatic updates of the statistics. 
     10   * [[%SYSTEMWEB%.SiteTools#WebStatistics_site_statistics][Site tools]] tells you how to enable the automatic updates of the statistics. 
    1111        * Suggestion: You could archive this topic once a year and delete the previous year's statistics from the table. 
    1212 
  • trunk/core/data/System/WelcomeGuest.txt

    r725 r851  
    22---+!! Welcome, %WIKIUSERNAME%! 
    33 
    4 Welcome to <nop>%WIKITOOLNAME%! This is a TWikiSite (pronounced _twee-kee site_), a meeting place to work on common interests. Anyone can contribute using any web browser. <nop>%WIKITOOLNAME% looks like a normal web site... except that it encourages contribution and *editing* of pages, questions, answers, comments and updates. 
     4Welcome to <nop>%WIKITOOLNAME%! This is a Foswiki, a dynamic website and public whiteboard. Anyone can contribute using any web browser. <nop>%WIKITOOLNAME% looks like a normal web site... except that it encourages contribution and *editing* of pages, questions, answers, comments and updates. 
    55 
    6 "Wiki" systems are fundamentally editable web pages.  It's a fun and useful way of communicating asynchronously over the web for many existing intranet and public Internet sites.  TWiki is simple to learn and use.  It aims to provide a transparent way for you to publish and exchange your ideas with others over the web. 
     6"Wiki" systems are fundamentally editable web pages.  It's a fun and useful way of communicating asynchronously over the web for many existing intranet and public Internet sites.  Foswiki is simple to learn and use.  It aims to provide a transparent way for you to publish and exchange your ideas with others over the web. 
    77 
    88%TOC% 
    99 
    10 ---++ What's in a TWiki? 
     10---++ What's in a Foswiki? 
    1111 
    1212   * See TopicsAndWebs for a concentrated introduction 
     
    1616 
    1717   * *Browse.* This is a site like other sites. Read and follow interesting links. 
    18    * *Write.* Speak your mind! From your browser you can change or add to anything you see in a TWiki topic. Use regular text or ShortHand. 
     18   * *Write.* Speak your mind! From your browser you can change or add to anything you see in a Foswiki topic. Use regular text or ShortHand. 
    1919   * *Experiment.*  Edit your personal page or visit the Sandbox.%HOMETOPIC% web. 
    2020   * *Organize.* You can learn to use DataForms and [[FormattedSearch]]es to include topic information - for example, classify pages by subject, status, or date. 
  • trunk/core/data/System/WhatIsWikiWiki.txt

    r569 r851  
    99A set of pages of information that are open and free for anyone to edit as they wish. They are stored in a server and managed using some software. The system creates cross-reference hyperlinks between pages automatically. 
    1010 
    11 __Related topics:__ TWikiSite, WelcomeGuest, GoodStyle, WikiSyntax, FrequentlyAskedQuestions, WikiCulture, WabiSabi 
     11__Related topics:__ WelcomeGuest, GoodStyle, WikiSyntax, FrequentlyAskedQuestions, WikiCulture, WabiSabi 
    1212 
    1313__Back to:__ FrequentlyAskedQuestions 
  • trunk/core/data/System/WikiCulture.txt

    r611 r851  
    77---++ Answer: 
    88 
    9 TWiki is one of many WikiWikiClones, the first one was built by Ward Cunningham. Collaborating the Wiki way is different from other collaboration tools like Usenet. A distinct __Wiki culture__ forms around these tools: 
     9Foswiki is one of many WikiWikiClones, the first one was built by Ward Cunningham. Collaborating the Wiki way is different from other collaboration tools like Usenet. A distinct __Wiki culture__ forms around these tools: 
    1010 
    1111   * Any and all information can be deleted by anyone. Wiki pages represent nothing but discussion and consensus because it's much easier to delete flames, spam and trivia than to indulge them. What remains is naturally meaningful.  
     
    1919(quoted from _WhyWikiWorks_ at Ward's original Wiki system, the Portland Pattern Repository, Wiki:WhyWikiWorks) 
    2020 
    21 __Related topics:__ TWikiSite, WelcomeGuest, GoodStyle, WikiSyntax, FrequentlyAskedQuestions, WhatIsWikiWiki, WabiSabi, AccessControl 
     21__Related topics:__ WelcomeGuest, GoodStyle, WikiSyntax, FrequentlyAskedQuestions, WhatIsWikiWiki, WabiSabi, AccessControl 
    2222 
    2323__Back to:__ FrequentlyAskedQuestions 
  • trunk/core/data/System/WikiReferences.txt

    r482 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1186906075" format="1.1" version="$Rev: 13018 $"}% 
    2 %META:TOPICPARENT{name="TWikiSite"}% 
     2%META:TOPICPARENT{name="SiteMap"}% 
    33---+!! References on Wiki and Collaboration 
    44 
     
    77%TOC% 
    88 
    9 ---++ Wiki Technology and TWiki 
    10  
    11    * Book: Wikis for Dummies; by Dan Woods and Peter Thoeny; Whiley; ISBN:9780470043998 
     9---++ Wiki Technology 
    1210 
    1311   * Book: The Wiki Way, Quick Collaboration on the Web; by Bo Leuf and Ward Cunningham; Addison-Wesley Pub Co; ISBN:020171499X 
     
    1513   * Book: Wiki: Web Collaboration; by Anja Ebersbach, Markus Glaser, Richard Heigl; Springer; ISBN:3540259953. The book is about TWiki and <nop>MediaWiki; [[http://www.springerlink.com/content/978-3-540-29267-8/][Free eBook]] is available; German version is "[[http://www.wiki-tools.de/][WikiTools: Kooperation im Web]]". 
    1614 
    17    * Presentation: Wiki Collaboration and Wiki Applications for the Enterprise; by Peter Thoeny; !LinuxWorld; 11 Aug 2005; http://TWiki.org/cgi-bin/view/Codev/TWikiPresentation11Aug2005 
    18  
    19    * Article: Team Builder - the TWiki wiki and the enterprise; by Peter Thoeny; Linux-Magazine UK; 05 May 2005; http://www.linux-magazine.com/issue/55 
    20  
    21    * Article: 'Wiki' May Alter How Employees Work Together; by Kara Swisher; Wall Street Journal; 29 Jul 2004; http://online.wsj.com/article/0,,SB109105974578777189,00.html (subscription required) 
    22  
    23    * Article: Something Wiki This Way Comes: They're Web sites anyone can edit -- and they could transform Corporate America; by Rob Hof; !BusinessWeek; 07 Jun 2004; http://www.businessweek.com/magazine/content/04_23/b3886138.htm 
    24  
    25    * Article: Wiki Time; by Jeremy Zawodny; Linux Magazine; 01 Dec 2002 - http://www.linux-mag.com/2002-12/lamp_01.html 
    26  
    27    * Article: Corporate Collaboration With TWiki; by Peter Thoeny; Web Techniques Magazine; December 2000; http://www.webtechniques.com/archives/2000/12/thoeny/ 
    28  
    29    * Article: Mr. TWiki's Collaboration Software; by Nancy Cohen; Open Magazine; 01 Aug 2002; http://www.open-mag.com/features/Vol_36/twiki/twiki.htm 
    30  
    31    * Article: Tool of the Month: TWiki; by Joe "Zonker" Brockmeier; <nop>UnixReview.com; January 2002; http://www.unixreview.com/documents/s=1820/uni1011715271489/0201j.htm 
    32  
    33    * Directory: Google.com &gt; Computers &gt; Software &gt; Groupware &gt; Wiki; http://directory.google.com/Top/Computers/Software/Groupware/Wiki/ 
    34  
    35    * See also TWiki:Codev.TWikiInTheNews and TWiki:Codev.WikiInTheNews 
     15   * Book: Wikis for Dummies; by Dan Woods and Peter Thoeny; Whiley; ISBN:9780470043998 
    3616 
    3717---++ Collaboration and Knowledge Management 
  • trunk/core/data/System/WikiSyntax.txt

    r693 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 13239 $"}% 
    2 ---+ TWiki Shorthand Basics 
     2---+ Shorthand Basics 
    33 
    4 If you can enter text, you're ready for TWiki. With a few simple, intuitive TextFormattingRules, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics... 
     4If you can enter text, you're ready to use Foswiki. With a few simple, intuitive TextFormattingRules, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics... 
    55 
    66%STARTINCLUDE% 
     
    1818   * If you enter a WikiWord for a topic that doesn't exist, it'll appear highlighted, with question mark at the end, prompting you (or someone else) to start off the new topic by clicking the *?* - NewTopic (click the *?*, but don't save, to preserve the example!). 
    1919    
    20    * When entering <nop>WikiName signatures - like, <nop>%USERNAME% - include "%USERSWEB%." as a prefix, since all TWiki member pages are in the %USERSWEB% web: =%USERSWEB%.YourName=. 
     20   * When entering <nop>WikiName signatures - like, <nop>%USERNAME% - include "%USERSWEB%." as a prefix, since all Foswiki member pages are in the %USERSWEB% web: =%USERSWEB%.YourName=. 
    2121 
    22    * For an external link, type the full URL: =http://twiki.org/=. 
     22   * For an external link, type the full URL: =http://foswiki.org/=. 
    2323 
    2424   * To prevent a <nop>WikiWord from becoming a link, type =&lt;nop&gt;= or an exclamation point first: ==&lt;nop&gt;NoLinkPlease== or ==!NoLinkPlease==. 
     
    4646     __%X% NOTE:__ preferences can still be set within verbatim tags, that is, they are not disabled. This is a historical peculiarity. 
    4747 
    48    * Use ==&lt;literal&gt;== to enclose anything that TWiki must not touch under any circumstances, such as in-line HTML code. 
     48   * Use ==&lt;literal&gt;== to enclose anything that Foswiki must not touch under any circumstances, such as in-line HTML code. 
    4949 
    5050   * Follow GoodStyle recommendations when editing topics. 
  • trunk/core/data/System/WikiSyntaxSummary.txt

    r482 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 14151 $"}% 
    2 This page provides online help for new users of TWiki when editing a page.  If there's some formatting that your contributors use often, you can customize this for your site's particular needs. 
     2This page provides online help for new users of Foswiki when editing a page.  If there's some formatting that your contributors use often, you can customize this for your site's particular needs. 
    33 
    44Keeping this help text short and simple is important since this page is aimed at new users.  It does include pop-up links for more detailed help. 
  • trunk/core/data/System/WikiWikiClones.txt

    r482 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 5385 $"}% 
    2 TWiki is a Wiki Wiki clone and has its root in JOS Wiki. 
     2Foswiki is a Wiki Wiki clone and has its root in JOS Wiki via TWiki&reg;. 
    33 
    4    * TWiki's home is at http://TWiki.org/ 
    5    * TWiki takes a lot of ideas from [[http://c2.com/~ward/][Ward Cunningham]]'s remarkable [[http://c2.com/cgi/wiki?WikiWikiWeb][Wiki Wiki Web]] invention 
     4   * Foswiki's home is at http://foswiki.org/ 
     5   * Foswiki takes a lot of ideas from [[http://c2.com/~ward/][Ward Cunningham]]'s remarkable [[http://c2.com/cgi/wiki?WikiWikiWeb][Wiki Wiki Web]] invention 
    66   * A list of Wiki Wiki clones can be found at http://c2.com/cgi/wiki?WikiWikiClones 
    77 
     8TWiki&reg; is a trademark of Peter Thoeny. 
  • trunk/core/data/System/WikiWord.txt

    r700 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1184734707" format="1.1" version="1.2"}% 
    22---+!! What is a !WikiWord? 
    3 A !WikiWord consists of two or more words with initial capitals, run together. *WikiWords are topic names.* A TWiki topic name always has a fixed format: two or more words with initial capitals, run together. Like the name of the current topic: *WikiWord*. When you type the name of a topic, you create a link to that topic. You type =%HOMETOPIC%= and on saving the page this becomes %HOMETOPIC%. It's as easy as that. 
     3A !WikiWord consists of two or more words with initial capitals, run together. *WikiWords are topic names.* A Foswiki topic name always has a fixed format: two or more words with initial capitals, run together. Like the name of the current topic: *WikiWord*. When you type the name of a topic, you create a link to that topic. You type =%HOMETOPIC%= and on saving the page this becomes %HOMETOPIC%. It's as easy as that. 
    44 
    55When you type a !WikiWord, you establish a hyperlink. It's as easy as that. 
     
    5454 
    5555   * Web: Name without the uppercase letter(s), lowercase letter(s), uppercase letter(s) sequence 
    56    * 5TWiki: Name beginning with a number 
     56   * 5Alive: Name beginning with a number 
    5757   * Know-How: Name with dashes in between 
    5858 
     
    6565   * To link to a topic in *another subweb* write: =Sandbox.Subweb.WebSearch=. 
    6666   * To show the web name in the link use bracket notation: =[<nop>[Sandbox.%HOMETOPIC%]]= - this becomes: [[Sandbox.%HOMETOPIC%]] 
    67    * To link to a topic on *another Wiki site*, use: =TWiki:Main/WebHome= - this becomes: TWiki:Main/WebHome (sites are defined in the InterwikiPlugin) 
     67   * To link to a topic on *another Wiki site*, use: =Foswiki:Main/WebHome= - this becomes: Foswiki:Main/WebHome (sites are defined in the InterwikiPlugin) 
    6868   * To link to a part on the *same page*, write a "#" followed by the name of an anchor. The anchor is a "#" followed by a name which must be a !WikiName. Example =#MyAnchor=. You can also link to an anchor on another page: =%SYSTEMWEB%.%HOMETOPIC%#MyAnchor=. 
    6969   * To link to a header on the *same page*, write a "#" followed by the header text, with spaces replaced by underscores (and =!= removed): =[<nop>[#Good_examples_of_WikiWords]]= becomes: [[#Good_examples_of_WikiWords]]. You can also link to a header on another page: =%SYSTEMWEB%.%HOMETOPIC%#Disclaimer= becomes: %SYSTEMWEB%.%HOMETOPIC%#Disclaimer. 
     
    8080   * It is possible to turn off the auto-linking of !WikiWords and to rely only on the bracket notation using the NOAUTOLINK [[%SYSTEMWEB%.PreferenceSettings][preference setting]]. 
    8181   * %X% When linking to a <nop>%HOMETOPIC% topic _in another web_, the link will be rendered as the name of the web, e.g. =Sandbox.%HOMETOPIC%= becomes Sandbox.%HOMETOPIC%. 
    82    * %X% Dots (.) are used as seperators between webs, subwebs, and topics. It is not possible to use dots in topic names. TWiki does not attempt to guess if a dot could be part of a topic name. 
     82   * %X% Dots (.) are used as seperators between webs, subwebs, and topics. It is not possible to use dots in topic names. Foswiki does not attempt to guess if a dot could be part of a topic name. 
    8383 
    8484__Related Topics:__ WikiSyntax, TextFormattingRules 
  • trunk/core/data/TestCases/TestCaseInternetRegistration.txt

    r733 r851  
    2121---+++ step 2:  
    2222        1 Your email arrives   
    23         2 Click on the link in the email - it takes you to twiki/bin/register?action=verify&code=TestuserToo.XXXX where XXXX is a randomPassword 
     23        2 Click on the link in the email - it takes you to bin/register?action=verify&code=TestuserToo.XXXX where XXXX is a randomPassword 
    2424 
    2525If you get the right activation code you are taken to oopsregthanks 
  • trunk/core/data/Trash/WebRss.txt

    r786 r851  
    33%IF{ "$'URLPARAM{search}'!=''" then="<title><nop>%WIKITOOLNAME% search results for <nop>%URLPARAM{search}%</title>" else="<title><nop>%WIKITOOLNAME%'s <nop>%WEB% web</title>"}% 
    44  <link>%SCRIPTURL{"view"}%/%WEB%</link> 
    5   <description>%MAKETEXT{"The [_1] web of TWiki. Foswiki is the Free Open Source Wiki." args="<nop>%WEB%"}%</description> 
     5  <description>%MAKETEXT{"The [_1] web of Foswiki, the Free Open Source Wiki." args="<nop>%WEB%"}%</description> 
    66%INCLUDE{"%SYSTEMWEB%.WebRssBase"}%<!-- 
    77   * Set SKIN = rss 
  • trunk/core/data/Trash/WebStatistics.txt

    r482 r851  
    88__Notes:__ 
    99   * Do not edit this topic, it is updated automatically. (You can also [[%SCRIPTURL{"statistics"}%/%WEB%][force]] an update) 
    10    * [[%SYSTEMWEB%.TWikiSiteTools#WebStatistics_site_statistics][TWikiSiteTools]] tells you how to enable the automatic updates of the statistics. 
     10   * [[%SYSTEMWEB%.SiteTools#WebStatistics_site_statistics][Site tools]] tells you how to enable the automatic updates of the statistics. 
    1111        * Suggestion: You could archive this topic once a year and delete the previous year's statistics from the table. 
    1212 
  • trunk/core/data/_default/WebAtom.txt

    r482 r851  
    11%META:TOPICINFO{author="ProjectContributor" date="1138082878" format="1.0" version="$Rev: 8264 $"}% 
    22<title>%WIKITOOLNAME%'s <nop>%WEB% web</title> 
    3 <subtitle>%MAKETEXT{"The [_1] web of TWiki. TWiki is a Web-Based Collaboration Platform for the Enterprise." args="<nop>%WEB%"}%</subtitle> 
     3<subtitle>%MAKETEXT{"The [_1] web of Foswiki, the Free open Source Wiki." args="<nop>%WEB%"}%</subtitle> 
    44%INCLUDE{"%SYSTEMWEB%.WebAtomBase"}% <!-- 
    55   * Set SKIN = rssatom 
  • trunk/core/data/_default/WebRss.txt

    r482 r851  
    33%IF{ "$'URLPARAM{search}'!=''" then="<title><nop>%WIKITOOLNAME% search results for <nop>%URLPARAM{search}%</title>" else="<title><nop>%WIKITOOLNAME%'s <nop>%WEB% web</title>"}% 
    44  <link>%SCRIPTURL{"view"}%/%WEB%</link> 
    5   <description>%MAKETEXT{"The [_1] web of TWiki. TWiki is a Web-Based Collaboration Platform for the Enterprise." args="<nop>%WEB%"}%</description> 
     5  <description>%MAKETEXT{"The [_1] web of Foswiki, the Free Open Source Wiki." args="<nop>%WEB%"}%</description> 
    66%INCLUDE{"%SYSTEMWEB%.WebRssBase"}%<!-- 
    77   * Set SKIN = rss 
  • trunk/core/data/_default/WebStatistics.txt

    r482 r851  
    88__Notes:__ 
    99   * Do not edit this topic, it is updated automatically. (You can also [[%SCRIPTURL{"statistics"}%/%WEB%][force]] an update) 
    10    * [[%SYSTEMWEB%.TWikiSiteTools#WebStatistics_site_statistics][TWikiSiteTools]] tells you how to enable the automatic updates of the statistics. 
     10   * [[%SYSTEMWEB%.SiteTools#WebStatistics_site_statistics][Site tools]] tells you how to enable the automatic updates of the statistics. 
    1111        * Suggestion: You could archive this topic once a year and delete the previous year's statistics from the table. 
    1212 
Note: See TracChangeset for help on using the changeset viewer.