From tigwiki

The following conventions have been used in writing these wiki pages.

[edit] Appropriate content

This Wiki page is intended for collaborative authoring of documentation to help people perform experiments with TIGRESS. It can and should include documentation on how to setup, run, and troubleshoot all aspects of the experiment, from beamlines to spectra. In particular it is intended to facilitate the documentation by users, for users. It is primarily for documentation that needs to be written from scratch, and then would be revised at random intervals and places for corrections, clarifications, updates, etc.

This page is one of three on-line documentation services that are being used for TIGRESS. The TIGRESS Folder on the Gamma-group Plone-CMS 3.0 site should be used for permanent documentation, especially documentation that comes to the collaboration from external sources and complete, where modification is unnecessary, unwise, or impossible. The TIGRESS E-log should be used for incremental and sequential information with a strong correlation to time-and-date, such as events, configuration changes, changes in experimental conditions, and such.

One example application to consider is the clover detector scanning facility. When a clover arrives, its documentation should be scanned and uploaded to the Plone site. This would also be the place to look for manuals on the commercial hardware components such as VXI powered crates. The procedures for assembling the clover into the scanning table and for running the acquisition (such as setting up a scan grid) should go in this Wiki. A running diary of what clover is being scanned at what positions, what file names the data are being stored under, and any errors or problems encountered, should be e-logged under TIGRESS Detector Testing Facility. Data analysis procedures should be documented on this Wiki. Once the data is analyzed and is ready for an acceptance decision, figures of spectra, scanning responses, etc. should be written up in a standard, self-contained document format (.doc or .pdf, for example) and deposited on the Plone site.

Another example would be installation of detectors. The manufacturing drawings of the clover carriages should go in the Plone site. Installation instructions should go in this Wiki. When a detector is installed on the array, the detector serial number, cable name, and detector position should be entered into the TIGRESS Experimental Facility E-log.

Information of general interest to users can also go on Wiki pages. For example, the site administrator has moved his personal "pot-pourri" pages, which include some handy tips-and-tricks and some shortcuts to important TRIUMF information, onto this site. The Sandbox Area is specifically intended for users to set such pages, experiment with formatting, etc.

[edit] Getting Access

Once you have decided that your comment is appropriate and where it should go, you will need to get Access to the appropriate site.

[edit] Formatting

Plenty of sources are available for information on how to author Wiki pages. The handiest is the MediaWiki Reference Card. Specific conventions recommended for this site will be established as time goes on.

[edit] Font Conventions

These conventions have been adapted from a typical O'Reily publication, and are primarily applicable to computer-related documentation.

[edit] Italics

Within body text, italics indicate pathnames, filenames, ODB entries and paths, computer names, program names. It is also used to draw attention to notes, examples, or unusual or newly defined terms.

• Normally, mhttpd runs on midtig02.
• You will find experim.h in /home/tigress/tigcol2/.
• The contents of the scalers can be found in /Equipment/MCS/Variables.

[edit] Constant width

Within body text, constant-width text is used for command lines, code, pseudocode, text file content, bank names, and variable values. Normal, constant-width text should be expected to be verbatim. Examples

• Use mhttpd -p 8081 -D to start the web server.
• In odbedit, the make command will generate experim.h automatically.
• /Equipment/MCS/Variables[0-31] corresponds to the first SIS3820.

[edit] Constant width italic

Italicized constant-width text indicates a user-supplied value. It may also be used to indicate comments in text.

• Use ps -ef | grep client to get the process ID. To find mhttpd, specify mhttpd as the client .

[edit] Constant width bold

Constant width bold indicates user input in sample terminal sessions. It can also be used to highlight changes to code or configuration files.

[tigress@midtig02] mhttpd -p 8081
Cannot bind to port 8081.
Please try later or use the "-p" flag to specify a different port
[tigress@midtig02] ps -ef | grep mhttpd
tigress  29534     1  0 21:24 ?        00:00:00 mhttpd -p 8081 -D
tigress  29864 29504  0 21:30 pts/1    00:00:00 grep mhttpd
[tigress@midtig02] kill -9 29534
[tigress@midtig02] mhttpd -p 8081
Server listening ...

The above example walks you through a terminal session where the user tried to start the program mhttpd, found that it was already running somewhere, identified and killed the process, and then successfully started mhttpd.