From 912bc6e382bfe280e6b29167e59366c718301584 Mon Sep 17 00:00:00 2001 From: PeterThoeny Date: Sun, 15 Aug 2004 10:03:45 +0000 Subject: [PATCH] none --- TWiki/TWikiContributor.mdwn | 15 +++ TWiki/TWikiDownload.mdwn | 4 +- TWiki/TWikiEnhancementRequests.mdwn | 2 +- TWiki/TWikiFAQ.mdwn | 2 +- TWiki/TWikiForms.mdwn | 222 ++++++++++++++++++++++++++++++++---- TWiki/TWikiGlossary.mdwn | 2 +- TWiki/TWikiMetaData.mdwn | 16 +-- TWiki/TWikiPlannedFeatures.mdwn | 2 +- TWiki/TWikiSystemRequirements.mdwn | 6 +- 9 files changed, 233 insertions(+), 38 deletions(-) diff --git a/TWiki/TWikiContributor.mdwn b/TWiki/TWikiContributor.mdwn index 33a08b5..98675d7 100644 --- a/TWiki/TWikiContributor.mdwn +++ b/TWiki/TWikiContributor.mdwn @@ -46,6 +46,11 @@ I would like to take this opportunity to express my sincere appreciation and tha TWiki:Codev/CoreTeam member + Carl Patten + TWiki:Main/CarlPatten +   + + Caylan Larson TWiki:Main/CaylanLarson   @@ -156,6 +161,11 @@ I would like to take this opportunity to express my sincere appreciation and tha TWiki:Codev/CoreTeamHallOfFame member + Neil McCurdy + TWiki:Main/NeilMcCurdy +   + + Nicholas Lee TWiki:Main/NicholasLee TWiki:Codev/CoreTeam member @@ -231,6 +241,11 @@ I would like to take this opportunity to express my sincere appreciation and tha   + Thomas Weigert + TWiki:Main/ThomasWeigert +   + + Vito Miliano TWiki:Main/VitoMiliano   diff --git a/TWiki/TWikiDownload.mdwn b/TWiki/TWikiDownload.mdwn index 117479d..50a966e 100644 --- a/TWiki/TWikiDownload.mdwn +++ b/TWiki/TWikiDownload.mdwn @@ -4,8 +4,8 @@ I would like to install TWiki on my server. Can I get the source? ## Answer: -TWiki is distributed under the [[GnuGeneralPublicLicense]]. You can request the source from . +TWiki is distributed under the [[GnuGeneralPublicLicense]]. You can get the source from . **_Back to:_** [[TWikiFAQ]] --- [[PeterThoeny]] - 27 Nov 2000
+-- TWiki:Main.PeterThoeny - 15 Aug 2004 diff --git a/TWiki/TWikiEnhancementRequests.mdwn b/TWiki/TWikiEnhancementRequests.mdwn index 6a13d01..b7c36ac 100644 --- a/TWiki/TWikiEnhancementRequests.mdwn +++ b/TWiki/TWikiEnhancementRequests.mdwn @@ -6,4 +6,4 @@ - [[TWikiPlannedFeatures]] has a list of planned features. - [[TWikiDocumentation]] is the implementation documentation. --- [[PeterThoeny]] - 23 Jan 2003 +-- TWiki:Main.PeterThoeny - 23 Jan 2003 diff --git a/TWiki/TWikiFAQ.mdwn b/TWiki/TWikiFAQ.mdwn index a5eda46..6a78db3 100644 --- a/TWiki/TWikiFAQ.mdwn +++ b/TWiki/TWikiFAQ.mdwn @@ -26,4 +26,4 @@ Other places where you can find answers to your questions: - [[TextFormattingFAQ]]: Answers to frequently asked questions about text styling in TWiki - If you can't find an answer, ask a question - post it in the TWiki:Support web --- [[PeterThoeny]] - 26 Nov 2000
-- [[MikeMannix]] - 13 Sep 2001
+-- TWiki:Main.PeterThoeny - 26 Nov 2000 %BR% -- TWiki:Main.MikeMannix - 13 Sep 2001 diff --git a/TWiki/TWikiForms.mdwn b/TWiki/TWikiForms.mdwn index 8e3db39..89fe3ee 100644 --- a/TWiki/TWikiForms.mdwn +++ b/TWiki/TWikiForms.mdwn @@ -17,6 +17,7 @@
  • Importing Category Table Data
  • +
  • Using Forms For Settings
  • @@ -106,12 +107,21 @@ A Form Template is simply a page containing your form, defined as a table where > > **WebForm** > -> | *Name* | *Type* | *Size* | *Values* | *Tooltip message* | -> | Know.TopicClassification | select | 1 | Know.NoDisclosure, -> Know.PublicSupported, Know.PublicFAQ | blah blah... | -> | Know.OperatingSystem | checkbox | 3 | Know.OsHPUX, Know.OsLinux, -> Know.OsSolaris, Know.OsWin | blah blah... | -> | Know.OsVersion | text | 16 | | blah blah... | +> %BR% +> +> `| *Name* | *Type* | *Size* | *Values* | *Tooltip message* |` +> +> %BR% +> +> `| TopicClassification | select | 1 | NoDisclosure, PublicSupported, PublicFAQ | blah blah... |` +> +> %BR% +> +> `| OperatingSystem | checkbox | 3 | OsHPUX, OsLinux, OsSolaris, OsWin | blah blah... |` +> +> %BR% +> +> `| OsVersion | text | 16 | | blah blah... |` > > > @@ -122,21 +132,21 @@ A Form Template is simply a page containing your form, defined as a table where > > > -> +> > > -> +> > > > -> +> > > -> +> > > > -> +> > > > @@ -153,7 +163,7 @@ Forms can also be defined by using form templates that retrieve field values fro > **Example: WebFormTemplate** > -> - Know.WebFormTemplate main definition:
     
    Tooltip message
    [[Know/TopicClassification]]TopicClassification select 1 [[Know/NoDisclosure]], [[Know/PublicSupported]], [[Know/PublicFAQ]]NoDisclosure, PublicSupported, PublicFAQ blah blah...
    [[Know/OperatingSystem]]OperatingSystem checkbox 3 [[Know/OsHPUX]], [[Know/OsLinux]], [[Know/OsSolaris]], [[Know/OsWin]]OsHPUX, OsLinux, OsSolaris, OsWin blah blah...
    [[Know/OsVersion]]OsVersion text 16  
    +> - WebFormTemplate main definition:
     
    > > > @@ -162,21 +172,21 @@ Forms can also be defined by using form templates that retrieve field values fro > > > -> +> > > > > > > -> +> > > > > > > -> +> > > > @@ -185,24 +195,24 @@ Forms can also be defined by using form templates that retrieve field values fro >
    Name Type Tooltip message
    [[Know/TopicClassification]] TopicClassification select 1   blah blah...
    [[Know/OperatingSystem]] OperatingSystem checkbox 3   blah blah...
    [[Know/OsVersion]] OsVersion text 16  
    >
    %X% Leave the **Values** field **blank**. > -> - Know.TopicClassification field value definition:
      +> - TopicClassification field value definition:
     
    > > > > > > -> +> > > > > -> +> > > > > -> +> > > > @@ -231,7 +241,7 @@ Forms are enabled on a per web basis. The **WEBFORMS** variable in - Additionally a new topic can be given a Form using the `formtemplate` parameter in the URL. Initial values can then be provided in the URLs or as form values: - other than checkboxes: **name**, ex: **?BugPriority=1** - - checkbox: **namevalue=1**, ex: **?ColourRed=1**.
    Boxes with a tick must be specified. + - checkbox: **namevalue=1**, ex: **?ColorRed=1**.
    Boxes with a tick must be specified. ## Setting Up Multiple Form Options @@ -288,4 +298,174 @@ The new Form Template system should work with old Category Table data with no sp %T% **NOTE:** If things aren't working correctly, there may be useful entries in `data/warning.txt`. --- TWiki:Main.JohnTalintyre - 16 Aug 2001 %BR% -- TWiki:Main.MikeMannix - 05 Jan 2002 %BR% -- TWiki:Main.PeterThoeny - 25 Apr 2004 +## Using Forms For Settings + +Example process to change your [[WebPreferences]] to use forms instead of `{3 spaces}* Set` statements: + +1. create WebPrefencesForm topic +2. fill it with a table like this: %BR% `| *Name*|*Type*|*Size*|*Value*|*Tooltip message*|*Attributes*|` %BR% `| WEBTOPICLIST |textarea| |     | List of topics of the %WEB% web |S|` %BR% `| SITEMAPLIST  |select  |3| on, | list this web in the Site Map  |S|` %BR% `| SITEMAPWHAT  |textarea| |     | short web summary             |S|` %BR% `| WEBBGCOLOR   |text    |8|     | Web specific background color |S|` %BR% etc... +3. Edit [[WebPreferences]] and: + - Add or Change the form to WebPrefencesForm + - add WebPrefencesForm to the `Set WEBFORMS` line + - Save +4. Edit [[WebPreferences]], jump straight down to the form ignoring all the `textarea` stuff, and set as you like +5. if everything works as you like it, you can delete the Set statements (the form overrides set if they are both used). + +**_Notes:_** + +If it isn't working, double check that the **S** attribute has been specified (S for Setting). If you change the form, the changes will not take affect until you edit and save the preferences' topics again. + +Using the TWiki:Plugins.EditTablePlugin on WebPreferencesForm makes adding new prefedrences a breeze. + +A possibly unwanted side effect for using forms for the SKINS setting in their personal user topic: because the User Preferences are final you can't have different skins for different webs as the user's setting always wins. A workaround is to simply omit SKIN in the form. + +Another example, this one using EditTablePlugin, source: + +`%EDITTABLE{ header="|*Name*|*Type*|*Size*|*Values*|*Tooltip message*|*Attributes*|" format="|text,20|text,20|text,20|text,20|text,20|text,1|" }%` + +Result (after some editing): + + + +
    +
    Name Type Tooltip message
    [[Know/NoDisclosure]] NoDisclosure option blah blah...
    [[Know/PublicSupported]] PublicSupported option blah blah...
    [[Know/PublicFAQ]] PublicFAQ option blah blah...
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Name Type Size Values tooltip message Attributes
    ALLOWTOPICCHANGE textarea     Users or groups allowed to change or rename this %TOPIC% topic: (I.e. [[Main/TWikiAdminGroup]]) S
    ALLOWWEBCHANGE textarea     Users or groups who are allowed to change topics in the %WEB% web: (See [[TWiki/TWikiAccessControl]]) S
    ALLOWWEBRENAME textarea   [[Main/TWikiAdminGroup]] Users or groups who are allowed to rename topics in the %WEB% web: (See [[TWiki/TWikiAccessControl]]) S
    ALLOWWEBVIEW textarea     Users or groups who are allowed to view topics in the %WEB% web: (See [[TWiki/TWikiAccessControl]]) S
    DENYWEBCHANGE textarea     Users or groups who are not allowed to change topics in the %WEB% web: (See [[TWiki/TWikiAccessControl]]) S
    DENYWEBRENAME textarea     Users or groups who are not allowed to rename topics in the %WEB% web: (See [[TWiki/TWikiAccessControl]]) S
    DENYWEBVIEW textarea     Users or groups who are not allowed to view topics in the %WEB% web: (See [[TWiki/TWikiAccessControl]]) S
    FINALPREFERENCES textarea   "NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME" Web preferences that are not allowed to be overridden by user preferences S
    NOSEARCHALL text   ",on" "Exclude web from a web=""all"" search: (Set to on for hidden webs)" S
    SITEMAPLIST select   "on, ," List this web in the [[TWiki/SiteMap]] S
    SITEMAPUSETO textarea   ...to do something. ...to do something. S
    SITEMAPWHAT textarea   Describe what this web does. Describe what this web does.  
    SKIN select   "twiki, free, gnu, koala, pattern, plain, tiger" list of installed skins S
    WEBBGCOLOR select   lightpink, pink, crimson, lavenderblush, palevioletred, hotpink, deeppink, mediumvioletred, orchid, thistle, plum, violet, fuchsia, fuchsia, darkmagenta, purple, mediumorchid, darkviolet, darkorchid, indigo, blueviolet, mediumpurple, mediumslateblue, slateblue, darkslateblue, ghostwhite, lavender, blue, mediumblue, darkblue, navy, midnightblue, royalblue, cornflowerblue, lightsteelblue, lightslategray, slategray, dodgerblue, aliceblue, steelblue, lightskyblue, skyblue, deepskyblue, lightblue, powderblue, cadetblue, darkturquoise, azure, lightcyan, paleturquoise, aqua, aqua, darkcyan, teal, darkslategray, mediumturquoise, lightseagreen, turquoise, aquamarine, mediumaquamarine, mediumspringgreen, mintcream, springgreen, mediumseagreen, seagreen, honeydew, darkseagreen, palegreen, lightgreen, limegreen, lime, forestgreen, green, darkgreen, lawngreen, chartreuse, greenyellow, darkolivegreen, yellowgreen, olivedrab, ivory, beige, lightyellow, lightgoldenrodyellow, yellow, olive, darkkhaki, palegoldenrod, lemonchiffon, khaki, gold, cornsilk, goldenrod, darkgoldenrod, floralwhite, oldlace, wheat, orange, moccasin, papayawhip, blanchedalmond, navajowhite, antiquewhite, tan, burlywood, darkorange, bisque, linen, peru, peachpuff, sandybrown, chocolate, saddlebrown, seashell, sienna, lightsalmon, coral, orangered, darksalmon, tomato, salmon, mistyrose, lightcoral, snow, rosybrown, indianred, red, brown, firebrick, darkred, maroon, white, whitesmoke, gainsboro, lightgrey, silver, darkgray, gray, dimgray, black Web specific background color: (Pick a lighter one of the [[TWiki/StandardColors]]) S
    WEBFORMS textarea     [[TWiki/TWikiForms]]: How to enable form(s) S
    WEBTOPICLIST textarea   [[Main/WebHome]], [[Main/WebChanges]], [[Main/WebTopicList]], [[Main/WebIndex]], [[Main/WebSearch]], Go the main entry point topics for this web S
    + + +-- TWiki:Main.JohnTalintyre - 16 Aug 2001 %BR% -- TWiki:Main.MikeMannix - 05 Jan 2002 %BR% -- TWiki:Main.PeterThoeny - 25 Apr 2004 %BR% -- TWiki:Main.MattWilkie - 27 Jul 2004 %BR% diff --git a/TWiki/TWikiGlossary.mdwn b/TWiki/TWikiGlossary.mdwn index 1bfab05..a4fd81e 100644 --- a/TWiki/TWikiGlossary.mdwn +++ b/TWiki/TWikiGlossary.mdwn @@ -71,4 +71,4 @@ _Simple glossary of TWiki terms_ --- [[MikeMannix]] - 27 Aug 2001 %BR% -- [[PeterThoeny]] - 27 Jan 2003 +-- TWiki:Main.MikeMannix - 27 Aug 2001 %BR% -- TWiki:Main.PeterThoeny - 27 Jan 2003 diff --git a/TWiki/TWikiMetaData.mdwn b/TWiki/TWikiMetaData.mdwn index c3d88b0..2bf8131 100644 --- a/TWiki/TWikiMetaData.mdwn +++ b/TWiki/TWikiMetaData.mdwn @@ -242,13 +242,13 @@ There is no absolute need for Meta Data variables to be listed in a specific ord The recommended sequence is: -- META:TOPICINFO -- `text of topic` -- META:TOPICMOVED (optional) -- META:TOPICPARENT (optional) -- META:FILEATTACHMENT (0 or more entries) -- META:FORM (optional) -- META:FIELD (0 or more entries; FORM required) +- `META:TOPICINFO` +- `META:TOPICPARENT` (optional) +- text of topic +- `META:TOPICMOVED` (optional) +- `META:FILEATTACHMENT` (0 or more entries) +- `META:FORM` (optional) +- `META:FIELD` (0 or more entries; FORM required) ## Viewing Meta Data in Page Source @@ -295,4 +295,4 @@ Current support covers: At present, there is no Meta Data support for Plugins. However, the format is readily extendable and the `Meta.pm` code that supports the format needs only minor alteration. --- TWiki:Main.JohnTalintyre - 29 Aug 2001
    -- TWiki:Main.MikeMannix - 03 Dec 2001
    -- TWiki:Main.PeterThoeny - 10 Jan 2002 +-- TWiki:Main.JohnTalintyre - 29 Aug 2001 %BR% -- TWiki:Main.MikeMannix - 03 Dec 2001 %BR% -- TWiki:Main.PeterThoeny - 15 Aug 2004 diff --git a/TWiki/TWikiPlannedFeatures.mdwn b/TWiki/TWikiPlannedFeatures.mdwn index 4d8b57c..1bc89b5 100644 --- a/TWiki/TWikiPlannedFeatures.mdwn +++ b/TWiki/TWikiPlannedFeatures.mdwn @@ -6,4 +6,4 @@ - [[TWikiDocumentation]] is the implementation documentation. - [[TWikiEnhancementRequests]] is the place where you can add your enhancement requests. --- [[PeterThoeny]] - 17 Jan 2003 +-- TWiki:Main.PeterThoeny - 17 Jan 2003 diff --git a/TWiki/TWikiSystemRequirements.mdwn b/TWiki/TWikiSystemRequirements.mdwn index 9b4e4d4..041a94c 100644 --- a/TWiki/TWikiSystemRequirements.mdwn +++ b/TWiki/TWikiSystemRequirements.mdwn @@ -26,11 +26,11 @@ TWiki is written in Perl 5, uses a number of shell commands, and requires [RCS ( Perl - 5.005_03 or higher (5.6.1 recommended, 5.8.0 not recommended yet, see TWiki:Codev.IssuesWithPerl5dot8) + 5.005_03 or higher (5.6.1 recommended, 5.8.x does work in most cases, but see TWiki:Codev.IssuesWithPerl5dot8) Non-standard Perl modules - %BULLET% Unix: Net::SMTP (or sendmail) %BB% Windows: Net::SMTP, MIME::Base64, Digest::SHA1 + %BULLET% Unix: Net::SMTP (or sendmail) %BB% Windows: Net::SMTP, MIME::Base64, Digest::SHA1 %BB% Internationalisation: Unicode::MapUTF8   (only for non-ISO-8859-1 sites using TWiki:Codev.EncodeURLsWithUTF8 with Perl 5.6 or lower) RCS @@ -75,4 +75,4 @@ You can easily add functionality, by customizing [[TWikiTemplates]], for one, wh - The [[TWikiPlugins]] feature currently does not have compatibility guidelines for developers. Plugins can require just about anything - browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs. - %H% Plugins included in the TWiki distribution do not add requirements. --- TWiki:Main.MikeMannix - 12 Jan 2002 %BR% -- TWiki:Main.PeterThoeny - 16 Dec 2003 +-- TWiki:Main.MikeMannix - 12 Jan 2002 %BR% -- TWiki:Main.PeterThoeny - 15 Aug 2004 -- 1.9.4