Editing the Manual

To make changes, you will need to log in (in the upper right corner of the page) using your office network credentials.

What should go in the manual

Each section has some guidelines for what sorts of information should be added.

Task Pages

Task pages should be short and to the point. These pages are intended to be concise summaries of how to perform a task that someone has already been trained on, but with some helpful reminders and links to the important relevant documents. Task pages are not the place for explanations or new information, just a guide for someone who mostly knows what they're doing trying to get a task done.

Each page should be for a single task that an operator might need to do.

If there are any guides or DCC docs related to the task, include them in a Links section at the end. Avoid duplicating information from linked documents, unless the document is hard to read.

Info Pages

The Info Pages section is there for all that extra information that doesn't have another good place. It's where you go when you're looking for an explanation of how things work, and why. If you find yourself writing paragraphs of information, it should probably go in an info page.

The hardest part of making an info page is effectively organizing the link to it on the main Info page. The main page is currently small, but as it grows it will need structure to keep things findable, and not just an endless list of links.

Page structure

Each page should start with a level 1 headline containing the page title. This title will be displayed in the user's trace, and also as the default text for links to that page. Section titles should use headline levels 2-5, and a table of contents will be automatically displayed for headline levels 2-4.

For any page containing links to other documents, include a Links section at the end with a list of all such links.

How formatting works

The Formatting Syntax page is linked at the top whenever you are editing a page, and has most formatting information. Some extra details are given here.

Displaying another page within a page

You can display the text of another page (or a section of another page) within the current one thanks to the Include plugin. The full documentation is available in that link, but the basics are below.

To display an entire page, use {{page>[id]}}. For example, the sidebar page is included below

Operator Wiki Home

Categories:

Task Pages

FRIB Tasks

ReA Tasks

k500

Info Pages

Wellbeing

using the text

{{page>sidebar}}

To display just a section (and its subsections), use {{section>[id]#[section]}}. For example, the Monitoring Beam section from the operations tasks page is below

Task Pages

FRIB Tasks

ReA Tasks

k500

N4 Vault

Not really operations tasks

Turning off the chiller for the N4 vault

Responding to alarms

MPS trips

cavity trips

Phoebus alarms

Voice alarms

PPS alarms

PLC Interlock Documentation

Administrative / Paperwork

Editing pages in this manual

Reporting holiday hours

Navigating DCC

Hourlog

Enabling / disabling voice alarms

Signing people in/out of the tunnel

Safety

Performing radiation surveys

Search and Evict

Printing signs

Technical Work

Creating and editing Phoebus pages

Using Stash

using the text

{{section>operation#Monitoring Beam}}

(Technically the actual link uses the noindent tag to prevent it from showing up in the ToC; see the plugin page for details.)

Linking to external documents

A few shortcuts exist for linking to documents in specific locations.

OPM docs

Documents found in Colin's list of links such as those found in the Operations Procedures Manual can be linked to using the shortcut “clist” and the link number. For example, if you have a URL that looks something like

https://portal.frib.msu.edu/sites/accsystems/preoperation/Lists/Links/2 Accelerator operations/2.1 Operations organization, authorization, and planning/OSE and response to violation/89_.000

you could reference it based on the number at the end (89) as follows:

[[clist>89|FRIB OSE]]

which would show as FRIB OSE.

DCC

Any document in DCC can be linked directly, using a marginally-helpful syntax based off of the document number. This is mainly useful if you're looking at a PDF, and want to make a link that will point to the version maintained on DCC. Using the link shortcut “dcc”, you can make a link out of the WBS number code, subcategory code, and incrementor as follows:

WBS=A##### – where A##### is the WBS code after “FRIB-”

Sub=AA – where AA is the subcategory code

SN=###### – where ###### is the incrementor number

These pieces are then combined with ampersands (&).

For example, if you have a document with the identifier “FRIB-S10000-PR-000367-R002”, you can make a link like this:

[[dcc>WBS=S10000&Sub=PR&SN=000367|Laboratory Document Numbering Procedure]]

which would show as Laboratory Document Numbering Procedure.

This is not terribly convenient but it does work, and will continue to point to newer revisions of the same document.

Other Portal docs

uploading docs to the wiki

Adding new pages

To create a new page, make a link on an existing page, and click on it.