====== Editing the Manual - additional information ======

While most formatting information is on [[wiki:syntax]], some details specific to //our// wiki are explained 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 [[https://www.dokuwiki.org/plugin:include|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

{{page>:sidebar}}

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

{{section>task:operation#Monitoring Beam&noindent}}

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 [[https://portal.frib.msu.edu/sites/accsystems/preoperation/SitePages/OPM.aspx|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 [[clist>89|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 [[dcc>WBS=S10000&Sub=PR&SN=000367|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.

==== Trouble Reports ====
To link to trouble reports, just use the report number:

  [[tr>58375]]

will show as [[tr>58375]].


==== Other Portal docs ====
//Todo: add this//


===== Uploading docs to the wiki =====
//Todo: add this//