ReleaseDocumentation Web Preferences

The following settings are web preferences of the ReleaseDocumentation 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.

    • Set DOC_BANNERMESSAGE = Please note: This documentation is for OSG 1.2. While we still provide critical security updates for OSG Software 1.2, we recommend you use OSG Software 3 for any new or updated installations. We are considering May 31, 2013 as possible OSG 1.2 End of Life (EOL).
    • Set DEP_WARNING =

      Please note: This documentation is for OSG 1.2. While we still provide critical security updates for OSG Software 1.2, we recommend you use OSG Software 3 for any new or updated installations.

  • 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 ReleaseDocumentation web:

 #9999FF 
  • Web-specific background color: (Pick a lighter one of the StandardColors).
    • Set WEBBGCOLOR = #999999
    • 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. ReleaseDocumentation.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 = ...collaborate on
    • 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.

  • 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 ReleaseDocumentation 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

GenPDFAddOn plugin variables

  • Sets the variables necessary for the GenPDFAddOn plugin to produce pretty PDF
    • Set GENPDFADDON_BANNER = Open Science Grid documentation
    • Set GENPDFADDON_TITLE = WebPreferences
    • Set GENPDFADDON_SUBTITLE = ReleaseDocumentation?
    • Set GENPDFADDON_HEADERTOPIC = GenPDFHeaderFooterTopic
    • Set GENPDFADDON_TITLETOPIC = GenPDFTitleTopic
    • #Set GENPDFADDON_SKIN =
    • Set GENPDFADDON_RECURSIVE = 2
    • #Set GENPDFADDON_FORMAT =
    • Set GENPDFADDON_TOCLEVELS = 3
    • #Set GENPDFADDON_PAGESIZE =
    • #Set GENPDFADDON_ORIENTATION =
    • #Set GENPDFADDON_WIDTH =
    • #Set GENPDFADDON_HEADERSHIFT =
    • #Set GENPDFADDON_KEYWORDS =
    • #Set GENPDFADDON_SUBJECT =
    • #Set GENPDFADDON_TOCHEADER =
    • #Set GENPDFADDON_TOCFOOTER =
    • Set GENPDFADDON_HEADFOOTFONT = Times, Times New Roman, Serif
    • Set GENPDFADDON_BODYIMAGE = Open Science Grid
    • Set GENPDFADDON_LOGOIMAGE = Open Science Grid
    • Set GENPDFADDON_NUMBEREDTOC = True
    • Set GENPDFADDON_DUPLEX = True
    • #Set GENPDFADDON_PERMISSIONS =
    • #Set GENPDFADDON_MARGINS =
    • #Set GENPDFADDON_BODYCOLOR =

OSG-created variables

  • Edit This Section variables. Use
    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">

  • Warnings, notes and other "asides" in your text. These are set as DLs with an appropriate icon:
      * Set NOTE = %INCLUDE{ "Integration.DocBestPracticesWarningsAndNotes" section="Notes" }%
      * Set WARNING = %INCLUDE{ "Integration.DocBestPracticesWarningsAndNotes" section="Warnings" }%
      * Set IMPORTANT = %INCLUDE{ "Integration.DocBestPracticesWarningsAndNotes" section="Importants" }%
      * Set TIP = %INCLUDE{ "Integration.DocBestPracticesWarningsAndNotes" section="Tips" }%
      * Set STARTOSG12 = %INCLUDE{ "Integration.DocBestPracticesWarningsAndNotes" section="Osgstart" }%
      * Set ENDOSG12 = %INCLUDE{ "Integration.DocBestPracticesWarningsAndNotes" section="Osgend" }%

Notes:

  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
    • Set WEBBGCOLOR = #660000
  • Preferences are used as TWikiVariables by enclosing the name in percent signs. Example:
    • When you write variable %WEBBGCOLOR% , it gets expanded to #9999FF .
  • 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 new preferences variables and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).

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 #9999FF
  • 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

  • Set NOTE =
HELP NOTE

  • Set DISCLAIMER =
HELP DISCLAIMER
Topic attachments
I Attachment Action Size Date Who Comment
elsecss centerpageborder-rd.css manage 0.1 K 21 Jul 2009 - 20:25 RobGardner  
bmpico favicon.ico manage 1.4 K 02 Mar 2007 - 17:27 UnknownUser  
gifgif logo.gif manage 2.5 K 02 Mar 2007 - 17:27 UnknownUser  
Topic revision: r116 - 05 Mar 2013 - 20:09:17 - SuchandraThapa
Hello, TWikiGuest
Register

Introduction

Installation and Update Tools

Clients

Compute Element

Storage Element

Other Site Services

VO Management

Software and Caches

Central OSG Services

Additional Information

Community
linkedin-favicon_v3.icoLinkedIn
FaceBook_32x32.png Facebook
campfire-logo.jpgChat
 
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..