|
|
r1.6 > r1.5 > r1.4 |
|
MyCo.MyTopic |
Webs: Myco | Main | TWiki | Sandbox |
|
Changes | Index | Search | Go |
MyCo.MyTopic |
Webs: Myco | Main | TWiki | Sandbox |
|
Changes | Index | Search | Go |
Edit | Attach | Diffs | r1.2 > r1.1 | More | |
Revision r1.2 - 13 Feb 2004 - 09:09 GMT - TWikiPresenter |
Copyright © 1999-2020 by the contributing authors.
All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback |
the world
is an OblateSpheroid_Everyone_ *knows* that =the world= is an OblateSpheroid
Actually it is perfectly and absolutely flat
_Actually_ it is *perfectly* and __absolutely__ flat
You type | You see |
---|---|
---+ This is a heading | This is a heading |
---++ And so is this | And so is this |
like this
You type | You see |
---|---|
* Bullet * Sub-bullet |
|
1
| Cat | Feline | | Bear | Ursine | | Wolf | Vulpine |
Cat | Feline |
Bear | Ursine |
Wolf | Vulpine |
[[BumpyWords][bumpy words]] appears as bumpy words
[[http://www..google.com][google]]
appears as google
<nop>
<nop>_word_
appears as _word_
Attachment | Action | Size | Date | Who | Comment |
---|---|---|---|---|---|
myco.gif | manage | 9.6 K | 13 Feb 2004 - 18:41 | MushroomMagicMan | Attached image file |
%ATTACHURL%/myco.gif
to see this: /pub/TWiki/ATasteOfTWiki/myco.gif
%SEARCH{"CategoryWeather" nosearch="on" nosummary="on"}%
%ACTION...
%CALENDAR...%
%COMMENT...
%CHART...
%EDITTABLE...
%RENDERLIST...
%SLIDESHOWSTART...
%CALC...
%TABLE...
%DRAWING...
%SLIDETITLE% | |
%SLIDETEXT% |
|
%SLIDENAVFIRST% %SLIDENAVPREV%
Slide %SLIDENUM% of %SLIDEMAX%
%SLIDENAVNEXT% %SLIDENAVLAST% Copyright © 2020 by the contributing authors |
configure
, make
, etc. This is often not necessary on Linux or Windows.
mc -ac
and ESC 1
to get help.
-- TWiki:Main.RichardDonkin - 27 Apr 2002 Web | Tools | Use to... |
---|---|---|
BX12 | ? | |
Book | ? | |
CC? | ? | |
Compare | ||
GPCE06 | ? | |
GPCE08 | ? | |
GPCE09 | ? | |
GPCE10 | ? | |
GPCE11 | ? | |
GPCE12 | ? | |
GPCE13 | ? | |
GPCE14 | ? | |
Gmt | ? | |
Gpce | ||
Gpce03 | ||
Gpce04 | ? | |
Gpce05 | ? | |
Gpceorg | ? | |
HART14 | ? | |
IPA06 | ||
Main | ... | |
Octave | ? | ... |
PEPM07 | ? | |
PEPM08 | ? | |
PEPM10 | ? | |
PEPM11 | ? | |
PEPM12 | ? | |
PEPM13 | ? | |
PEPM14 | ? | |
PHP | ||
Sandbox | ...experiment in an unrestricted hands-on web. | |
Sdf | ? | ... |
SdfBackup | ? | ... |
Spoofax | ||
Stratego | ? | ... |
Sts | ? | |
TWiki | ...discover TWiki details, and how to start your own site. | |
Tiger | ? | ... |
Tools | ? | ... |
Transform | ? | ... |
Variability | ? | |
WGLD | ||
WebDSL | ? | |
default | ? ? ? ? ? ? ? | |
This table is updated automatically based on WebPreferences settings of the individual webs. |
Legend: | WebHome | WebSearch | WebChanges | WebNotify | |
WebPreferences | WebStatistics | WebTopicList | WebIndex |
*_text_*
as bold italic text.
ExternalSite:Page
text to external sites based on aliases defined in the InterWikis topic
"$SUM( $ABOVE() )"
to tables located in TWiki topics.
$siteLocale
setting in TWiki.cfg - 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').
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.
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.
This feature is complete in TWiki releases newer than February 2004.
Note for skin developers: %INTURLENCODE% is no longer required (TWiki:Plugins.InternationalisingYourSkin).
$siteCharset
(from the TWiki.cfg
locale setting), using modules such as CPAN:Encode if needed.
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.
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.
twiki
- to whatever you like by changing it in the TWiki.cfg
configuration file. However, to keep the current installation and future upgrades simple, you should leave the five main subdirectories intact:
Directory: | Files: | Used for: |
---|---|---|
twiki | list | Start-up info |
twiki/bin | list | Perl scripts |
twiki/lib | list | Configuration file, main library, Perl system modules, Plugins directory |
twiki/pub | list | Public files (eg: images) and FileAttachments and their RCS histories |
twiki/data | list | Individual topics (page content) and their RCS histories |
twiki/templates | list | HTML templates, used by TWiki scripts |
twiki
File | Used for |
---|---|
index.html | Links to launch TWiki after install and for files in this directory |
license.txt | GNU General Public License and TWiki-specific info |
readme.txt | General TWiki start-up info with relevant URLs |
TWikiDocumentation.html | All documentation packaged as a single page |
TWikiHistory.html | TWiki development timeline: versions, features, developers |
TwikiUpgrade | TWiki upgrade script (Beta state) |
twiki/bin
File: | Used for: |
---|---|
.htaccess.txt | Authentication. Rename to .htaccess and customize if used |
attach | Shows the attach file page (FileAttachment) |
changes | a simple WebChanges query |
edit | Edit a topic |
geturl | Fetch URL data |
installpasswd | Install new password by admin |
mailnotify | Script called by cron job to notify users of changes |
manage | Manage script to create new webs |
oops | Shows an OK or oops dialog |
passwd | Reset and change password |
preview | Preview topic after edit |
rdiff | See differences of topics |
rdiffauth | Copy of rdiff script (ideally a link). The .htaccess file sets this as requiring authorisation |
register | Register new users |
rename | Rename/move topics and move attachments |
save | Saves a topic, called by preview |
search | Displays search results |
setlib.cfg | Location of the TWiki libraries. Customize if needed |
statistics | Create statistics topic |
testenv | Test CGI environment variables |
upload | Does file upload (FileAttachment) |
view | View a topic (the script) |
viewauth | Copy of view script (ideally a link). The .htaccess file sets this as requiring authorisation |
viewfile | View a file attachment |
twiki/lib
lib/TWiki/Plugins
directories contain configuration, library and function files, and TWikiPlugins. Full file list:
File: | Used for: |
---|---|
TWiki.cfg | Main configuration, used by TWiki.pm |
TWiki.pm | Main TWiki library |
Algorithm/Diff.pm | Diff library |
Text/Diff.pm | Diff library, used by TwikiUpgrade script |
TWiki/Access.pm | Access control |
TWiki/Attach.pm | Attachment handling |
TWiki/Form.pm | Form handling |
TWiki/Func.pm | Public functions that Plugins may use |
TWiki/Meta.pm | Meta data in topics |
TWiki/Net.pm | SMTP mail handling |
TWiki/Plugins.pm | Plugin handling |
TWiki/Plugins/CommentPlugin.pm | Plugin handling a comment box |
TWiki/Plugins/CommentPlugin/Attrs.pm | Supporting module for Comment Plugin |
TWiki/Plugins/CommentPlugin/Comment.pm | Supporting module for Comment Plugin |
TWiki/Plugins/CommentPlugin/Templates.pm | Supporting module for Comment Plugin |
TWiki/Plugins/DefaultPlugin.pm | Handles some legacy rules |
TWiki/Plugins/EditTablePlugin.pm | Plugin to edit tables |
TWiki/Plugins/EmptyPlugin.pm | Empty plugin, use to create your own |
TWiki/Plugins/InterwikiPlugin.pm | Use aliases as links for predefined URLs |
TWiki/Plugins/RenderListPlugin.pm | Plugin to render lists as nice trees |
TWiki/Plugins/SlideShowPlugin.pm | Plugin turning headings into slides |
TWiki/Plugins/SmiliesPlugin.pm | Plugin rendering smilies like :-) |
TWiki/Plugins/SpreadSheetPlugin.pm | Plugin resolving spreadsheet formulae |
TWiki/Plugins/TablePlugin.pm | Plugin to render tables nicely |
TWiki/Prefs.pm | Preferences handling |
TWiki/Render.pm | TWiki markup to HTML rendering |
TWiki/Search.pm | Search engine, used by TWiki.pm |
TWiki/Store.pm | Back-end storage, *.txt text file and *.txt,v RCS repository file handling |
TWiki/Store/RcsFile.pm | Generic file handling code, a class |
TWiki/Store/RcsWrap.pm | Wrappers around RCS executables, a class that inherits from RcsFile |
TWiki/Store/RcsLite.pm | A Perl RCS implemention, a class that inherits from RcsFile |
TWiki/UI.pm | User interface handling |
TWiki/UI/Changes.pm | Functionality of changes script |
TWiki/UI/Edit.pm | Functionality of edit script |
TWiki/UI/Manage.pm | Functionality of manage script |
TWiki/UI/Oops.pm | Functionality of oops script |
TWiki/UI/Preview.pm | Functionality of preview script |
TWiki/UI/RDiff.pm | Functionality of rdiff script |
TWiki/UI/Save.pm | Functionality of save script |
TWiki/UI/Search.pm | Functionality of search script |
TWiki/UI/Statistics.pm | Functionality of statistics script |
TWiki/UI/Upload.pm | Functionality of upload script |
TWiki/UI/View.pm | Functionality of view script |
TWiki/UI/Viewfile.pm | Functionality of viewfile script |
TWiki/Upgrade/TWikiCfg.pm | Supporting module of TwikiUpgrade script |
TWiki/Upgrade/UpdateTopics.pm | Supporting module of TwikiUpgrade script |
TWiki/Upgrade/UpdateTopicsManualSymlinks.pm | Supporting module of TwikiUpgrade script |
TWiki/User.pm | Abstraction package to allow plugable user authentication systems |
TWiki/User/HtPasswdUser.pm | Apache Htpasswd file implementation (the default) |
TWiki/User/NoPasswdUser.pm | simple, no users authentication (totally wiki) |
twiki/pub
pub
directory stores topic-related files, including images used by TWiki and FileAttachments. Attachments are stored in subdirectories created with the related topic name. You can also upload files directly for and link manually (but not through Attach
) Partial file list:
File: | Used for: |
---|---|
favicon.ico | ICO file |
wikiHome.gif | GIF file |
icn/_filetypes.txt | Lookup table to translate file extension to file type |
icn/bat.gif | GIF file for file type |
icn/bmp.gif | GIF file for file type |
... | ... |
TWiki/FileAttachment/Sample.txt | TEXT file: sample |
TWiki/FileAttachment/Smile.gif | GIF image: sample |
TWiki/FileAttachment/Smile.gif,v | RCS repository for GIF file |
TWiki/PreviewBackground/blankltgraybg.gif | GIF image |
TWiki/PreviewBackground/blankwhitebg.gif | GIF image |
TWiki/PreviewBackground/previewbg.gif | GIF image: Preview view background |
TWiki/PreviewBackground/preview2bg.gif | GIF image: Alternate preview view background |
TWiki/TWikiLogos/twikiRobot121x54.gif | GIF image: TWiki logo |
... | ... |
TWiki/TWikiTemplates/testscreen.gif | GIF image: Screen shot |
TWiki/WabiSabi/wabisabi.gif | GIF image: illustration |
twiki/data
Main
, TWiki
, and Sandbox
- with documentation and demo content, a Trash
web for browser-based, recoverable topic deletion, and a _default
directory containing a core topic set required to start a new web. Partial file list:
File: | Used for: |
---|---|
.htpasswd | Basic Authentication (htaccess) users file with username and encrypted password pairs |
debug.txt | Program-generated messages useful for debugging |
mime.types | Recognized file formats |
warning.txt | Diagnostic messages for identifying problems |
_default/.changes | Per web record of topic changes |
_default/.mailnotify | Per web timestamp of most recent email notification |
_default/WebChanges.txt | Display most recent topic changes in web |
_default/WebChanges.txt,v | Revisions history (RCS) |
_default/WebHome.txt | Default web home page |
_default/WebHome.txt,v | Revisions history (RCS) |
_default/WebIndex.txt | Lists all topics in a web |
_default/WebIndex.txt,v | Revisions history (RCS) |
_default/WebLeftBar.txt | Left navigation bar for PatternSkin |
_default/WebLeftBar.txt,v | Revisions history (RCS) |
_default/WebNotify.txt | Subscribe/unsubscribe to web changes email alert |
_default/WebNotify.txt,v | Revisions history (RCS) |
_default/WebPreferences.txt | Per web Preference Settings |
_default/WebPreferences.txt,v | Revisions history (RCS) |
_default/WebSearch.txt | Per web search options |
_default/WebSearch.txt,v | Revisions history (RCS) |
_default/WebStatistics.txt | Generates web usage statistics |
_default/WebStatistics.txt,v | Revisions history (RCS) |
_default/WebTopicList.txt | Lists all topics in a web in compact format |
_default/WebTopicList.txt,v | Revisions history (RCS) |
... | ... |
twiki/templates
File: | Used for: |
---|---|
attach.tmpl | Attachment (FileAttachments) control screen |
attachagain.tmpl | Attachment control screen for updating an existing attachment |
attachnew.tmpl | Attachment control screen for adding a new attachment |
attachtables.tmpl | Macros for definition of attachment tables |
changeform.tmpl | Control screen to change the form in edit mode |
changes.tmpl | Displays list of recently changed topics |
edit.iejs.tmpl | Edit window with IE-specific JavaScript |
edit.tmpl | Main edit window |
mailnotify.tmpl | Email notification |
moveattachment.tmpl | Move attachment control screen |
oopsaccesschange.tmpl | Error message |
oopsaccessgroup.tmpl | Error message |
oopsaccessmanage.tmpl | Error message |
oopsaccessrename.tmpl | Error message |
oopsaccessview.tmpl | Error message |
oopsattachnotopic.tmpl | Error message |
oopsauth.tmpl | Error message |
oopsbadcharset.tmpl | Error message |
oopsbadpwformat.tmpl | Error message |
oopschangepasswd.tmpl | Error message |
oopscreatenewtopic.tmpl | Error message |
oopsempty.tmpl | Error message |
oopslocked.tmpl | Error message |
oopslockedrename.tmpl | Error message |
oopsmanage.tmpl | Error message |
oopsmissing.tmpl | Error message |
oopsmngcreateweb.tmpl | Error message |
oopsmore.tmpl | More topic actions message |
oopsmoveerr.tmpl | Error message |
oopsnoformdef.tmpl | Error message |
oopsnotwikiuser.tmpl | Error message |
oopsnoweb.tmpl | Error message |
oopspreview.tmpl | Error message |
oopsregemail.tmpl | Error message |
oopsregexist.tmpl | Error message |
oopsregpasswd.tmpl | Error message |
oopsregrequ.tmpl | Error message |
oopsregthanks.tmpl | Error message |
oopsregwiki.tmpl | Error message |
oopsremoveuserdone.tmpl | Error message |
oopsrenameerr.tmpl | Error message |
oopsrenamenotwikiword.tmpl | Error message |
oopsresetpasswd.tmpl | Error message |
oopsrev.tmpl | Error message |
oopssave.tmpl | Error message |
oopssaveerr.tmpl | Error message |
oopssendmailerr.tmpl | Error message |
oopstopicexists.tmpl | Error message |
oopsupload.tmpl | Error message |
oopsuploadlimit.tmpl | Error message |
oopswrongpassword.tmpl | Error message |
preview.tmpl | Preview Changes screen |
rdiff.tmpl | Displays text changes before & after Diffs |
registernotify.tmpl | Registration notification |
rename.tmpl | Rename/move control screen (choose web & new topic tile |
renamebase.tmpl | Used by other rename templates |
renameconfirm.tmpl | Confirms a pre-specified rename, ex: undoing a rename |
renamedelete.tmpl | Confirms a delete |
renamerefs.tmpl | Display if rename done, but some references not changed (topics were locked) |
search.tmpl | Search screen |
searchbookview.tmpl | Search results with full topic content |
searchformat.tmpl | Search screen for formatted search |
searchmeta.tmpl | Search screen |
searchrenameview.tmpl | Used by rename to list references to topic being renamed |
twiki.tmpl | Master template: definitions are used by other templates |
view.plain.tmpl | Skin for bare bone topic view without header/footer but with HTML head and body tags |
view.print.tmpl | Skin for printable topic view with a simple header/footer |
view.rss.tmpl | Skin for topic view in RDF XML format |
view.text.tmpl | Skin for topic text only, without HTML head and body tags, and no form and attachments |
view.tmpl | Main topic view - the standard regular Web page |
twiki twiki
- will probably be your domain or login name, eg: yourdomain yourdomain
and can't be changed; same for nobody nobody
files further down. Also, in the bin
directory, scripts might need a .cgi
(sometimes .pl
) extension.
twiki/bin
:
drwxrwxr-x 2 twiki twiki 4096 May 9 00:08 . drwxrwxr-x 5 twiki twiki 4096 Nov 18 2002 .. -rw-rw-r-- 1 twiki twiki 3145 Jul 25 00:31 .htaccess.txt -rwxrwxr-x 1 twiki twiki 1459 May 28 23:51 attach -rwxrwxr-x 1 twiki twiki 1721 May 28 23:51 changes -rwxrwxr-x 1 twiki twiki 1994 May 28 23:51 edit -rwxrwxr-x 1 twiki twiki 1878 May 28 23:51 geturl -rwxrwxr-x 1 twiki twiki 6689 May 28 23:51 installpasswd -rwxrwxr-x 1 twiki twiki 7313 May 28 23:51 mailnotify -rwxrwxr-x 1 twiki twiki 3557 Jul 25 15:00 manage -rwxrwxr-x 1 twiki twiki 1448 May 28 23:51 oops -rwxrwxr-x 1 twiki twiki 4062 May 28 23:51 passwd -rwxrwxr-x 1 twiki twiki 1506 May 28 23:51 preview -rwxrwxr-x 2 twiki twiki 1490 May 28 23:51 rdiff -rwxrwxr-x 2 twiki twiki 1490 May 28 23:51 rdiffauth -rwxrwxr-x 1 twiki twiki 7635 May 28 23:51 register -rwxrwxr-x 1 twiki twiki 1774 May 28 23:51 rename -rwxrwxr-x 1 twiki twiki 1654 Jul 25 00:31 save -rwxrwxr-x 1 twiki twiki 1728 May 28 23:51 search -rw-rw-r-- 1 twiki twiki 2131 Aug 7 21:13 setlib.cfg -rwxrwxr-x 1 twiki twiki 2596 May 28 23:51 statistics -rwxrwxr-x 1 twiki twiki 39926 Jul 25 15:00 testenv -rwxrwxr-x 1 twiki twiki 1478 May 28 23:51 upload -rwxrwxr-x 2 twiki twiki 1689 May 28 23:51 view -rwxrwxr-x 2 twiki twiki 1689 May 28 23:51 viewauth -rwxrwxr-x 1 twiki twiki 1438 May 28 23:51 viewfileDirectory
twiki/templates/
:
drwxrwxr-x 2 twiki twiki 4096 Aug 7 19:09 . drwxrwxr-x 4 twiki twiki 4096 Aug 7 21:13 .. -rw-rw-r-- 1 twiki users 2077 Aug 13 22:21 attachagain.pattern.tmpl -rw-rw-r-- 1 twiki users 1650 Aug 13 22:21 attachagain.tmpl -rw-rw-r-- 1 twiki twiki 2556 Jul 27 10:47 attach.dragon.tmpl -rw-rw-r-- 1 twiki users 567 Jul 28 19:52 attachnew.pattern.tmpl -rw-rw-r-- 1 twiki users 470 Jul 28 19:52 attachnew.tmpl -rw-rw-r-- 1 twiki users 2855 Aug 8 03:40 attach.pattern.tmpl -rw-rw-r-- 1 twiki users 1991 Aug 3 13:09 attachtables.pattern.tmpl -rw-rw-r-- 1 twiki users 1869 Jul 27 22:03 attachtables.tmpl -rw-rw-r-- 1 twiki users 2355 Jul 28 19:52 attach.tmpl -rw-rw-r-- 1 twiki twiki 1324 Jul 27 10:47 changeform.dragon.tmpl -rw-rw-r-- 1 twiki twiki 1441 Aug 6 11:47 changeform.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1032 Jul 28 19:52 changeform.tmpl -rw-rw-r-- 1 twiki twiki 1870 Jul 27 10:47 changes.dragon.tmpl -rw-rw-r-- 1 twiki twiki 433 Jul 31 12:39 changes.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1196 May 28 23:51 changes.tmpl -rw-rw-r-- 1 twiki twiki 35 May 21 03:56 comments.tmpl -rw-rw-r-- 1 twiki twiki 526 Jul 27 10:47 dragoncssvars.dragon.tmpl -rw-rw-r-- 1 twiki twiki 1645 Jul 31 00:57 dragonmenu.dragon.tmpl -rw-rw-r-- 1 twiki twiki 4207 Jul 27 10:47 edit.dragon.tmpl -rw-rw-r-- 1 twiki twiki 12608 Jul 28 19:52 edit.iejs.tmpl -rw-rw-r-- 1 twiki twiki 4904 Aug 7 17:48 edit.pattern.tmpl -rw-rw-r-- 1 twiki twiki 3975 Aug 8 03:40 edit.tmpl -rw-rw-r-- 1 twiki twiki 993 May 28 23:51 mailnotify.tmpl -rw-rw-r-- 1 twiki twiki 1640 Jul 27 10:47 moveattachment.dragon.tmpl -rw-rw-r-- 1 twiki twiki 1968 Aug 7 17:48 moveattachment.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1342 Jul 28 19:52 moveattachment.tmpl -rw-rw-r-- 1 twiki twiki 571 May 28 23:51 oopsaccesschange.tmpl -rw-rw-r-- 1 twiki twiki 587 May 28 23:51 oopsaccessgroup.tmpl -rw-rw-r-- 1 twiki twiki 597 Aug 2 11:10 oopsaccessmanage.tmpl -rw-rw-r-- 1 twiki twiki 572 May 28 23:51 oopsaccessrename.tmpl -rw-rw-r-- 1 twiki twiki 574 May 28 23:51 oopsaccessview.tmpl -rw-rw-r-- 1 twiki twiki 571 Aug 2 11:10 oopsattachnotopic.tmpl -rw-rw-r-- 1 twiki twiki 998 May 28 23:51 oopsauth.tmpl -rw-rw-r-- 1 twiki twiki 646 May 28 23:51 oopsbadcharset.tmpl -rw-rw-r-- 1 twiki twiki 406 May 28 23:51 oopsbadpwformat.tmpl -rw-rw-r-- 1 twiki twiki 345 May 28 23:51 oopschangepasswd.tmpl -rw-rw-r-- 1 twiki twiki 382 May 28 23:51 oopscreatenewtopic.tmpl -rw-rw-r-- 1 twiki twiki 627 Jul 7 23:11 oopsempty.tmpl -rw-rw-r-- 1 twiki twiki 927 Aug 3 13:09 oopslocked.pattern.tmpl -rw-rw-r-- 1 twiki twiki 612 Aug 2 11:10 oopslockedrename.pattern.tmpl -rw-rw-r-- 1 twiki twiki 596 Aug 2 11:10 oopslockedrename.tmpl -rw-rw-r-- 1 twiki twiki 910 Aug 3 13:09 oopslocked.tmpl -rw-rw-r-- 1 twiki twiki 679 May 28 23:51 oopsmanage.tmpl -rw-rw-r-- 1 twiki twiki 329 May 28 23:51 oopsmissing.tmpl -rw-rw-r-- 1 twiki twiki 2353 May 28 23:51 oopsmngcreateweb.tmpl -rw-rw-r-- 1 twiki twiki 2987 Aug 3 13:09 oopsmore.tmpl -rw-rw-r-- 1 twiki twiki 418 May 28 23:51 oopsmoveerr.tmpl -rw-rw-r-- 1 twiki twiki 1133 May 28 23:51 oopsnoformdef.tmpl -rw-rw-r-- 1 twiki twiki 521 May 28 23:51 oopsnotwikiuser.tmpl -rw-rw-r-- 1 twiki twiki 1516 Jul 28 19:52 oopsnoweb.tmpl -rw-rw-r-- 1 twiki twiki 394 May 28 23:51 oopspreview.tmpl -rw-rw-r-- 1 twiki twiki 341 May 28 23:51 oopsregemail.tmpl -rw-rw-r-- 1 twiki twiki 411 May 28 23:51 oopsregerr.tmpl -rw-rw-r-- 1 twiki twiki 476 May 28 23:51 oopsregexist.tmpl -rw-rw-r-- 1 twiki twiki 346 May 28 23:51 oopsregpasswd.tmpl -rw-rw-r-- 1 twiki twiki 357 May 28 23:51 oopsregrequ.tmpl -rw-rw-r-- 1 twiki twiki 541 May 28 23:51 oopsregthanks.tmpl -rw-rw-r-- 1 twiki twiki 680 May 28 23:51 oopsregwiki.tmpl -rw-rw-r-- 1 twiki twiki 587 May 28 23:51 oopsremoveuserdone.tmpl -rw-rw-r-- 1 twiki twiki 503 May 28 23:51 oopsrenameerr.tmpl -rw-rw-r-- 1 twiki twiki 434 May 28 23:51 oopsrenamenotwikiword.tmpl -rw-rw-r-- 1 twiki twiki 507 May 28 23:51 oopsresetpasswd.tmpl -rw-rw-r-- 1 twiki twiki 962 Jul 28 19:52 oopsrev.tmpl -rw-rw-r-- 1 twiki twiki 483 May 28 23:51 oopssaveerr.tmpl -rw-rw-r-- 1 twiki twiki 777 Jul 7 23:11 oopssave.tmpl -rw-rw-r-- 1 twiki twiki 466 May 28 23:51 oopssendmailerr.tmpl -rw-rw-r-- 1 twiki twiki 385 May 28 23:51 oopstopicexists.tmpl -rw-rw-r-- 1 twiki twiki 344 May 28 23:51 oopsuploadlimit.tmpl -rw-rw-r-- 1 twiki twiki 343 May 28 23:51 oopsupload.tmpl -rw-rw-r-- 1 twiki twiki 365 May 28 23:51 oopswrongpassword.tmpl -rw-rw-r-- 1 twiki twiki 3590 Jul 27 10:47 preview.dragon.tmpl -rw-rw-r-- 1 twiki twiki 2855 Aug 6 11:47 preview.pattern.tmpl -rw-rw-r-- 1 twiki twiki 2253 Aug 8 03:40 preview.tmpl -rw-rw-r-- 1 twiki twiki 1739 Jul 27 10:47 rdiff.dragon.tmpl -rw-rw-r-- 1 twiki users 1529 Aug 13 22:21 rdiff.pattern.tmpl -rw-rw-r-- 1 twiki users 1299 May 28 23:51 rdiff.tmpl -rw-rw-r-- 1 twiki twiki 1159 Jul 31 12:39 registernotify.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1160 May 28 23:51 registernotify.tmpl -rw-rw-r-- 1 twiki twiki 2561 Jul 27 10:47 renamebase.dragon.tmpl -rw-rw-r-- 1 twiki twiki 3363 Aug 8 03:40 renamebase.pattern.tmpl -rw-rw-r-- 1 twiki twiki 2279 Jul 28 20:54 renamebase.tmpl -rw-rw-r-- 1 twiki twiki 718 Jul 31 12:39 renameconfirm.pattern.tmpl -rw-rw-r-- 1 twiki twiki 570 Jul 28 19:52 renameconfirm.tmpl -rw-rw-r-- 1 twiki twiki 1046 Jul 31 12:39 renamedelete.pattern.tmpl -rw-rw-r-- 1 twiki twiki 932 Jul 28 19:52 renamedelete.tmpl -rw-rw-r-- 1 twiki twiki 1147 Jul 31 12:39 rename.pattern.tmpl -rw-rw-r-- 1 twiki twiki 766 Jul 28 19:52 renamerefs.pattern.tmpl -rw-rw-r-- 1 twiki twiki 616 Jul 28 19:52 renamerefs.tmpl -rw-rw-r-- 1 twiki twiki 1041 Jul 28 19:52 rename.tmpl -rw-rw-r-- 1 twiki twiki 1397 Jul 27 10:47 searchbookview.dragon.tmpl -rw-rw-r-- 1 twiki twiki 723 Jul 31 12:39 searchbookview.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1230 May 28 23:51 searchbookview.tmpl -rw-rw-r-- 1 twiki twiki 1705 Jul 27 10:47 search.dragon.tmpl -rw-rw-r-- 1 twiki twiki 722 Jul 27 10:47 searchformat.dragon.tmpl -rw-rw-r-- 1 twiki twiki 157 Jul 31 12:39 searchformat.pattern.tmpl -rw-rw-r-- 1 twiki twiki 529 May 28 23:51 searchformat.tmpl -rw-rw-r-- 1 twiki twiki 149 Jul 7 23:03 searchmeta.pattern.tmpl -rw-rw-r-- 1 twiki twiki 149 May 28 23:51 searchmeta.tmpl -rw-rw-r-- 1 twiki twiki 1638 Aug 7 17:48 search.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1892 Jul 27 10:47 searchrenameview.dragon.tmpl -rw-rw-r-- 1 twiki twiki 1208 Aug 3 13:09 searchrenameview.pattern.tmpl -rw-rw-r-- 1 twiki twiki 1615 May 28 23:51 searchrenameview.tmpl -rw-rw-r-- 1 twiki twiki 1364 May 28 23:51 search.tmpl -rw-rw-r-- 1 twiki twiki 3836 Jul 27 10:47 twiki.dragon.tmpl -rw-rw-r-- 1 twiki twiki 3175 Aug 7 17:48 twiki.pattern.tmpl -rw-rw-r-- 1 twiki twiki 2798 Jul 27 22:57 twiki.tmpl -rw-rw-r-- 1 twiki twiki 1324 Jul 27 10:47 view.dragon.tmpl -rw-rw-r-- 1 twiki twiki 3577 Aug 8 03:40 view.pattern.tmpl -rw-rw-r-- 1 twiki twiki 425 May 28 23:51 view.plain.tmpl -rw-rw-r-- 1 twiki twiki 1056 Jul 31 12:39 view.print.pattern.tmpl -rw-rw-r-- 1 twiki twiki 845 May 28 23:51 view.print.tmpl -rw-rw-r-- 1 twiki twiki 300 May 28 23:51 view.rss.tmpl -rw-rw-r-- 1 twiki twiki 8 May 28 23:51 view.text.tmpl -rw-rw-r-- 1 twiki twiki 1281 Jul 31 12:39 view.tmplDirectory
twiki/data/
:
drwxrwxr-x 7 nobody twiki 4096 Aug 7 21:13 . drwxrwxr-x 4 twiki twiki 4096 Aug 7 21:13 .. -rw-rw-rw- 1 twiki twiki 0 Feb 1 2003 debug.txt drwxrwxr-x 2 nobody twiki 4096 Jul 16 00:36 _default -rw-rw-r-- 1 twiki twiki 25 Dec 16 2003 .htpasswd.txt -rw-rw-r-- 1 nobody nobody 11811 Aug 13 23:10 log200408.txt drwxrwxr-x 2 nobody twiki 4096 Aug 4 21:03 Main -rw-rw-r-- 1 twiki twiki 3419 Aug 13 2001 mime.types drwxrwxr-x 2 nobody twiki 4096 Aug 7 21:03 Sandbox drwxrwxr-x 2 nobody twiki 4096 Jul 20 18:15 Trash drwxrwxr-x 2 nobody twiki 12288 Aug 13 23:10 TWiki -rw-rw-rw- 1 twiki twiki 0 Aug 7 18:03 warning.txtPartial file list for
twiki/data/Main
:
.txt,v
.
drwxrwxr-x 2 nobody twiki 4096 Aug 4 21:03 . drwxrwxr-x 7 nobody twiki 4096 Aug 7 21:13 .. -rw-rw-rw- 1 twiki twiki 3743 Aug 4 21:03 .changes -rw-rw-rw- 1 twiki twiki 9 Oct 25 2001 .mailnotify -rw-r--r-- 1 nobody nobody 518 Dec 16 2003 TWikiAdminGroup.txt -r--r--r-- 1 nobody nobody 2453 Dec 16 2003 TWikiAdminGroup.txt,v -rw-r--r-- 1 nobody nobody 1668 Aug 4 21:03 TWikiGroups.txt -r--r--r-- 1 nobody nobody 3421 Aug 4 21:03 TWikiGroups.txt,v -rw-r--r-- 1 nobody nobody 686 Dec 13 2000 TWikiGuest.txt -rw-r--r-- 1 nobody nobody 1995 Dec 13 2000 TWikiGuest.txt,v -rw-r--r-- 1 nobody nobody 319 Dec 20 2003 TWikiPreferences.txt -r--r--r-- 1 nobody nobody 508 Dec 20 2003 TWikiPreferences.txt,v -rw-r--r-- 1 nobody nobody 1812 Feb 20 13:54 TWikiUsers.txt -r--r--r-- 1 nobody nobody 9222 Feb 20 13:54 TWikiUsers.txt,v -rw-r--r-- 1 nobody nobody 119 Jan 11 2003 TWikiVariables.txt -r--r--r-- 1 nobody nobody 742 Jan 11 2003 TWikiVariables.txt,v -rw-r--r-- 1 nobody nobody 124 Aug 16 2001 WebChanges.txt -r--r--r-- 1 nobody nobody 526 Aug 16 2001 WebChanges.txt,v -rw-r--r-- 1 nobody nobody 1842 Feb 1 2003 WebHome.txt -r--r--r-- 1 nobody nobody 11862 Feb 1 2003 WebHome.txt,v -rw-r--r-- 1 nobody nobody 176 Nov 24 2001 WebIndex.txt -r--r--r-- 1 nobody nobody 483 Nov 24 2001 WebIndex.txt,v -rw-r--r-- 1 nobody nobody 922 Feb 3 2003 WebNotify.txt -r--r--r-- 1 nobody nobody 4303 Feb 3 2003 WebNotify.txt,v -rw-r--r-- 1 nobody nobody 3738 Dec 25 2003 WebPreferences.txt -r--r--r-- 1 nobody nobody 10697 Dec 25 2003 WebPreferences.txt,v -rw-r--r-- 1 nobody nobody 416 Jan 30 2003 WebRss.txt -r--r--r-- 1 nobody nobody 605 Jan 30 2003 WebRss.txt,v -rw-r--r-- 1 nobody nobody 164 Jan 18 2004 WebSearchAdvanced.txt -r--r--r-- 1 nobody nobody 353 Jan 18 2004 WebSearchAdvanced.txt,v -rw-r--r-- 1 nobody nobody 158 Aug 7 2001 WebSearch.txt -r--r--r-- 1 nobody nobody 18332 Aug 7 2001 WebSearch.txt,v -rw-r--r-- 1 nobody nobody 825 Jul 16 00:32 WebStatistics.txt -r--r--r-- 1 nobody nobody 4226 Jul 16 00:32 WebStatistics.txt,v -rw-r--r-- 1 nobody nobody 182 Nov 24 2001 WebTopicList.txt -r--r--r-- 1 nobody nobody 371 Nov 24 2001 WebTopicList.txt,vDirectory
twiki/pub/
:
drwxrwxr-x 8 nobody nobody 4096 Nov 18 12:31 . drwxrwxr-x 3 twiki twiki 4096 Nov 18 12:31 .. drwxrwxr-x 2 nobody nobody 4096 Apr 7 2002 Main drwxrwxr-x 2 nobody nobody 4096 Apr 20 2002 Sandbox drwxrwxr-x 8 nobody nobody 4096 Nov 18 12:31 TWiki drwxrwxr-x 2 nobody nobody 4096 Dec 3 2001 Trash -rw-rw-r-- 1 twiki twiki 1078 Jan 14 2000 favicon.ico drwxrwxr-x 2 twiki twiki 4096 Nov 18 12:31 icn -rw-rw-r-- 1 twiki twiki 2877 Jun 7 1999 wikiHome.gifPartial file list for
twiki/pub/icn/
:
drwxrwxr-x 2 twiki twiki 4096 Nov 18 12:31 . drwxrwxr-x 8 nobody nobody 4096 Nov 18 12:31 .. -rw-rw-r-- 1 twiki twiki 801 Mar 26 1999 _filetypes.txt -rw-rw-r-- 1 twiki twiki 143 Mar 9 1999 bat.gif -rw-rw-r-- 1 twiki twiki 926 Mar 9 1999 bmp.gif -rw-rw-r-- 1 twiki twiki 141 Mar 25 1999 c.gif -rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 dll.gif -rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 doc.gifDirectory
twiki/pub/TWiki
:
drwxrwx--x 8 nobody nobody 4096 Nov 18 12:31 . drwxrwxr-x 8 nobody nobody 4096 Nov 18 12:31 .. drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 FileAttachment drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 PreviewBackground drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 TWikiDocGraphics drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 TWikiLogos drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 TWikiTemplates drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 WabiSabiDirectory
twiki/pub/TWiki/FileAttachment
:
drwxrwxr-x 2 nobody nobody 4096 Nov 18 12:31 . drwxrwx--x 8 nobody nobody 4096 Nov 18 12:31 .. -rw-rw-r-- 1 nobody nobody 30 Jul 22 1999 Sample.txt -rw-rw-r-- 1 nobody nobody 94 Jun 7 1999 Smile.gif -r--r--r-- 1 nobody nobody 81 Aug 15 10:14 Smile.gif,v-- TWiki:Main.PeterThoeny - 29 Aug 2004
.htpassword
file managed by TWiki. It does not apply if you are using external authentication, such as an IT managed password system. (remove this note if you are using Basic Authentication; else replace this topic with a note describing how to change the password in your organization)Description: | The classic TWiki skin, bare bone and functional, for any browser, with a minimum of graphics |
Screenshot: | |
Base Name: | classic |
Skin Author: | TWiki:Main/PeterThoeny |
Skin Version: | 25 Jul 2004 (v1.000) |
Change History: | |
25 Jul 2004: | Initial version (v1.000) |
Dependencies: | |
Skin Home: | http://TWiki.org/cgi-bin/view/Plugins/ClassicSkin |
Feedback: | http://TWiki.org/cgi-bin/view/Plugins/ClassicSkinDev |
%COMMENT{
attributes }%
anywhere in a TWiki topic. %COMMENT% is also legal.
The following attributes are recognised
Name | Description |
---|---|
type | (Required) This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see Customisation, below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences. By default this is 'below'. |
target | Name of the topic to add the comment to. Defaults to the current topic. |
location | Regular expression specifying the comment location in the target topic. Read carefully below! |
mode | For compatability with older versions only, synonymous with type |
nonotify | Set to "on" to disable change notification for target topics |
%COMMENT
supports several ways to specify where a comment should be inserted in the target topic. This is referred to as the location of the comment.
%COMMENT
tag %COMMENT
tag itself. For example:
%COMMENT{type="below"}%will add comments in the current topic, directly below the
%COMMENT
tag.
target
attribute may specify a web, and may also specify an anchor within the target topic; for example,
%COMMENT{type="above" target="%MAINWEB%.PersonalRemarks#InsertHere"}%This uses a standard TWiki in-topic anchor as the insertion location. See TextFormattingRules for more about TWiki anchors.
location
parameter. The target topic is searched for the regular expression, and the comment inserted relative to the string that the search matched. For example,
%COMMENT{type="above" location="Flights of Fancy"}%will place comments above the first occurence of the string
Flights of Fancy
in the current topic.
Warning of course, if a user's comment contains the string "Flights of Fancy" they may and up changing the location for the next comment! Also, if you use a tag in the location, then you've just inserted another tag in the page that contains the %COMMENT
! So be very careful how you specify the RE for location
. Note that the RE is matched using perl "multiple line" mode, so ^ and $ match the start of a line and the end of a line respectively.
If you specify an anchor and a location
, the anchor will be ignored.
Template type | Description |
---|---|
top | Comments, signed and dated, added at top of the topic (the anchor is ignored) |
bottom | Comments, signed and dated, added at end of the target topic (the anchor is ignored) |
above | Comments, signed and dated, added immediately before the target anchor, or the %COMMENT if no anchor is specified |
below | Comments, signed and dated, added immediately below the target anchor, or the %COMMENT if no anchor is specified |
tableprepend | Comments, signed and dated, formatted as an HTML table row, added below the anchor (which must be in an HTML <table>) |
tableappend | Comments, signed and dated, formatted as an HTML table row, added above the anchor (which must be in an HTML <table>) |
%TMPL:INCLUDE
described in the documentation). The shipped plugin defines default templates in comments.tmpl
and then includes the topic CommentsTmpl. If you want to define your own templates, add them to UserTemplates?. Note that you can use %TMPL:INCLUDE
in this file to include other files of templates. Note also that if you want to override any of the default templates shipped with the plugin, you can simply do so by defining them in UserTemplates?, and they will replace the installed versions.
To define a comment type, you have to provide two simple template definitions in the template file; one for the prompt box, and one for the generated output. If we have a template type "mytype", these are named PROMPT:mytype
and OUTPUT:mytype
respectively. See comments.tmpl
in the templates directory for examples.
PROMPT
template PROMPT
template defines the contents of an HTML form that is used to capture the comment. This form invokes the comment generator when submitted. Parameters to the comment generator are defined using standard HTML input fields, such as input
, textarea
and select
. The user enters values for these parameters, and these are then available when the OUTPUT
template is expanded, in the form of %URLPARAM%
s.
Only the input fields of the form need be defined. The plugin automatically generates the >form<
and >:/form<
tags. Note that you must define a "submit" button if you want the form to work!
If an attribute is given to the %COMMENT
tag that is not one of the standard attributes, then that attribute is taken as the name of a parameter to be expanded in the PROMPT
template. Expressions in the template of the form %
param|
default%
(e.g. %rows|3%
, %button|Push me%
) are expanded to the values given in the %COMMENT
. For example, if the PROMPT
template 'example' contains:
<textarea rows=%rows|3% cols="%cols|50%" value="%tval|Rubbish%">and the %COMMENT tag is:
%COMMENT{type="example" rows="5" cols="20"}%then the template will be expanded as
<textarea rows=5 cols="20" value="Rubbish">As well as support for all the usual TWiki variables in templates, the following special variables are supported in the
PROMPT
definition:
Variable | Description |
---|---|
%MESSAGE% | A helpful generated message, either a lock message or a reminder to refresh. |
%DISABLED% | Set to 'disabled' when you cannot comment (see Important Note regarding Locks, below). |
OUTPUT
template OUTPUT
template defines the format for the text that actually gets embedded into the topic. All the usual TWiki variables are available in the PROMPT
definition, but note that they get expanded when the comment is inserted in the text, so time, date and username will refer to the time and date when the comment was made and the user who made it.
There are also four position tags that are used to indicate where the comment should be placed, relative to the location
defined in the %COMMENT
tag:
%POS:TOP% | If present, comments will be inserted at the top of the topic i.e. before any other text |
%POS:BOTTOM% | If present, comments will be inserted at the end of the topic i.e. after all existing text |
%POS:BEFORE% | If present, comments will be inserted immediately before the %COMMENT% tag |
%POS:AFTER% | If present, comments will be inserted immediately after the %COMMENT% tag |
DEFAULT_TYPE
%COMMENT
. When the target page is known to be locked, the PROMPT
form is automatically disabled.
CommentPlugin.zip
in your twiki installation directory. Content:
File: | Description: |
---|---|
data/TWiki/CommentPlugin.txt | Plugin doc page (this page) |
data/TWiki/CommentsTmpl.txt | Example user templates |
templates/comments.tmpl | Master comment templates |
lib/TWiki/Plugins/CommentPlugin.pm | Plugin Perl module |
lib/TWiki/Plugins/CommentPlugin/Comment.pm | Plugin Perl module |
lib/TWiki/Plugins/CommentPlugin/Templates.pm | Plugin Perl module |
lib/TWiki/Plugins/CommentPlugin/test.zip | Tests |
lib/TWiki/Plugins/CommentPlugin/build.pl | Build file |
viewauth
script to authenticate the user. As described in TWikiAccessControl, copy the view
script to viewauth
(or better, create a symbolic link) and add viewauth
to the list of authenticated scripts in the .htaccess
file.
%COMMENT
edit box below here.
%COMMENT{type="top" target="Sandbox.Comments"}%
Plugin Author: | v1.0 TWiki:Main/DavidWeller v2.0 TWiki:Main/PeterMasiar v3.0 TWiki:Main/CrawfordCurrie |
Plugin Version: | 3.0 |
Change History: | 3.003 11 Apr 2004: Minor line termination problem fixed, and "security" hyphen on standard comment removed and replaced with a bulleted list. |
3.002 6 April 2004: Applied patches (thanks Peter Thoeny) for multiple comment adding, BOTTOM and TOP inside meta-data, and moved example to Sandbox. | |
3.001 13 March 2004: Modified to use viewauth save technique (safer), add nonotify parameter, move templates fully into topics, with a hook for site-specifics, support %COMMENT%, internationalisation fixes | |
3.000 18 Feb 2004: TWiki:Main/CrawfordCurrie rewrote for standard templates and other user requests. Recognition to Patrice Fournier and Sam Abrams for terrific testing and patch support. | |
7 Feb 2004: TWiki:Main/CrawfordCurrie rewrote this page and CommentTemplates? in an effort to make the plugin more user friendly. Added {TIME} variable. Also updated CVS. | |
23 Sep 2003 TWiki:Main/PeterMasiar: 80% rewrite/refactor, adding templates | |
15 July 2003: TWiki:Main/PeterMasiar added "reminder" parameter and feature to pass comments to oopslockedcomments.tmpl template to copy-paste later | |
5 March 2002 Bug fixes, TWiki:Main/JonLambert created oopslockedcomments.tmpl template | |
24 Feb 2002 added a few more user requests, made "English" text configurable | |
4 Dec 2001: 1.01 release, changed name to CommentPlugin, added $button var, changed textarea WRAP setting to "soft" | |
30 Nov 2001: Initial version | |
Dependencies: | |
Perl Version: | 5.0 |
Plugin Home: | TWiki:Plugins/CommentPlugin |
Feedback: | TWiki:Plugins/CommentPluginDev |
%TMPL:DEF{promptbox}% <table><tr valign="middle"><td><textarea %DISABLED% rows="%rows|3%" cols="%cols|50%" name="comment" wrap="soft" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea></td><td><input %DISABLED% type="submit" value="%button|Add comment%" /></td></tr></table> %TMPL:END%Standard comment, preserving formatting, signed and dated
%TMPL:DEF{outputstandard}% %URLPARAM{"comment"}% -- %WIKIUSERNAME% - %DATE% %TMPL:END%Short comment, signed and dated
%TMPL:DEF{outputoneliner}% * %URLPARAM{"comment"}% -- %WIKIUSERNAME% - %DATE% %TIME%%TMPL:END%
%TMPL:DEF{PROMPT:top}%%TMPL:P{promptbox}%%TMPL:END%
%TMPL:DEF{OUTPUT:top}%%TMPL:P{outputoneliner}%%POS:TOP% %TMPL:END%
%TMPL:DEF{PROMPT:bottom}%%TMPL:P{promptbox}%%TMPL:END%
%TMPL:DEF{OUTPUT:bottom}%%POS:BOTTOM%%TMPL:P{outputoneliner}%%TMPL:END%
%TMPL:DEF{PROMPT:above}%%TMPL:P{promptbox}%%TMPL:END%
%TMPL:DEF{OUTPUT:above}%%POS:BEFORE%%TMPL:P{outputstandard}% %TMPL:END%
%TMPL:DEF{PROMPT:below}%%TMPL:P{promptbox}%%TMPL:END%
%TMPL:DEF{OUTPUT:below}%%POS:AFTER%%TMPL:P{outputstandard}% %TMPL:END%
%TMPL:DEF{PROMPT:tableprepend}%%TMPL:P{promptbox}%%TMPL:END%
%TMPL:DEF{OUTPUT:tableprepend}%%POS:AFTER%| %URLPARAM{"comment" newline="<br />"}% </td><td> %WIKIUSERNAME% </td><td> %DATE% %TIME% | %TMPL:END%
%TMPL:DEF{PROMPT:tableappend}%%TMPL:P{promptbox}%%TMPL:END%
%TMPL:DEF{OUTPUT:tableappend}%%POS:BEFORE%| %URLPARAM{"comment" newline="<br />"}% | %WIKIUSERNAME% | %DATE% %TIME% | %TMPL:END%
%TMPL:DEF{PROMPT:after}%%TMPL:P{promptbox}%%TMPL:END%
%TMPL:DEF{OUTPUT:after}%%TMPL:P{outputoneliner}% %POS:BEFORE%%TMPL:END%
%TMPL:DEF{PROMPT:action}% <table> <tr> <td align="right">Action for (TWiki.WikiName):</td> <td><input name="who" type="text" size="50" value="%URLPARAM{"who"}%" /></td> </tr> <tr> <td align="right">Due date:</td> <td> <input name="due" id="idDue" type="text" size="30" value="%URLPARAM{"due"}%" /> </td> </tr> <tr> <td colspan="2"> <textarea %DISABLED% rows="5" cols="120" name="comment" wrap="soft"></textarea> </td> </tr> <tr> <td colspan=2 align=middle><input %DISABLED% type="submit" value="Add action" /></td> </tr> </table> %TMPL:END%
%TMPL:DEF{OUTPUT:action}%%POS:BEFORE%%ACTION{who="%URLPARAM{"who"}%" due="%URLPARAM{"due"}%"}% %URLPARAM{"comment" newline="<br />"}%<br />- Created by %WIKIUSERNAME%, %DATE% %TIME% %TMPL:END%
%TMPL:DEF{PROMPT:poll}% <table valign="middle"> <tr> <td align=right>Number of sites?</td> <td align=left><input %DISABLED% type="text" name="sites" size="3" value="1"></td> <td align=right>Plugin hacked?</td> <td align=left> <select %DISABLED% name="pluginhacked"> <option>no</option> <option>yes</option> </select> </td> <td align=right>TWiki hacked?</td> <td align=left> <select %DISABLED% name="twikihacked"> <option>no</option> <option>yes</option> </select> </td> <td align=right>Remarks</td> <td align=left><input %DISABLED% type="text" name="remarks" size="30" value=""></td> <td> <input %DISABLED% type="submit" value="Yes, I use it" /> </td> </tr> </table> %TMPL:END%
%TMPL:DEF{OUTPUT:poll}%%POS:BEFORE%| %WIKIUSERNAME% | %URLPARAM{"sites"}% | %URLPARAM{"pluginhacked"}% | %URLPARAM{"twikihacked"}% | %URLPARAM{"remarks"}% | %TMPL:END%
%TMPL:DEF{PROMPT:table}% <hr width="60%"/> Date: <input %DISABLED% type="text" size="40" name="comment_date" /> <br /> City: <input %DISABLED% type="text" size="40" name="comment_city" value="" /> <input %DISABLED% type="submit" value="%button|Add%" /> entry <hr width="90%"/> %TMPL:END%
%TMPL:DEF{OUTPUT:table}% %POS:BEFORE%| %URLPARAM{"comment_date"}% | %WIKIUSERNAME% | %URLPARAM{"comment_city" }% | %TMPL:END%
%TMPL:DEF{PROMPT:toctalk}% <hr width="60%"/> Summary: <input %DISABLED% type="text" size="40" name="comment_summary" /> <br /> <textarea %DISABLED% rows="%rows|3%" cols="%cols|50%" name="comment_text" wrap="soft" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea> <br /> <input %DISABLED% type="submit" value="%button|Add%" /> <hr width="90%"/> %TMPL:END%
%TMPL:DEF{OUTPUT:toctalk}% %POS:BEFORE%---+++ %DATE% %TIME% %WIKIUSERNAME%: %URLPARAM{"comment_summary"}% %POS:BEFORE%%URLPARAM{"comment_text" }% %POS:BEFORE% %TMPL:END%
%TMPL:DEF{PROMPT:bookmark}% <hr width="60%"/> URL: <input %DISABLED% type="text" size="40" name="comment_url" value="http://" /> <br /> Link: <input %DISABLED% type="text" size="40" name="comment_link" /> <br /> Text: <input %DISABLED% type="text" size="40" name="comment_text" value="%MESSAGE%" /> <input %DISABLED% type="submit" value="%button|Add%" /> bookmark <hr width="90%"/> %TMPL:END%
%TMPL:DEF{OUTPUT:bookmark}% %POS:BEFORE% * [[%URLPARAM{"comment_url"}%][%URLPARAM{"comment_link"}%]] - %URLPARAM{"comment_text" }% %TMPL:END%%TMPL:INCLUDE{"TWiki.UserTemplates"}%
WebMenus
%INCLUDE:"TopicName"%
) if Plugin Preferences variable OLDINCLUDE
is set to 1
*_text_*
as bold italic text. Test if installed: This is bold italic
TWiki/Plugins/DefaultPlugin.pm
to add your own rules or to enable JosWiki rules.
%<plugin>_<setting>%
, i.e. %DEFAULTPLUGIN_SHORTDESCRIPTION%
*_text_*
as bold italic text.
%INCLUDE:"TopicName"%
syntax:
data/debug.txt
)
Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
Plugin Version: | 21 Mar 2004 |
Change History: | |
21 Mar 2004: | Added afterSaveHandler |
14 Jul 2001: | Changed to plug&play |
27 Feb 2001: | Initial version |
CPAN Dependencies: | none |
Other Dependencies: | none |
Perl Version: | 5.0 |
Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/DefaultPlugin |
Feedback: | http://TWiki.org/cgi-bin/view/Plugins/DefaultPluginDev |
Trash
web, where it's hidden but can be "undeleted" with system administrator access.
Click [More]
on the control bar at the bottom of the page you want to change, then choose [Rename/move]
, and make your changes to that screen. There's a link that launches to the ManagingTopics reference page in a pop-up window.
NOTE: The configuration of your site and your own access permissions determine whether you can access these functions.
Note for site administrators: To remove a topic permanently move it to the Trash web, then with file-level access, delete the .txt
and .txt,v
files manually from /twiki/data/Trash
.
Back to: TWikiFAQ
-- PeterThoeny - 09 May 2003TrashAttachment
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.
Click 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.
NOTE: The configuration of your site and your own access permissions determine whether you can access these functions.
Note for system administrators: To remove an attachment permanently move it to the Trash.TrashAttachment topic, then with file-level access, delete the file attachment and its ,v
repository file manually from twiki/pub/Trash/TrashAttachment
.
Back to: TWikiFAQ
-- PeterThoeny - 09 May 2003DONTNOTIFYCHECKBOX
preferences variable. See TWikiPreferences for more.DragonSkin.zip
in your twiki installation directory
Description: | Prosaic but relatively organized look-and-feel, while providing easy access to TWiki tools |
Screenshot: | |
Base Name: | dragon |
Skin Author: | TWiki:Main/ClaussStrauch |
Skin Version: | 27 Jul 2004 (v1.000) |
Change History: | |
27 Jul 2004: | Initial version (v1.000) |
Dependencies: | |
Skin Home: | http://TWiki.org/cgi-bin/view/Plugins/DragonSkin |
Feedback: | http://TWiki.org/cgi-bin/view/Plugins/DragonSkinDev |
Web | TWiki Site Map | Use to... |
---|---|---|
Main |
The Main web is dedicated to the maintenance of this website. This is the place to discuss meta-issues such as what style to use, how best to organize a survey, what the ideal topic size is, how to refer to papers, what the preferred layout of the site should be, etc. | ... |
TWiki |
Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs... | ...discover TWiki details, and how to start your own site. |
Gmt |
Generative Model Transformer | |
Gpce |
||
Octave |
The Stratego web is the home of Stratego, a language for program transformation based on the paradigm of rewriting strategies. The aim of this language is to provide an expressive and declarative language for expressing all kinds of program transformations. The web includes publications on Stratego, download of the StrategoCompiler, documentation, and descriptions of applications. | ... |
Sandbox |
Sandbox test area with all features enabled. | ...experiment in an unrestricted hands-on web. |
Sdf |
The Sdf web is dedicated to the modular syntax definition formalism SDF. Here you can find implementations, pointers to download pages, syntax definitions for common languages, discussions about new features and implementatios of SDF, and tips and tricks for using the formalism. | ... |
SdfBackup |
The Sdf web is dedicated to the modular syntax definition formalism SDF. Here you can find implementations, pointers to download pages, syntax definitions for common languages, discussions about new features and implementatios of SDF, and tips and tricks for using the formalism. | ... |
Stratego |
The Stratego web is the home of Stratego, a language for program transformation based on the paradigm of rewriting strategies. The aim of this language is to provide an expressive and declarative language for expressing all kinds of program transformations. The web includes publications on Stratego, download of the StrategoCompiler, documentation, and descriptions of applications. | ... |
Sts |
The Sofware Transformation Systems wiki | |
Tiger |
Home of the Tiger in Stratego project, which is concerned with the exploration of transformation techniques in compilation using an implementation of a Tiger compiler. | ... |
Tools |
The Tools web is the home of the XT? bundle of program transformation tools. XT is an open framework for program transformation based on the ATerm format for exchange of programs between tools. The bundle includes packages for parsing, pretty-printing, term rewriting, and grammar recovery. It also contains a distribution of the SDF2? GrammarBase?. The OnlinePackageBase is an open collection of packages for program transformation supporting package bundling on demand. | ... |
Transform |
The Transform web is an attempt to get an overview of program transformation research and application. In the first place the web is a collection of resources such as pointers to researchers, conferences, journals, summaries and reviews of papers, and tools for implementing transformation systems. In the second place the Transform web attempts to bring structure in the world of program transformation by means of categories, taxonomies such as the TransformationTaxonomy, and entry points such as the ReengineeringWiki and the DeCompilation page. | ... |
You can use color coding by web for identification and reference. This table is updated automatically based on WebPreferences settings of the individual webs. Contact webmaster@strategoxt.org if you need a separate collaboration web for your team. |
Legend of icons: |
= Go to the home of the web = Search the web |
= See recent changes in the web = Subscribe to get notified of changes by e-mail |
%EDITTABLE{...}%
variable. Each column can be a text field, a drop down box, a date field, etc. Multiple tables per topic are editable, but only one at a time can be edited.
%EDITTABLE{...}%
variable just before an existing table to make it editable, or add the variable anywhere in a topic to start a new table. Parameters:
Parameter | Comment | Default |
---|---|---|
header | Specify the header format of a new table like "|*Food*|*Drink*|" . Useful to start a table with only a button | (no header) |
format | The format of one column when editing the table. A cell can be a text input field, or any of these edit field types: - Text input field (1 line): | text, <size>, <initial value> | - Textarea input field: | textarea, <rows>x<columns>, <initial value> | - Drop down box: | select, <size>, <option 1>, <option 2>, etc | - Fixed label: | label, 0, <label text> | - Row number: | row, <offset> | - Date: | date, <size>, <initial value>, <DHTML date format> | | "text, 16" for all cells |
changerows | Rows can be added and removed if "on" ;Rows can be added but not removed if "add" | CHANGEROWS Plugin setting |
quietsave | Quiet Save button is shown if "on" , hidden if "off" | QUIETSAVE Plugin setting |
include | Other topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place. | (none) |
helptopic | Topic name containing help text shown below the table when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% variables can be used in the topic to specify what is shown. | (no help text) |
headerislabel | Table header cells are read-only (labels) if "on" ; header cells can be edited if "off" or "0" | "on" |
editbutton | Set edit button text, e.g. "Edit this table" ; set button image with alt text, e.g. "Edit table, %PUBURL%/%TWIKIWEB%/TWikiDocGraphics/edittopic.gif" ; hide edit button at the end of the table with "hide" (Note: Button is automatically hidden if an edit button is present in a cell) | EDITBUTTON Plugin setting |
<initial value>
(of text input field) and <label text>
(of fixed label) get expanded when a new row is added. This can be used for example to add a timestamp to a label. You can escape characters if you do not want that:
Text: | To Escape: |
---|---|
$quot | Double quote (" ). Alternatively write \" to escape it |
$percnt | Percent sign (% ) |
$dollar | Dollar sign ($ ) |
$nop or $nop() | Is a "no operation" |
date
field type allows one to choose a date with a popup calendar. Popup calendar works for Netscape 6.0 or better, all other Gecko-based browsers, Internet Explorer 5.0 or better for Windows, Opera 7 and Konqueror 3.1.2. The ...
button is inactive if the browser cannot support the popup calendar. It uses the nice Mishoo DHTML calendar, see also TWiki:Codev/JavaScriptDatePickerForForm %EDITCELL{ "type, ..." }%
variable at the end of the cell content. This is useful to override the per column %EDITTABLE{ format="..." }%
settings, or to create tables with key/value rows. All edit field types of the format="..."
parameter are supported. For example, to define a text field, type: | cell content %EDITCELL{ "text, 20" }% |
It is also possible to place the edit button inside a cell instead of default location below the table. Type | %EDITCELL{ "editbutton, 1, Edit this table" }% |
to show a button, or | %EDITCELL{ "editbutton, 1, Edit table, Image-URL" }% |
to show a button image with alternate text.
Note: The %EDITCELL{ }%=variable cannot be used by itself; place an =%EDITTABLE{ }%=variable at the beginning of a table where you want to use =%EDITCELL{ }%
variables.
%EDITTABLE{ header="|*Nr*|*Text field sandbox*|*Drop down sandbox*|*Timestamp*|" format="| row, -1 | text, 20, init | select, 1, one, two, three, four | label, 0, %SERVERTIME{"$day $mon $year $hour:$min"}% |" changerows="on" }%
Note: Please use TWiki:Sandbox.EditTablePluginTesting if you want to try out this Plugin
If this plugin is installed you will see an [ Edit table ] button above; if you were to click on it (please don't, use TWiki:Sandbox.EditTablePluginTesting for testing) you get this form:
The following example shows a simple table with key/value rows. The default edit field type for the value column is a text field. This is overloaded by a selector for the Gender, and a date picker for the DOB. This is typically used by TWiki applications where new topics with tables are created based on a template topic.
You type:
%EDITTABLE{ format="| label | text, 40 |" }% |*Key*|*Value*| | Name: | John Smith | | Gender: | M %EDITCELL{select, 1, , F, M}% | | DOB: | 1999/12/31 %EDITCELL{date, 10}% | | City: | New York | | Screenshot: | Screenshot in edit mode: |
%<plugin>_<setting>%
, for example, %EDITTABLEPLUGIN_SHORTDESCRIPTION%
data/debug.txt
. Default: 0
on
, off
, add
on
to show the Quiet Save button, off
to hide
button text
, or specify alternate text, image URL
calendar-<code>.js
language file: en
, af
, br
, ca
, cs-win
, da
, de
, du
, el
, es
, fr
, hr
, hr-utf8
, hu
, it
, jp
, nl
, no
, pl
, pt
, ro
, ru
, sk
, sp
, sv
, tr
, zh
JSCALENDAR*
settings first in the TWiki Preferences, then in above Plugin settings
| ... ||
) and cell justification (e.g. | centered | right |
)
%ATTACHURL%
get expanded unless they are in a label
%EDITTABLE{}%
statements on the same line in the source
select,1,%<nop>X%,%<nop>Y%
EditTablePlugin.zip
in your twiki installation directory. Content:
File: | Description: |
---|---|
data/TWiki/EditTablePlugin.txt | Plugin topic |
data/TWiki/EditTablePlugin.txt,v | Plugin topic repository |
lib/TWiki/Plugins/EditTablePlugin.pm | Plugin Perl module |
pub/TWiki/EditTablePlugin/edittable.gif | Edit table button image |
pub/TWiki/EditTablePlugin/*.gif | Screenshots and Mishoo DHTML calendar images |
pub/TWiki/EditTablePlugin/README | Mishoo DHTML calendar README |
pub/TWiki/EditTablePlugin/release-notes.html | Mishoo DHTML calendar release notes |
pub/TWiki/EditTablePlugin/*.js | Mishoo DHTML calendar JavaScript files |
pub/TWiki/EditTablePlugin/calendar-system.css | Mishoo DHTML calendar stylesheet |
viewauth
script to authenticate the user. As described in TWikiAccessControl, copy the view
script to viewauth
(or better, create a symbolic link) and add viewauth
to the list of authenticated scripts in the .htaccess
file.
Plugin Author: | TWiki:Main/PeterThoeny |
Plugin Version: | 01 Aug 2004 |
Change History: | |
01 Aug 2004: | Fixed bug where edittable did not work if at the end of a topic |
07 Apr 2004: | Fixed bug where two tables got updated when you edit and save a table included into a topic containing other edit tables |
02 Mar 2004: | Default for %EDITCELL{editbutton}% is EDITBUTTON preference |
27 Feb 2004: | Added QUIETSAVE setting and quietsave parameter; image for Edit button |
18 Feb 2004: | Doc fixes; allow edit button anywhere in a cell not just at the end of a cell |
17 Feb 2004: | Added per cell definition of edit field types with %EDITCELL{}% variable; added headerislabel and editbutton parameters |
20 Dec 2003: | Fixed bug where calendar did not work after adding a row (TWiki:Main/PaulineCheung); added all language files of Mishoo DHTML calendar 0.9.5 |
13 Dec 2003: | Added CHANGEROWS, JSCALENDARDATEFORMAT, JSCALENDARLANGUAGE, JSCALENDAROPTIONS settings |
16 Oct 2003: | small typo fixed (garbled if ---+ header on top) |
15 Oct 2003: | new date field type with javascript calendar - CN |
14 Oct 2003: | docfix: the documentation page was an old one - CN |
13 Oct 2003: | bugfix: %-vars in select were resetted to first on add/del row - CN |
18 Sep 2003: | incompatibility: changed default of changerows to on ; support for %-vars, Quiet save for saving without notification; all other fixes in Dev topic integrated - CN |
08 Nov 2002: | Prevent variable expansion in label text; added escape characters |
27 Jun 2002: | New helptopic parameter |
26 Jun 2002: | Support for variables in included EDITTABLE parameters; fixed problem with HTML in cells |
21 May 2002: | Added fixed label format; new changerows="add" parameter |
27 Apr 2002: | Fixed bug where text after a double quote in a cell disappeared |
18 Apr 2002: | Fixed bug where table was breaking when pasting multiple lines into an edit field using Netscape on Unix |
08 Apr 2002: | Check for change permission and edit lock of topic |
05 Apr 2002: | Initial version |
CPAN Dependencies: | none |
Other Dependencies: | Mishoo DHTML calendar (version 0.9.5 preinstalled); TWiki version 01 Feb 2003 or later |
Perl Version: | 5.0 |
TWiki:Plugins/Benchmark: | GoodStyle 98%, FormattedSearch 98%, EditTablePlugin 95% |
Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/EditTablePlugin |
Feedback: | http://TWiki.org/cgi-bin/view/Plugins/EditTablePluginDev |
TWiki/Plugins/EmptyPlugin.pm
to <name>Plugin.pm
and customize the plugin.
<name>Plugin
topic in the TWiki web. Do so by visiting http://TWiki.org/cgi-bin/view/Plugins/ and starting a new topic to get the default plugin topic text (don't save the topic). Customize your plugin topic to your needs.
%<plugin>_<setting>%
, i.e. %EMPTYPLUGIN_SHORTDESCRIPTION%
data/debug.txt
)
Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
Plugin Version: | 21 Mar 2003 |
Change History: | |
21 Mar 2004: | Added afterSaveHandler |
14 Jul 2001: | Changed to plug&play |
27 Feb 2001: | Initial version |
CPAN Dependencies: | none |
Other Dependencies: | none |
Perl Version: | 5.0 |
TWiki:Plugins/Benchmark: | GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99% |
Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin |
Feedback: | http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev |
Attach
link at the bottom of the page. The Attach
screen lets you browse for a file, add a comment, and upload it. The uploaded file will show up in the File Attachment table.
*.php
files are renamed to *.php.txt
so that no one can place code that would be read in a .php file.
%ATTACHFILESIZELIMIT%
variable of the TWikiPreferences, currently set at 100000 KB.
Manage
on the Attachment to be moved.
Move
. The attachment and its version history are moved. The original location is stored as topic Meta Data.
Trash
, topic TrashAttachment
.
Attach
file: Sample.txt
Edit
topic and enter: %ATTACHURL%/Sample.txt
Preview
: %ATTACHURL%/Sample.txt
text appears as: /pub/TWiki/FileAttachment/Sample.txt, a link to the text file.
%PUBURL%/%WEB%/OtherTopic/Sample.txt
(if it's within the same web)
%PUBURL%/Otherweb/OtherTopic/Sample.txt
(if it's in a different web)
Attach
file: Sample.txt
Edit
topic and write text: %INCLUDE{"%ATTACHURL%/Sample.txt"}%
Attach
file: Smile.gif
Edit
topic and write text: %ATTACHURL%/Smile.gif
Preview
: text appears as /pub/TWiki/FileAttachment/Smile.gif, an image.
Attachment Action Size Date Who Comment Sample.txt manage 0.1 K 22 Jul 2000 - 19:37 PeterThoeny Just a sample Smile.gif manage 0.1 K 22 Jul 2000 - 19:38 PeterThoeny Smiley face
Manage
link takes you to a new page that looks like this:
h
means the attachment is hidden, it isn't listed when viewing a topic.
Hide file
checkbox, then click Change properties
.
%SEARCH{...}%
variable documented in TWikiVariables has a fixed format for the search result, that is, a table consisting of topic names and topic summaries. Use the format="..."
parameter to specify a customized format of the search result. The string of the format parameter is typically a bullet list or table row containing variables (such as %SEARCH{ "food" format="| $topic | $summary |" }%
).
header="..."
parameter
Use the header parameter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional. header="| *Topic:* | *Summary:* |"
2. format="..."
parameter
Use the format parameter to specify the format of one search hit.
format="| $topic | $summary |"
Variables that can be used in the format string:
Name: | Expands To: |
---|---|
$web | Name of the web |
$topic | Topic name |
$topic(20) | Topic name, "- " hyphenated each 20 characters |
$topic(30, -<br />) | Topic name, hyphenated each 30 characters with separator "-<br />" |
$topic(40, ...) | Topic name, shortended to 40 characters with "..." indication |
$parent | Name of parent topic; empty if not set |
$parent(20) | Name of parent topic, same hyphenation/shortening like $topic() |
$text | Formatted topic text. In case of a multiple="on" search, it is the line found for each search hit. |
$locked | LOCKED flag (if any) |
$date | Time stamp of last topic update, e.g. 24 Jul 2020 - 17:48 |
$isodate | Time stamp of last topic update, e.g. 2020-07-24T17:48Z |
$rev | Number of last topic revision, e.g. 1.4 |
$username | Login name of last topic update, e.g. jsmith |
$wikiname | Wiki user name of last topic update, e.g. JohnSmith |
$wikiusername | Wiki user name of last topic update, like Main.JohnSmith |
$createdate | Time stamp of topic revision 1.1 |
$createusername | Login name of topic revision 1.1, e.g. jsmith |
$createwikiname | Wiki user name of topic revision 1.1, e.g. JohnSmith |
$createwikiusername | Wiki user name of topic revision 1.1, e.g. Main.JohnSmith |
$summary | Topic summary |
$formname | The name of the form attached to the topic; empty if none |
$formfield(name) | The field value of a form field; for example, $formfield(TopicClassification) would get expanded to PublicFAQ . This applies only to topics that have a TWikiForm |
$formfield(name, 10) | Form field value, "- " hyphenated each 10 characters |
$formfield(name, 20, -<br />) | Form field value, hyphenated each 20 characters with separator "-<br />" |
$formfield(name, 30, ...) | Form field value, shortended to 30 characters with "..." indication |
$pattern(reg-exp) | A regular expression pattern to extract some text from a topic (does not search meta data; use $formfield instead). In case of a multiple="on" search, the pattern is applied to the line found in each search hit.• Specify a RegularExpression that covers the whole text (topic or line), which typically starts with .* , and must end in .* • Put text you want to keep in parenthesis, like $pattern(.*?(from here.*?to here).*) • Example: $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ... • This example has non-greedy .*? patterns to scan for the first occurance of the Email bullet; use greedy .* patterns to scan for the last occurance • Limitation: Do not use .*) inside the pattern, e.g. $pattern(.*foo(.*)bar.*) does not work, but $pattern(.*foo(.*?)bar.*) does • Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag |
$n or $n() | New line |
$nop or $nop() | Is a "no operation". This variable gets removed; useful for nested search |
$quot | Double quote (" ). Alternatively write \" to escape it |
$percnt | Percent sign (% ) |
$dollar | Dollar sign ($ ) |
%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header=" * *Topic: Summary:*" format=" * [[$topic]]: $summary" }%
To get this:
TopicClassification
field, an OperatingSystem
field and an OsVersion
field we could write:
| *Topic:* | *OperatingSystem:* | *OsVersion:* |
%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem) | $formfield(OsVersion) |" }%
To get this:
Topic: | OperatingSystem: | OsVersion: |
---|---|---|
IncorrectDllVersionW32PTH10DLL | OsWin | 95/98 |
WinDoze95Crash | OsWin | 95 |
%SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" regex="on" nosearch="on" nototal="on" header="TWiki FAQs:" format=" * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }%
To get this:
TWiki FAQs:
%SEARCH{ "culture" format=" * $topic is referenced by: (list all references)" nosearch="on" nototal="on" }%
%SEARCH{ "(topic found in first search)" format="$topic" nosearch="on" nototal="on" separator=", " }%
$percnt
to escape the leading percent of the second search
\"
to escape the double quotes
$dollar
to escape the $
of $topic
$nop
to escape the }%
sequence
%SEARCH{ "culture" format=" * $topic is referenced by:$n * $percntSEARCH{ \"$topic\" format=\"$dollartopic\" nosearch=\"on\" nototal=\"on\" separator=\", \" }$nop%" nosearch="on" nototal="on" }%
To get this:
$dollarpercntSEARCH{
for level three, $dollardollarpercntSEARCH{
for level four, etc.
%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on" format="| [[$topic]] | $wikiusername | $date |" limit="7" }%
To get this:
WebStatistics | TWikiGuest | 18 Oct 2016 - 16:57 |
CustomWebMenus | EelcoVisser | 25 Apr 2005 - 19:37 |
CustomSiteMenus | MartinBravenboer | 04 Dec 2004 - 17:12 |
AppendixFileSystem | PeterThoeny | 30 Aug 2004 - 07:14 |
AccessKeys | PeterThoeny | 28 Aug 2004 - 05:53 |
ATasteOfTWiki | PeterThoeny | 22 Aug 2004 - 21:49 |
AdminTools | PeterThoeny | 15 Aug 2004 - 06:58 |
%CALC{$SET(weekold, $TIMEADD($TIME(), -7, day))}%
%SEARCH{ "." scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on" format="$percntCALC{$IF($TIME($date) < $GET(weekold), <nop>, | [[$topic]] | $wikiusername | $date | $rev |)}$percnt" limit="100" }%
weekold
variable to the serialized date of exactly one week ago
$percnt
makes sure that the CALC gets executed once for each search hit
weekold
date
<nop>
is returned, which gets removed at the end of the TWiki rendering process
%URLPARAM{"..."}%
variable. Example:
Write this:
<form action="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/TWiki/FormattedSearch"> Find Topics: <input type="text" name="q" size="32" value="%URLPARAM{"q"}%" /> <input type="submit" value="Search" /> </form> Result: %SEARCH{ search="%URLPARAM{"q"}%" format=" * $web.$topic: %BR% $summary" nosearch="on" }%To get this: Result: Number of topics: 0 -- TWiki:Main.PeterThoeny - 26 Jul 2004