Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.eso.org/~qc/tqs/webCMS1.html
Дата изменения: Mon Oct 23 11:41:01 2006
Дата индексирования: Fri Dec 21 23:49:50 2007
Кодировка:
Поисковые слова: п п п п п п п п п п п п п п п п п п п п п

webCMS

Description

webCMS provides:

This is a tool for managing the QC web pages. It helps the QC scientist to focus on content, while structure, design and navigation is managed by the tool. It is called webCMS where CMS stands for 'content management system'. Of course a real CMS can do more than webCMS (manage formatting, page relations etc.) but having a tool controlling and providing certain structure elements in an automatic way is already a big step forward.

While making web page creation and maintenance easier, the tool also helps to make the pages better, in the sense that it guarantees uniform look and feel across the QC web site. This is a non-trivial achievement given the fact that otherwise the web pages inevitably evolve in different directions over time.

Another interesting aspect is that with the main structure controlled by the tool, it becomes very easy to change the design of the QC web pages and adapt it e.g. to a modified ESO style. Finally, it manages page ownership so that "mailto" tags of all web pages of an instrument are managed centrally.

The tool takes the user-provided and controlled input file (the content file, essentially a valid HTML file without initial and final tags) and puts it into a standard HTML table, adding the navigation bar (created by the tqs tool createNavBar), the footer and the header:

header
nav bar


<content file>
footer

The tool also takes care about proper updating, author and maintainer names etc.

The tool handles both the specific content files and the common content files (like qc.html etc.).

Structure of QC web site

The new QC web site has two kinds of pages:

instrument, e.g. FORS1/VISIR/AMBER content managed by user? ins1 ins2 ins3
general/common page, common content NO
qc_gen1
 qc_gen2 qc_gen3
content page: instrument specific YES qc11 qc21 qc31
ins-specific YES qc12 qc22 qc32
common NO pipe_gen1 pipe_gen2 pipe_gen3
ins-specific YES pipe11 pipe21 pipe31
ins-specific YES pipe12 pipe22 pipe32
ins-specific YES pipe13 pipe23 pipe33
qc_gen1,2,3 etc. are identical copies, except for their virtual includes to the ins-specific navigation bar.

Although the common pages have a standard, non-specific content (hence the name), they need to get an instrument-specific navigation bar. They effectively are copied in each instrument QC web site, differing only by the navigation bar. This is done by webCMS. The content of the common pages is not modified by the tool.

The content of the specific pages is provided and maintained by the QC scientist. The tool assists them in adding the navigation bar etc. in a standard way.

Output

How to use

Type webCMS -h for on-line help, webCMS -v for the version number, and

webCMS -p <page_name>

for creating the QC page from the content page,

webCMS -l

to list all pages known to it, and

webCMS -c

to copy all common pages into the ins-specific web site.

Installation

Use dfosExplorer or dfosInstall.

Configuration

The tool configuration file (config.webCMS) defines:

1. general parameters
QC_DIR /observing/dfo/quality/GIRAFFE directory on web4 of QC web site
QC_URL http://www.eso.org/qc/GIRAFFE
URL of QC web site
AUTHOR Reinhard.Hanuschik@eso.org original author of page
MAINTAINER
Reinhard.Hanuschik@eso.org maintainer
ORGANISATION
&&ESO, DMO, Quality Control Group&& enclose with &&...&&; no characters after last &&
2. parameters per ins-specific page
2.1: KEYWORDS and SUBDIR
Enter one line per PAGE; list all ins-specific pages to be content-managed
PAGE
 pipe_gen name of ins-specific page
SUBDIR pipeline subdir underneath QC_DIR (qc or pipeline or package)
KEYWORDS
 &&Data Reduction, GIRAFFE, Quality Control, Pipeline&& up to 5 keywords to make page searchable for ESO-internal index
enclose with &&...&&; no characters after last &&

2.2: TITLE
Enter one line per PAGE; list the same pages as above

PAGE
 pipe_gen as above
TITLE &&GIRAFFE pipeline:<br>general information&&

title of page (to show up as <title> tag and in the header)
make sure to have a break <br> included, to make the title appear in two lines which is an ESO style standard

Web page maintenance

  content maintenance publishing
so far full page: on local ("private") machine, maintained by user; ftp to web4 logon to web4; webcp
now content page: on local ("private") machine, maintained by user; ftp to web4 call 'webCMS -p <page>'

The maintenance pattern for QC web pages has now simplified (see above). So far, maintenance required editing on the local machine, plus ftp to web4, plus login there, plus webcp. Now, maintenance is reduced to the content page only. Only two steps are required, the second one on the dfo machine:

1. The user maintains a web content page on a local ("private") machine. Any content modification is done there, using a graphical editor like dreamweaver. It has the name name1.html if it will be later published as name.html. E.g., a pipeline page describing calibration data will be maintained as content page pipe_calib1.html. Under this name it is uploaded by the user after modifications onto web4.

2. In order to finish the page as a valid QC web page, the tool webCMS is called on the dfo machine: 'webCMS -p pipe_calib'. This will download the content page into the dfo machine, add header and footer (as HTML code), dynamic navigation bar and ownership file (as virtual include), modify the 'Last update' (upon request) and uploads the final page as pipe_calib.html onto web4. From there it is then finally published (webcp).

Content page. The content page has just the information to be provided, typically starting with a headline. It has no header, no title, no <body> tag, no navigation bar, no footer etc. It must nevertheless contain valid HTML code. This page will not be modified by webCMS, it will just be embedded in a common HTML structure.

Example: If you open this page, you will find a comment line " <!-- HERE STARTS THE CONTENT PAGE -->". If this page were to be managed by webCMS (which is actually not the case but we can ignore this for the purpose of illlustration), it would start exactly there. It would extend up to the comment line "<!-- HERE ENDS THE CONTENT PAGE -->".

QC style sheet. The user may use styles or classes. This is a common feature in web pages which controls the page design. For instance, the format of the ESO navigation bar is controlled by an ESO style sheet.

The QC style sheet is designed to provide a common QC web page design within the content pages. This will be expanded, once all QC web pages are maintained by webCMS. The QC style sheet is available here. Any style defined there can be used. E.g.