RHUL Physics department TWiki and Particle Physics Unix Registration TWiki registration If you are a member of the RHUL Physics department, please login using...
The place to learn about TWiki features and perform TWiki system maintenance. TWiki is a flexible, powerful, secure, yet simple Enterprise Wiki and Web Application...
Release Notes of TWiki 6.1.0 (Kampala), 2018 07 16 Introduction TWiki is an enterprise collaboration platform and application platform. TWiki has been downloaded...
TWiki Sheet Plugin Introduction The TWiki Sheet Plugin turns a TWiki table into a spreadsheet that can be modified right in the browser. TWiki Sheet looks and feels...
TWiki Source Code Packages This documentation is automatically generated from the pod , so it always matches the running code TWiki::AccessControlException Exception...
Search Results Pagination When a % SEARCH{... returns many results, you may want to paginate the results. Overview You can achieve search results pagination by...
TWiki User Reports This page contains user reports you can use in TWiki application. Create appealing TWiki applications in a no time! Reports are of format % USERREPORT...
Search Help Search Pages There are two search pages; WebSearch offers basic search features, while WebSearchAdvanced offers more control over searches. By default...
Notes: Do not edit this topic, it is updated automatically. TWikiSiteTools explains how to enable automatic updates of the statistics pages. Related...
FOURCOLUMNS responsive four column page layout Write % FOURCOLUMNS% ...text... % ENDCOLUMNS% to get a page layout with four columns . The layout is responsive...
ENDCOLUMNS end a responsive multi column page layout Write % TWOCOLUMNS% ...text... % ENDCOLUMNS% to get a page layout with two columns . See TWOCOLUMNS...
SET{`name` value `...`} set a variable Set a named variable that can be retrieved later with % GET{ . No output is shown, e.g. % SET{ resolves to an empty...
Metadata Repository Motivation If you have hundreds or thousands of webs on a TWiki site, web metadata stored in a data repository is useful. It can...
Web Changes Notification Service 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...
SPACEOUT{`string`} renders string with spaces inserted in sensible places Inserts spaces between word components. Word component boundaries are transitions from...
Welcome, ! Welcome to RHUL Physics Department TWiki! This is a TWikiSite (pronounced twee kee site ), a meeting place to work on common interests. Anyone can...
JQENDTABPANE end a JQuery tab pane This variable is handled by the JQueryPlugin. For description see JQTABPANE Syntax: % JQTABPANE% % JQTAB{`Tab 1` ......
Package TWiki::Render This module provides most of the actual HTML rendering code in TWiki. ClassMethod new ($session) Creates a new renderer ObjectMethod finish...
Package TWiki::Form Object representing a single form definition. Form definitions are mainly used to control rendering of a form for editing, though there is some...
HIDE{text} hide content in topic view Text inside the HIDE is removed when viewing the topic. This can be used to remove large amounts of text from being sent...
MAKETEXT translate text using TWiki`s I18N infrastructure Text in MAKETEXT is translated into another language at page view time if the user activates a...
Package TWiki::Configure::UIs::EXTEND StaticMethod unpackArchive ($archive ,$dir ) Unpack an archive. The unpacking method is determined from the file extension...
Package TWiki::Form::Select getDefaultValue() $value The default for a select is always the empty string, as there is no way in TWiki form definitions to indicate...
Package TWiki::LoginManager::Session Class to provide CGI::Session like infra structure, compatible with TWiki Runtime Engine mechanisms other than CGI. It inherits...
Package TWiki::Store::SearchAlgorithms::PurePerl Pure perl implementation of the RCS cache search. StaticMethod search ($searchString,$topics,$options,$sDir)...
Package TWiki::Mdrepo ClassMethod new ($session) Construct a Mdrepo module. It`s a caller`s responsibility to guarantee all of the followings defined: $TWiki...
Package TWiki::Meta All TWiki topics have data (text) and meta data (information about the topic). Meta data includes information such as file attachments, form...
Package TWiki::OopsException Exception used to raise a request to redirect to an Oops URL. An OopsException thrown anywhere in the code will redirect the browser...
Package TWiki::Access A singleton object of this class manages the access control database. Dynamic access control and permission caching As TWiki:Codev/DynamicAccessControl...
GROUPS a formatted list of groups Expands to a formatted list of user groups in your RHUL Physics Department TWiki. The variable is intended to be used in .TWikiGroups...
Bookmarks Application Page This page contains several parts that are used by user bookmark pages. Bookmark pages reside in the web and are named wikiname Bookmarks...
PARENTBC parent breadcrumbs for headings Add % PARENTBC% to a heading of a topic to show the breadcrumb of its parents. Parent topics are linked, topic names...
Instant TWiki Site Enhancements These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators are especially encouraged...
References on Wiki and Collaboration Some useful articles and books around collaboration and the Wiki technology in particular. Wiki Technology and TWiki Presentation...
SITESTATISTICSTOPIC name of site statistics topic Note: The site statistics topic is assumed to be in the web. Syntax: % SITESTATISTICSTOPIC% Expands...
ADDTOHEAD add HTML to the HTML head section of the current page Useful for TWiki applications to add custom CSS or JavaScript to the HTML head section of a topic...
Settings for WysiwygPlugin that are common to most editor integrations WYSIWYG EXCLUDE Prevent WYSIWYG editing The global preference setting WYSIWYG EXCLUDE...
TWiki Plugins Add functionality to TWiki with readily available plugins; create plugins based on APIs Overview You can add plugins to extend TWiki functionality...
TWiki Reference Manual () This page contains all documentation topics as one long, complete reference sheet. Related Topics: TWikiSite, TWikiHistory, TWikiEnhancementRequests...
Page Rendering Process Overview of how TWiki works To achieve a goal in TWiki either by making use of existing features or implementing new features, good understanding...
Include Topics and Web Pages Using % INCLUDE{... Variable Use the % INCLUDE{... variable to embed the content of another topic or web page inside a TWiki topic...
`Create New Topic` page has moved Continue to create the new page TWiki admins Please replace all web`s WebTopicCreator topic contents with this text: % `WebTopicCreator...
Search Pattern Cookbook The Search function in TWiki is very powerful. Especially searches using a RegularExpression play an important part of tapping TWiki`s full...
TWiki Variables Search TWiki Variables Show all Category Categories: Related Topics: UserDocumentationCategory, TWikiVariables, TWikiVariablesWizard...
MDREPO retrieve data from metadata repository Attention: This variable works only if MetadataRepository is in use. Otherwise, it always returns a zero length...
CALC{`formula`} add spreadsheet calculations to tables The % CALC{formula variable is handled by the SpreadSheetPlugin. Over 100 functions are available, such...
Release Notes of TWiki 5.1.4 (Istanbul), 2013 02 16 Introduction TWiki is an enterprise collaboration platform and application platform. TWiki has been downloaded...
USERREPORT show user reports with profile pictures Show various user reports documented in UserReports Syntax: % USERREPORT{ action `...` ... Overview...
RSS news feed of topic changes You can use an RSS news reader to find out what is new in a TWiki web. This complements WebChanges that shows recent changes in...
DATEPICKER{} pop up calendar to select a date for use in HTML forms The % DATEPICKER{ variable is handled by the DatePickerPlugin. Syntax: % DATEPICKER...
CONTENTMODE{web `WEB`} content mode Returns the content mode of the specified web. It`s either `local`, `read only`, `master`, or `slave`. Read ReadOnlyAndMirrorWebs...
LIME start lime colored text LIME is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
TEAL start teal colored text TEAL is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in...
BROWN start brown colored text BROWN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings...
WIKIUSERSTOPIC name of topic listing all registers users Syntax: % WIKIUSERSTOPIC% Expands to: , with prefix renders as . Category: SystemInformationVariables...
WIKILOGOALT site logo tooltip message Syntax: % WIKILOGOALT% Expands to: Defined in: TWikiPreferences Category: AdministrationVariables, SystemInformationVar...
USERINFO{`name`} retrieve details about a user Syntax: % USERINFO% Expands to: (comma separated list of the username, wikiusername, and emails) With...
STOPINCLUDE end position of topic text if included If present in included topic, stop to include text at this location and ignore the remaining text. A normal...
STARTSECTION marks the start of a section within a topic Section boundaries are defined with % STARTSECTION{ and % ENDSECTION{ . Sections may be given...
STARTINCLUDE start position of topic text if included If present in included topic, start to include text from this location up to the end, or up to the location...
SPACEDTOPIC topic name, spaced and URL encoded deprecated The current topic name with added URL encoded spaces, for use in regular expressions that search for...
SESSIONID unique ID for this session Syntax: % SESSIONID% Expand to: Category: DevelopmentVariables, SystemInformationVariables, UsersAndAuthenticationVariables...
RED start red colored text RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that...
REDBG start red colored background section REDBG is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut...
QUERYSTRING full, unprocessed string of parameters to this URL String of all the URL parameters that were on the URL used to get to the current page. For example...
QUERYPARAMS show paramaters to the query Expands the parameters to the query that was used to display the page. Syntax: % QUERYPARAMS{... Parameters...
PLUGINDESCRIPTIONS list of plugin descriptions Syntax: % PLUGINDESCRIPTIONS% Expands to: Category: AdministrationVariables, SystemInformationVariables...
LOGOUTURL present a logout link Present a logout link, regardless of the state of login Syntax: % LOGOUTURL% Expand to: Category: LinkingAndNavigationVariables...
LOCALSITEPREFS web.topicname of site preferences topic The full name of the local site preferences topic. These local site preferences overload the system level...
LOGINURL present a login link Present a login link, regardless of the state of login Syntax: % LOGINURL% Expand to: Category: LinkingAndNavigationVariables...
ICONURL{`name`} URL of small documentation graphic or icon Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image. The related...
FAILEDPLUGINS debugging for plugins that failed to load, and handler list Syntax: % FAILEDPLUGINS% Expands to: See TWikiPlugins#FAILEDPLUGINS Category...
ENV{`varname`} inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment...
ENDCOLOR end colored text ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic...
EDITACTION select an edit template EDITACTION defined in a topic or preference setting will define the use of an editaction template instead of the standard edit...
DISPLAYTIME{`format`} formatted display time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure, default...
ATTACHURLPATH path of the attachment URL of the current topic Syntax: % ATTACHURLPATH% Expands to: /twiki/pub/TWiki/VarATTACHURLPATH Category: AttachmentsAndFilesV...
ACTIVATEDPLUGINS list of currently activated plugins Syntax: % ACTIVATEDPLUGINS% Expands to: Category: AdministrationVariables, DevelopmentVariables...
SpreadSheetPlugin for dynamic content The SpreadSheetPlugin offers 100 functions. Functions are evaluated at page view time. A formula can be placed anywhere in a...
TWiki Meta Data Additional topic data, program generated or from TWikiForms, is stored embedded in the topic text using META: tags Overview By default, TWiki...
Package TWiki::UserMapping This is a virtual base class (a.k.a an interface) for all user mappers. It is not useable as a mapping in TWiki use the BaseUserMapping...
Package TWiki::Users::Password Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like. The methods of this class...
This is a short introductory training course for TWiki beginners. A Taste of TWiki The basic function of TWiki is a Wiki (if that helps!) A Wiki is like a web site...
Default Web Top Menu of TopMenuSkin This topic defines the default menu structure of a web. It is used by the TopMenuSkin in case the WebTopMenu topic is missing in...
Color scheme settings for .PatternSkin Use this topic to change the color settings of .PatternSkin. When this topic is saved, the attachment theme colors.css will...
Wiki Name Your name, usually your first and last name connected without a space. For example, Tim Berners Lee`s WikiName is TimBernersLee. Your name is also...
Manage Users Register users on your TWiki site; change/reset/install passwords; remove user accounts Some of the features below may be disabled, depending on your...
TWiki Release 4.2.4 (Freetown), 2008 12 06 Note: This is the release note for the previous major release version 4.2.X. This note, TWikiReleaseNotes04x00 and...
Release Notes of TWiki 5.0.2 rc1 (Helsinki), 2011 04 21 Introduction TWiki 5.0.0 released on 2010 05 29 is a major release introducing usability enhancements, feature...
Package TWiki::Search This module implements all the search functionality. ClassMethod new ($session) Constructor for the singleton Search engine object. ObjectMethod...
Parameterized Variables (Macros) It is possible to pass parameters to TWiki variables. This is called a macro in a programming language. To define a parameterized...
Release Notes of TWiki 4.3.2 (Georgetown), 2009 09 02 Note: This is the release note for the previous major release version 4.3.X. This note, TWikiReleaseNotes04x...
Hierarchical Navigation Navigation block that displays the current topic, its parent and children (if any). This is intended to be included in other topics, for...
Keyword search Interactive search uses keyword search by default. For example, to search for all topics that contain `SOAP`, `WSDL`, a literal `web service`, but not...
Edit tables with EditTablePlugin The EditTablePlugin allows you to edit TWiki tables using edit fields and drop down boxes. Tables have an Edit button if...
Commenting with hidden text To hide some text within a TWiki topic, use HTML comments. Example comment within a sentence: Visible ! and hidden text Example...
TWiki Skins Skins overlay regular templates with alternate header/footer layouts. You can use Skins to change the look of a TWiki topic, for example, the layout of...
Disabling individual WikiWords Prevent a WikiWord from being linked by prefixing it with an exclamation point. Example: To escape SunOs write SunOs to get SunOs...
The Jump Box as a browser The JumpBox is not only a tool to allow you to jump from page to page, you can use it to search for documents. If you do not know the entire...
Creating a Table of Contents The TWiki variable % TOC% will automatically create a table of contents for a topic based on the headings of the topic. To exclude a...
TWiki Contributor 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...
Class Method A ClassMethod is a method that must be called relative to the containing class object. This normally only applies to the new method used to create new...
Use the `Minor changes, don`t notify` checkbox when saving a page in case you only make a minor change to a topic and you do not want to inform everybody who is on...
List of RHUL Physics Department TWiki Users Below is a list of users with accounts. If you want to edit topics or see protected areas of the site then you can...
TWiki Syntax Summary This page provides online help for new TWiki users when editing a page. If there`s some formatting that your contributors use often, you can...
Template Web Purpose Template webs contain a set of default topics and act as templates when creating a new web. Names of template webs begin with an underscore...
FAQ: I would like to install TWiki on my server. Can I get the source? Answer: TWiki is distributed under the GnuGeneralPublicLicense. You can get the source from...
Package TWiki::Plugins This module defines the singleton object that handles Plugins loading, initialization and execution. This class uses Chain of Responsibility...
Package TWiki::EngineException Exception used to raise an engine related error. This exception has the following fields: status status code to send to client...
Jump Box The Jump Box at the top or sidebar of each page is a hidden gem for quick navigation in a large TWiki. 1. Quick Jump: Enter a topic name to quickly jump...
Package TWiki::Infix::Parser A simple stack based parser that parses infix expressions with nonary, unary and binary operators specified using an operator table....
Package TWiki::Store::RcsWrap This package does not publish any methods. It implements the virtual methods of the TWiki::Store::RcsFile superclass. Wrapper around...
Package TWiki::Query A Query object is a representation of a query over the TWiki database. Fields are given by name, and values by strings or numbers. Strings should...
Package TWiki::Attach A singleton object of this class is used to deal with attachments to topics. ClassMethod new ($session) Constructor. ObjectMethod finish...
Package TWiki::Query::HoistREs Static functions to extract regular expressions from queries. The REs can be used in caching stores that use the TWiki standard inline...
Package TWiki::UI::View UI delegate for view function StaticMethod view ($session) view command handler. This method is designed to be invoked via the UI::run...
Package TWiki::Sandbox This object provides an interface to the outside world. All calls to system functions, or handling of file names, should be brokered by this...
Package TWiki::Store::QueryAlgorithms::BruteForce Default brute force query algorithm Has some basic optimisation: it hoists regular expressions out of the query...
Package TWiki::AccessControlException Exception used raise an access control violation. This exception has the following fields: web the web which was being...
Package TWiki::LineIterator Iterator over the lines in a file new( $file ) Create a new iterator over the given file. if the file cannot be opened, then there will...
Package TWiki::UI::Statistics Statistics extraction and presentation StaticMethod statistics ($session) statistics command handler. This method is designed to...
TWiki Contribs Reusable code that may be used over several plugins and add ons. Overview TWiki contribs extend the functionality of TWiki, typically used by plugins...
FAQ: What does the `T` in TWiki stand for? Answer: TWiki is short for TakeFive Wiki, the name of the company where its founder Peter Thoeny worked. Peter first...
PatternSkinCssCookbook Recipe: EditTable style Cookbook example to illustrate control over EditTable edit styles. 1 EditTable uses a monospace font in edit mode...
PatternSkinCssCookbook Recipe: Font variation Cookbook example with other fonts and font colors. This line loads the extra style definition: Set USERSTYLEURL...