Difference: TWikiPreferences (89 vs. 90)

Revision 902015-09-02 - TWikiGuest

Line: 1 to 1
 

Daya Bay Site-Level Preferences

Changed:
<
<
This topic defines site-level settings that apply to all users and webs on this TWikiSite.
>
>
This topic defines site-level settings that apply to all users and webs on this TWikiSite.
 
ALERT! NOTE: Don't edit this topic, changes will be lost on the next TWiki upgrade. Define new site-level settings, or overload below settings in Public.TWikiPreferences

Preference settings local to your site should be set in Public.TWikiPreferences (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in Public.TWikiPreferences will override settings in this topic, and should be used for defining custom settings and variables.

Changed:
<
<
Read more on how to set Preferences Variables.
>
>
Read more on how to set Preferences Variables.
 

Default Web Preferences

Changed:
<
<
ALERT! NOTE: These are just defaults; don't change them here. Instead, add them to the WebPreferences topic in each web
>
>
ALERT! NOTE: These are just defaults; don't change them here. Instead, add them to the TWiki.WebPreferences topic in each web
 
  • List of selected topics in a web (used in menus)
Changed:
<
<
>
>
 
  • Web-specific background color: (is overwritten by web preferences)
    • Set WEBBGCOLOR = #FFD8AA
Changed:
<
<
>
>
 
    • Set FAVICON = /twiki/pub/Sandbox/WebPreferences/favicon.ico

  • Image, URL and alternate tooltip text of web's logo.
Line: 39 to 39
 
  • Copyright notice:
    • Set WEBCOPYRIGHT = Copyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
      Ideas, requests, problems regarding Daya Bay? Send feedback
Changed:
<
<
  • Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords)
>
>
  • Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords)
 
    • Set WEBRSSCOPYRIGHT = Copyright 2024 by contributing authors

  • Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences) Note it is much better to use TWikiAccessControls in individual webs to control who can and can't view the contents of a web. NOSEARCHALL is retained for compatibility, but you should avoid using it.
Line: 47 to 47
 
  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
    • Set NOAUTOLINK =
Changed:
<
<
    • Note: Use the [[...][...]] syntax to link topics in case you disabled WikiWord linking. The <noautolink> ... </noautolink> syntax can be used to prevents links within a block of text.
>
>
    • Note: Use the [[...][...]] syntax to link topics in case you disabled TWiki.WikiWord linking. The <noautolink> ... </noautolink> syntax can be used to prevents links within a block of text.
 
  • Use topic title instead of topic name in forced links, such as in link [[BugItem1234]]. If enabled, the link label is set to the form field named "Title", the topic preferences setting named TITLE, or the topic name if neither exists. Forced links with label such as [[BugItem1234][bug 1234]] are not affected. The topic title can be shown even with disabled flag by using syntax [[+BugItem1234]]. NOTE: Page rendering may be slower if enabled and if there are many forced links in a topic.
    • Set SHOWTOPICTITLELINK =
Changed:
<
<
  • If you use non WikiWords for topic names (for example "Expenses" or "Mighty1") and if you use bracket notation to link to those topics, it is useful to turn of all warnings (like: "WARNING: This topic name is not recommended because it will not be linked automatically") and checkboxes ("Allow non WikiWord for the new topic name"). Can be overwritten by web preferences. Set to on to activate:
>
>
  • If you use non WikiWords for topic names (for example "Expenses" or "Mighty1") and if you use bracket notation to link to those topics, it is useful to turn of all warnings (like: "WARNING: This topic name is not recommended because it will not be linked automatically") and checkboxes ("Allow non TWiki.WikiWord for the new topic name"). Can be overwritten by web preferences. Set to on to activate:
 
    • Set HIDE_NON_WIKI_WORD_WARNINGS =

  • Warn if %INCLUDE{}% of topic fails: Fail silently if empty or off. Output warning message (defined in templates/oopsalerts.tmpl) if set to on. Otherwise output specific text (use $topic for topic). You can override this in web preferences, or by using a warn="..." parameter with %INCLUDE{}% :
Line: 96 to 96
 
  • Fixed pulldown menu-bar, on or off. If on, the menu-bar is always visible at the top, regardless of the window scroll position. If off, the menu-bar hides when scrolled, and can be shown by hovering over the gray TWiki icon.
    • Set FIXEDTOPMENU = off
Changed:
<
<
  • Show tool-tip topic info on mouse-over of WikiWord links. Setting can be on, off, or customized. An empty setting or off setting disables the tool-tips (for better performance). The setting can contain $summary to show the topic summary, $date for the last change date, $rev for the revision, $username for the login name of the last editor, $wikiname for the WikiName, $wikiusername for Public.WikiName, $topic for the topic name, and $web for the web name
>
>
  • Show tool-tip topic info on mouse-over of WikiWord links. Setting can be on, off, or customized. An empty setting or off setting disables the tool-tips (for better performance). The setting can contain $summary to show the topic summary, $date for the last change date, $rev for the revision, $username for the login name of the last editor, $wikiname for the TWiki.WikiName, $wikiusername for Public.WikiName, $topic for the topic name, and $web for the web name
 
    • Set LINKTOOLTIPINFO = off
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
Changed:
<
<
  • In the user profile page, show the tag cloud instead of the watchlist changes in case the WatchlistPlugin is installed and enabled.
>
>
  • In the user profile page, show the tag cloud instead of the watchlist changes in case the WatchlistPlugin is installed and enabled.
 
    • #Local TAGCLOUDPROFILE = on

  • Horizontal size of text edit box:
Line: 112 to 112
 
  • Style of text edit box. Set to width: 99% for full window width (default; this will overwrite the EDITBOXWIDTH setting), or width: auto to disable. This setting works for IE and some other recent browsers.
    • Set EDITBOXSTYLE = width:99%
Changed:
<
<
  • Default state of the Force New Revision (ForceNewRevision) check box in preview. Check box is initially checked if Set FORCENEWREVISIONCHECKBOX = checked="checked", or unchecked if empty:
>
>
  • Default state of the Force New Revision (ForceNewRevision) check box in preview. Check box is initially checked if Set FORCENEWREVISIONCHECKBOX = checked="checked", or unchecked if empty:
 
    • Set FORCENEWREVISIONCHECKBOX =
Changed:
<
<
  • Default state of the Minor Changes, Don't Notify (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty:
>
>
  • Default state of the Minor Changes, Don't Notify (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty:
 
    • Set DONTNOTIFYCHECKBOX =

  • Default state of the link check box in the attach file page. Checkbox is initially checked if Set ATTACHLINKBOX = checked="checked", or unchecked if empty (Set ATTACHLINKBOX =). If checked, a link is created to the attached file at the end of the topic:
Line: 140 to 140
 
  • TWiki site name:
    • Set WIKITOOLNAME = TWiki
Changed:
<
<
  • Image, URL and alternate tooltip text of the logo for this installation: you should change these settings for your site, or they can be overwridden in WebPreferences for individual webs by defining these variables there.
>
>
  • Image, URL and alternate tooltip text of the logo for this installation: you should change these settings for your site, or they can be overwridden in TWiki.WebPreferences for individual webs by defining these variables there.
 
Line: 148 to 148
 
  • Home page of this site. This is DEPRECATED, please use %WIKILOGOURL% instead.
    • Set WIKIHOMEURL = /twiki/bin/view/Public/WebHome
Changed:
<
<
  • List of Daya Bay webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):
>
>
  • List of Daya Bay webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):
 
Line: 164 to 164
 
Changed:
<
<
>
>
 
    • Set OVERRIDABLEPREDEFINEDVARIABLES = all

Search Settings

Changed:
<
<
  • Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)
>
>
  • Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)
 
    • Set SEARCHDEFAULTTYPE = keyword
  • Default for %SEARCH{}% variable, one of: keyword, regex, or literal
    • Set SEARCHVARDEFAULTTYPE = literal
Line: 206 to 206
 

Skin Settings

Changed:
<
<
  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
>
>
  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
 
    • Set SKIN = tagme, topmenu, pattern
Changed:
<
<
>
>
 
Changed:
<
<
>
>
#TWiki.PatternSkin
 

Pattern Skin

Changed:
<
<
>
>
 
    • Set TWIKILAYOUTURL = /twiki/pub/TWiki/PatternSkin/layout.css
    • Set TWIKISTYLEURL = /twiki/pub/TWiki/PatternSkin/style.css
    • Set TWIKICOLORSURL = /twiki/pub/TWiki/PatternSkin/colors.css
Line: 224 to 224
 
    • Set USERSTYLEURL =
    • Set USERCOLORSURL =
Changed:
<
<
  • PatternSkin header settings
>
>
  • TWiki.PatternSkin header settings
 
    • Set WEBHEADERART = /twiki/pub/TWiki/PatternSkin/TWiki_header.gif
    • #Set WEBHEADERBGCOLOR = #faf8f0
Line: 246 to 246
 
  • You can enable/disable Plugins using the configure interface.
  • You can also disable installed plugins in individual webs/topics by defining the %DISABLEDPLUGINS% TWiki variable to be a list of plugins to disable e.g.
Changed:
<
<
>
>
 
Changed:
<
<
>
>
 
  • Legacy settings:
    • Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the configure interface.
Changed:
<
<
>
>
 
Changed:
<
<
Changed:
<
<
>
>
#TWiki.ParameterizedVariables
 

Parameterized Variables

Changed:
<
<
ParameterizedVariables for global use are defined here.
>
>
ParameterizedVariables for global use are defined here.
 
Changed:
<
<
>
>
 
    • Set DASHBOARD = %INCLUDE{ "TWiki.TWikiDashboardAddOn" section="%section%" %IF{ "'%height{ default="" }%'!=''" then="height=\"%height%\"" }% %IF{ "'%width{ default="" }%'!=''" then="width=\"%width%\"" }% %IF{ "'%ENCODE{ "%image{ default="" }%" type="entity" }%'!=''" then="image=\"%image%\"" }% %IF{ "'%ENCODE{ "%title{ default="" }%" type="entity" }%'!=''" then="title=\"%title%\"" }% %IF{ "'%ENCODE{ "%button1{ default="" }%" type="entity" }%'!=''" then="button1=\"%button1%\"" }% %IF{ "'%ENCODE{ "%button2{ default="" }%" type="entity" }%'!=''" then="button2=\"%button2%\"" }% %IF{ "'%ENCODE{ "%button3{ default="" }%" type="entity" }%'!=''" then="button3=\"%button3%\"" }% %IF{ "'%ENCODE{ "%button4{ default="" }%" type="entity" }%'!=''" then="button4=\"%button4%\"" }% %IF{ "'%ENCODE{ "%button5{ default="" }%" type="entity" }%'!=''" then="button5=\"%button5%\"" }% %IF{ "'%ENCODE{ "%button6{ default="" }%" type="entity" }%'!=''" then="button6=\"%button6%\"" }% %IF{ "'%ENCODE{ "%button7{ default="" }%" type="entity" }%'!=''" then="button7=\"%button7%\"" }% %IF{ "'%ENCODE{ "%button8{ default="" }%" type="entity" }%'!=''" then="button8=\"%button8%\"" }% %IF{ "'%ENCODE{ "%style{ default="" }%" type="entity" }%'!=''" then="style=\"%style%\"" }% %IF{ "'%ENCODE{ "%titlestyle{ default="" }%" type="entity" }%'!=''" then="titlestyle=\"%titlestyle%\"" }% %IF{ "'%ENCODE{ "%contentstyle{ default="" }%" type="entity" }%'!=''" then="contentstyle=\"%contentstyle%\"" }% }%
Changed:
<
<
>
>
 
    • Set USERREPORT = %INCLUDE{ "TWiki.UserReports" section="%action%" %IF{ "'%ENCODE{ "%search{ default="~~" }%" type="entity" }%'!='~~'" then="search=\"%search%\"" }% %IF{ "'%limit{ default="~~" }%'!='~~'" then="limit=\"%limit%\"" }% %IF{ "'%order{ default="~~" }%'!='~~'" then="order=\"%order%\"" }% %IF{ "'%sort{ default="~~" }%'!='~~'" then="sort=\"%sort%\"" }% %IF{ "'%reverse{ default="~~" }%'!='~~'" then="reverse=\"%reverse%\"" }% %IF{ "'%user{ default="~~" }%'!='~~'" then="user=\"%user%\"" }% %IF{ "'%users{ default="~~" }%'!='~~'" then="users=\"%users%\"" }% %IF{ "'%selected{ default="~~" }%'!='~~'" then="selected=\"%selected%\"" }% %IF{ "'%height{ default="~~" }%'!='~~'" then="height=\"%height%\"" }% %IF{ "'%width{ default="~~" }%'!='~~'" then="width=\"%width%\"" }% %IF{ "'%ENCODE{ "%title{ default="~~" }%" type="entity" }%'!='~~'" then="title=\"%title%\"" }% %IF{ "'%name{ default="~~" }%'!='~~'" then="name=\"%name%\"" }% %IF{ "'%columns{ default="~~" }%'!='~~'" then="columns=\"%columns%\"" }% %IF{ "'%ENCODE{ "%style{ default="~~" }%" type="entity" }%'!='~~'" then="style=\"%style%\"" }% %IF{ "'%ENCODE{ "%firstoption{ default="~~" }%" type="entity" }%'!='~~'" then="firstoption=\"%firstoption%\"" }% %IF{ "'%ENCODE{ "%firstvalue{ default="~~" }%" type="entity" }%'!='~~'" then="firstvalue=\"%firstvalue%\"" }% }%
    • Set USERSIG = %DEFAULT%
    • Set BUBBLESIG = %DEFAULT%
Line: 283 to 283
  These TWikiRenderingShortcuts facilitate doc writing.
Changed:
<
<
>
>
 
    • Set BB =
    • Set BB2 =
        •
    • Set BB3 =
          •
    • Set BB4 =
            •
Changed:
<
<
  • Line break: Note that the setting has an intentional trailing space
>
>
  • Line break: Note that the setting has an intentional trailing space
 
    • Set BR =
Changed:
<
<
>
>
 
    • Set BULLET = •
Changed:
<
<
>
>
 
    • Set CARET = ^
Changed:
<
<
>
>
 
    • Set COPY = ©
Changed:
<
<
>
>
 
    • Set LAQUO = «
    • Set RAQUO = »
Changed:
<
<
>
>
 
    • Set NBSP =  
Changed:
<
<
  • 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 are shown spaced out in a smaller font, and are separated by » quotes. In addition, a parentlist SetGetPlugin variable is set to the parent list, and a parent variable is set to the immediate parent. This can be retrieved later in the topic using %GET{parentlist}% and %GET{parent}%, respectively.
>
>
  • 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 are shown spaced out in a smaller font, and are separated by » quotes. In addition, a parentlist SetGetPlugin variable is set to the parent list, and a parent variable is set to the immediate parent. This can be retrieved later in the topic using %GET{parentlist}% and %GET{parent}%, respectively.
 
Changed:
<
<
>
>
 
    • Set REG = ®
Changed:
<
<
>
>
 
    • Set TM = ™
Changed:
<
<
>
>
 
Changed:
<
<
>
>
 
    • Set VBAR = |

  • Hint: Above shortcuts are useful in TWiki tables where you cannot use newlines
Line: 344 to 344
 
    • Set Y = DONE

Changed:
<
<
>
>
 
You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
You get: red text and green text
    • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, such as %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Line: 391 to 391
 

Changed:
<
<
>
>
 
You type: =%REDBG% red background %ENDBG% %GREENBG% green background %ENDBG%=
You get:
red background
green background
    • Note: These background colors are block level elements, e.g. take up a whole row of text by default. Useful to set background colors in cells of TWiki tables.
Line: 441 to 441
 

Miscellaneous Settings

Changed:
<
<
  • Note that $text is the topic link text, $summary is the HTML-cleaned topic link text, $topic is the name of the new topic, and $web is the name of the web for the new topic. Values are taken from the link syntax [[$web.$topic][$text]]. For normal plain WikiWord links $text and $topic are the same. The value of $web is the current web unless the link is in the format $web.$topic.
>
>
  • Note that $text is the topic link text, $summary is the HTML-cleaned topic link text, $topic is the name of the new topic, and $web is the name of the web for the new topic. Values are taken from the link syntax [[$web.$topic][$text]]. For normal plain TWiki.WikiWord links $text and $topic are the same. The value of $web is the current web unless the link is in the format $web.$topic.
 
    • default setting:
      • Set NEWLINKFORMAT = $text
    • alternative setting:
Line: 479 to 479
 

Creating New Preference Variables

You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).

Changed:
<
<
  • A preference is defined in a TWikiShorthand bullet item: [3 spaces] * [space] Set NAME = value
    Example (as a nested bullet item, indented 6 spaces):
>
>
  • A preference is defined in a TWikiShorthand bullet item: [3 spaces] * [space] Set NAME = value
    Example (as a nested bullet item, indented 6 spaces):
 
    • Set WEBBGCOLOR = #FFFFC0
  • Preferences are used as TWikiVariables by enclosing the name in percent signs: %. Example:
    • When you write variable %WEBBGCOLOR%, it gets expanded to #FFD8AA .
 
This site is powered by the TWiki collaboration platform Powered by Perl Powered by the TWiki collaboration platform Copyright © by the contributing authors, 2007-2024.
Ideas, requests, problems regarding Daya Bay? Send feedback