STAR Trigger Document Editing Instructions

Instructions to Edit STAR Trigger Documents

This page will attempt to explain how one would add a document to the STAR Trigger Web Documents area. Use your favorite editor and edit the appropriate HTML file in the documents area. A quick word on the structure of this documents area. This document area is in the STAR afs area on RCF. If you do not know where to find it, please contact either Leo Greiner or Zoran Milosevich. There are seven top level directories for each trigger subsystem

GeneralTrigger
TriggerSystemLogic (TSL)
CTB
MWC
ZDC
EMC
VPD

Underneath each of these directories are the following subdirectories

ContextDiagrams
Discussion
Interfaces
Manual
Requirements
Schematics
Simulations
Software
Testing

These subdirectories are where all documents will reside, whether in postscript, pdf, or other format. Inside each of the seven top level directories are the actual html files that will need editing to add any document to the documents web area. The html files are all named index.html. This particular document will describe what to edit inside the HTML file to be able to add a document.

Inside the HTML file, you will see the tags <html> and then <head>. Then there will be some Java script separated by the tags <SCRIPT LANGUAGE="JavaScript"> and </SCRIPT>. Then there will be a </head> tag. Everything up to this point can be ignored since there will probably be no need to edit any of it. Where one needs to look to edit the document will be where one sees

Underneath one will see each subdirectory listed in comments, such as

which will contain the contents of the Requirements subdirectory. By looking in this section and the others, it should be obvious how the area is structured. There will be a few instructions added here to aid in editing the document for your particular purpose, either adding one document or adding a whole new section (subdirectory under the seven top level directories).

Adding one document that is available in one format

Here the example will be given that there is a context diagram to be added for the CTB called CTB X.X in a file called DOC.ps. One will of course have to copy and paste the same formated tags and simply modify the name of the document and the name of the file:


<!-- Context -->

<DIV ID="elTwoParent" CLASS=parent><A 
HREF="#" onClick="expandIt('elTwo'); return false"><IMG NAME="imEx" 
SRC="../.images/triDown.gif" WIDTH=10 HEIGHT=10 BORDER=0 ALT="Expand/Collapse Item"></A>
<b>Context Diagrams</b> - (Leo Greiner)<p>
</DIV>

<DIV ID="elTwoChild" CLASS=child> 
<font size=-1>

    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="ContextDiagrams/ctb0_0.ps">
    CTB 0.0</A>
    &nbsp;&nbsp;(<<A HREF="ContextDiagrams/ctb0_0.pdf">pdf</a> version)<br>
    <p>

    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="ContextDiagrams/ctb0_1.ps">
    CTB 0.1</A>
    &nbsp;&nbsp;(<A HREF="ContextDiagrams/ctb0_1.pdf">pdf</a> version)<br>
    <p>

    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="ContextDiagrams/ctb0_1_1.ps">
    CTB 0.1.1</A>
    &nbsp;&nbsp;(<A HREF="ContextDiagrams/ctb0_1_1.pdf">pdf</a> version)<br>
    <p>   

    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="ContextDiagrams/ctb0_1_3.ps">
    CTB 0.1.3</A>
    &nbsp;&nbsp;(<A HREF="ContextDiagrams/ctb0_1_3.pdf">pdf</a> version)<br>
    <p>
    
    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="ContextDiagrams/DOC.ps">
    CTB X.X</A>
    &nbsp;&nbsp;<br>
    <p>
    
</font>
</DIV>

To add a document (say CTB X.X) in HTML format (DOC.html), the following is suggested, using the above guidelines.



    
    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="ContextDiagrams/DOC.html" target="same">
    CTB X.X</A>
    &nbsp;&nbsp;<br>
    <p>

Adding one document that is available in two formats

Here the example will be given that there is a context diagram to be added for the CTB called CTB X.X in a file called DOC.ps that is also available in pdf format as DOC.pdf Just follow the above instructions with the following modifications to what is pasted:



    
    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="ContextDiagrams/DOC.ps">
    CTB X.X</A>
    &nbsp;&nbsp;(<A HREF="ContextDiagrams/DOC.pdf">pdf</a> version)<br>
    <p>

Adding a whole new section (subdirectory)

Again, it is recommended to cut and paste from another section, to make it look like the following example, where the new subdirectory is called foo with two documents, fooDOC1 and fooDOC2 where the first is in a postscript file DOC1.ps and the second is HTML, DOC2.html

    

<!-- Foo -->

<DIV ID="elTenParent" CLASS=parent><A 
HREF="#" onClick="expandIt('elTen'); return false"><IMG NAME="imEx" 
SRC="../.images/triDown.gif" WIDTH=10 HEIGHT=10 BORDER=0 ALT="Expand/Collapse Item"></A>
<b>Foo</b> - (Leo Greiner)<p>
</DIV>

<DIV ID="elTenChild" CLASS=child> 
<font size=-1>

    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="Foo/DOC1.ps">
    fooDOC1</A>
    &nbsp;&nbsp;<br>
    <p>

    &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="Foo/DOC2.html" target="same">
    fooDOC2</A>
    &nbsp;&nbsp;<br>
    <p>

</font>
</DIV>

To note in this example:

It is assumed that a subdirectory named Foo has been created where the documents reside.

It is assumed that this section named Foo is placed after the other nine sections, hence the label Ten in three spots. If it were placed in the fourth spot, for instance, then instead of Ten, one would use the label Four and the subsequent sections would have to be changed accordingly.

Note the difference in how the two formats (ps vs. html) are handled.

NOTE: One More Step to Finish
When the document has been added and you are finished editing the appropriate index.html page, there is one more simple step to do. This is editing the trgNew.html file in the top level directory of the trg web area. Follow the examples already there to simply add a link to wherever your new document resides.