You are here: TWiki > Documentation Web>WebPreferences (26 Jun 2012, MarcoMambelli)

Documentation Web Preferences

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

Preferences:

  • List of topics of the TWiki .Documentation web:

  • Web specific background color: (Pick a lighter one of the StandardColors)
    • Set WEBBGCOLOR = #FFFF99

  • List this web in the SiteMap:
    • If yes, set SITEMAPLIST to on, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. Documentation.Topic links.
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT = OSG Web site development for Production and Public Users
    • Set SITEMAPUSETO = ...collaborate on the development of web information and layout

  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =

  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
    • Set NOAUTOLINK =
    • 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.

  • Users or groups who are not / are allowed to view / change / rename topics in the Documentation web: (See TWikiAccessControl)
    • Set DENYWEBVIEW =
    • Set ALLOWWEBVIEW =
    • Set DENYWEBCHANGE =
    • Set ALLOWWEBCHANGE = GridGroup
    • Set DENYWEBRENAME =
    • Set ALLOWWEBRENAME = GridGroup

  • Users or groups allowed to change or rename this WebPreferences topic: (I.e. TWikiAdminGroup)

  • Web preferences that are not allowed to be overridden by user 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 = Documentation
    • Set GENPDFADDON_HEADERTOPIC = GenPDFHeaderFooterTopic
    • Set GENPDFADDON_TITLETOPIC = GenPDFTitleTopic
    • #Set GENPDFADDON_SKIN =
    • #Set GENPDFADDON_RECURSIVE =
    • #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

  • Things that can be substituted automatically in the OSG web pages
    • Set ITB_VERSION = 3.0
    • Set OSG_VERSION = 3.x
    • Set OSG_GRID = OSG
    • Set SUPPORTED_OS = Red Hat Enterprise Linux 5 and 6 and variants (Details...)
    • Set INCLUDEHEADING = Included topic:
    • Set RELSTATUS = Not Released
    • Set OSG_RELEASE = OSG
    • Set OSG_PREVIOUS_VERSION = 1.2
    • Set OSG_RELEASE_WEB = Documentation/Release3
    • Set OSG_PREVIOUS_RELEASE_WEB = ReleaseDocumentation?

  • 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{ "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" }%

Some variables:

  • Set ONLY_IN_INCLUDE = For more details, please see WebPreferences.
  • Set ONLY_IN_INCLUDE2 = For more details, please see {TOPIC}.
  • Set ONLY_IN_INCLUDE3 = %OptionInIncluding%=''
%IF{"$ TOPIC != 'YumRepositories'" then="For more details, please see our [[Documentation.Release3.YumRepositories][yum repository documentation]]." else=""}%

Some tests:

Topic eq including 1 OK Topic eq including 2 OK Topic eq including 3 OK Topic eq including 4 OK Topic eq including 5 OK Topic eq including 6 NO

Notes:

  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
    • 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 #FFFF99 .
  • 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).

Related Topics:


-- MarciaTeckenbrock - 05 Dec 2007: LINKS OK

Topic attachments
I Attachment Action Size Date Who Comment
bmpico favicon.ico manage 3.2 K 19 Feb 2007 - 21:39 UnknownUser OSG favicon.ico
Topic revision: r35 - 26 Jun 2012 - 16:00:24 - MarcoMambelli
Hello, TWikiGuest!
Register

 
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..