CMS Software Guide - Jobs to do

Complete: 1

Purpose of this page

This page is managed by the SWGuide editors to keep track of changes.

Editing twiki pages for inclusion in the SWGuide

Add standard elements to pages

The following elements need to be added to pages:

  • After the ---+ for the title, have !! unless there is another level 1 header on the page - this makes the table of contents tidier
  • Directly under the title add completeness indicator %COMPLETEN% where N ranges from 0-5.
  • Table of contents %TOC{title="Contents:"}
  • Review Status information:
#ReviewStatus
---++!! Review status 

| *Reviewer/Editor and Date (copy from screen)* | *Comments* |
| %REVIEW% Main.KatiLassilaPerini - 23 Jan 2007 | created the page from based on the current BTau page |

%RESPONSIBLE% Main.ResponsiblePerson %BR%
%REVIEW% !MostRecentReviewAndDate

Other Editing

It is also useful to go through the page and use a ! in front of any words that contain a combination of capital letters with lower case letters between if they are not intended to act as links to wikiwords - e.g. HepMC - which is a commonly used concept in CMS, but for which there exists no twiki topic (yet).

Parentage

At the top of all CMS Twiki pages is a line which looks like:

You are here: TWiki >  CMS Web  >  SWGuide > SWGuideBTagging

In the above example the currently displayed twiki topic was SWGuideBTagging, which can be logically grouped under the topic SWGuide, which is of course part of the CMS web twiki area. Keeping this sort of parentage information accurate (parent topics can be selected by choosing "More Topic Actions" in the options list at the bottom-right of a twiki page) and having all pages within the software guide start with the string "SWGuide" enables the guide to be more easily navigated and maintained.

Create a CMS.LeftBar

To create a standard leftbar for a page, SWGuideXXX, newly in the SWGuide, click on the word "create" on the left of the page where it says "Create a left bar". This will enable you to create a page called SWGuideXXXLeftBar which does the job. The default you'll be offered (16 Feb 2007) is:

%STARTINCLUDE%
  %INCLUDE{"SWGuideLeftBar"}%
%STOPINCLUDE%

So to create a SWGuide standard CMS.LeftBar all you need to do is to click "create" and then save the default with Alt-s

Note: The standard left-bar template, which defines the default leftbar offered is defined in the twiki page WebPageLeftBar - do not edit this page.

Page to be included in the SWGuide

Twiki pages

Other pages

Review status

Reviewer/Editor and Date (copy from screen) Comments
JennyWilliams - 16 Feb 2007 page created

Responsible: KatiLassilaPerini
Last reviewed by: JennyWilliams - 16 Feb 2007

Edit | Attach | Watch | Print version | History: r12 < r11 < r10 < r9 < r8 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r12 - 2010-03-11 - KatiLassilaPerini



 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    CMSPublic All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback