You are here: TWiki > Tier3 Web>WebPreferences (05 Oct 2011, JamesWeichel)

Tier3 Web Preferences

The following settings are web preferences of the Tier3 web. These preferences overwrite the site-level preferences in TWiki.TWikiPreferences and Main.TWikiPreferences, and can be overwritten by user preferences (your personal topic, eg: TWikiGuest in the Main web).

Web Preferences Settings

These settings override the defaults for this web only. See full list of defaults with explanation. Many of the settings below are commented out. Remove the # sign to enable a local customisation.

  • Reviewing directives
    • Set RESPONSIBLE = Responsible:
    • Set COMPLETE1 = Complete: 1
    • Set COMPLETE2 = Complete: 2
    • Set COMPLETE3 = Complete: 3
    • Set REVIEW = Reviewer - date:
    • Set REVFLAG = Review status:
    • Set REVCOM = Comment:

  • List of topics of the Tier3 web:

 #DDDDDD 
  • Web-specific background color: (Pick a lighter one of the StandardColors).
    • Set WEBBGCOLOR = #DDDDDD
    • Note: This setting is automatically configured when you create a web

  • Image, URL and alternate tooltip text of web's logo.
    Note: Don't add your own local logos to the TWikiLogos topic; create your own logos topic instead.

  • List this web in the SiteMap. If you want the web listed, then set SITEMAPLIST to on, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Use links that include the name of the web, i.e. Tier3.Topic links.
    Note: Unlike other variables, the setting of SITEMAPLIST is not inherited from parent webs. It has to be set in every web that is to be listed in the SiteMap
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT =
    • Set SITEMAPUSETO =
    • Note: Above settings are automatically configured when you create a web

  • Exclude web from a web="all" search: (Set to on for hidden webs).
    • Set NOSEARCHALL =
    • Note: This setting is automatically configured when you create a web

  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
    • #Set NOAUTOLINK =
    • Note: You can still use the [[...][...]] syntax to link topics if you disabled WikiWord linking. The <noautolink> ... </noautolink> syntax can be used to prevents links within a block of text.

  • Default template for new topics for this web:
    • WebTopicEditTemplate?: Default template for new topics in this web. (Site-level is used if topic does not exist)
    • TWiki.WebTopicEditTemplate: Site-level default topic template

  • Comma separated list of forms that can be attached to topics in this web. See TWikiForms for more information.
    • Set WEBFORMS =

  • Users or groups who are not / are allowed to view / change / rename topics in the Tier3 web: (See TWikiAccessControl). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.

  • Web preferences that are not allowed to be overridden by user or topic preferences:
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME

OSG-created variables

  • Edit This Section variables. Use %EDITTHIS% to create a button that does not appear in the PDF files.
  • Sets the more variable to let you show and hide text from users. This must be set in VERBATIM tags because otherwise it screws up our sidebar. (Don't know why:: EFC):
      * Set STARTMore = <span id="twid_%CALC{$SETM(twisty_id, + 1)$GET(twisty_id)}%show" class="twistyMakeVisible">
       <a href="#" class="twistyTrigger">more...</a>
     </span>
     <span id="twid_%CALC{$GET(twisty_id)}%hide" class="twistyHidden">
       <a href="#" class="twistyTrigger">close</a>
     </span>
     <div id="twid_%CALC{$GET(twisty_id)}%toggle" class="twistyMakeHidden">
      * Set ENDMore = </div>
  • For creating text boxes with blue border to separate from the main text:
      * Set STARTInsetBox = <div name="TextBoxWithBorder" style="margin: 0; padding: 0; position: relative; border: medium solid orange; margin-right: 10%; margin-left: 10%; padding-left: 1em; padding-right: 1em; font-family: Georgia, Times New Roman, Times, Sans Serif" >
      * Set ENDInsetBox = </div>

  • Creates a "where used" backlinks section for inclusion at the bottom of topics ( WHU ) or a section with backlinks and other matter ( BOTTOMMATTER ):
      * Set WHU = %INCLUDE{ "Main.WhuReferences" }%
      * Set BOTTOMMATTER = %INCLUDE{ "Main.ToolsBottomMatter" }%
      * Set LINKCSS = <link rel="stylesheet" type="text/css" href="%PUBURL%/Documentation/Tools/exercises.css">
      * Set OUT = %GREEN%*%ENDCOLOR%
      * Set RELDOC = ReleaseDocumentation
<!-- during integration, set it to Integration/ITB_x_y -->

  • Warnings, notes and other "asides" in your text. These are set as DLs with an appropriate icon:
      * Set NOTE = %INCLUDE{ "ReleaseDocumentation.DocWarningsAndNotes" section="Notes" }%
      * Set DISCLAIMER = %INCLUDE{ "ReleaseDocumentation.DocWarningsAndNotes" section="Disclaimers" }%
      * Set WARNING = %INCLUDE{ "ReleaseDocumentation.DocWarningsAndNotes" section="Warnings" }%
      * Set IMPORTANT = %INCLUDE{ "ReleaseDocumentation.DocWarningsAndNotes" section="Importants" }%
      * Set TIP = %INCLUDE{ "ReleaseDocumentation.DocWarningsAndNotes" section="Tips" }%

Help on Preferences

  • A preference setting is defined by:
    3 or 6 spaces * Set NAME = value
    Example:
    • Set WEBBGCOLOR = #FFFFC0
  • A preferences setting can be disabled with a # sign. Remove the # sign to enable a local customisation. Example:
  • Preferences are used as TWikiVariables by enclosing the name in percent signs. Example:
    • When you write variable %WEBBGCOLOR% , it gets expanded to #DDDDDD
  • The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set WEBCOPYRIGHT before WIKIWEBMASTER since %WEBCOPYRIGHT% uses the %WIKIWEBMASTER% variable.
  • You can introduce your own preferences variables and use them in your topics and templates.

Related Topics

Tools

Topic attachments
I Attachment Action Size Date Who Comment
bmpico favicon.ico manage 1.4 K 25 Oct 2006 - 00:16 UnknownUser  
gifgif logo.gif manage 2.5 K 25 Oct 2006 - 00:16 UnknownUser  
Topic revision: r23 - 05 Oct 2011 - 21:36:05 - JamesWeichel
 
TWIKI.NET

TWiki | Report Bugs | Privacy Policy

This site is powered by the TWiki collaboration platformCopyright by the contributing authors. All material on this collaboration platform is the property of the contributing authors..