Help:Contents

From Daya Bay
Jump to navigation Jump to search

Help on using the Daya Bay wikis

Availability of the wikis

There are two wikis:

Daya Bay
Publicly available in a read-only manner
Can be edited by all collaborators
Daya Bay Private
Available for reading and writing to collaborators only

About public vs. private

The private wiki was filled with the contents of the old TWiki which is still around but read-only for collaborators. There should be no significant content in TWiki that hasn't been moved into dayabay-private. For new content, it is recommended to use the public wiki by default and only put truly private information in dayabay-private.

Getting an account

For either wiki, collaborators can log in using the "dayabay" account (not "DayaBay") and the usual password. You can then (and should) make your own account so that edits get attributed to you. The topic to add your account is Special:Userlogin.

Note that account names can have spaces in them but only their first letter will be capitalized (however, for logging in, the name is case insensitive).

General MediaWiki help

Daya Bay Customizations

Most customizations are done through templates. See here for a list of all templates.

Offline Software Documentation

In an effort to better organize the offline software documentation, some special templates and conventions are used. See Meta:Offline_Documentation.

Interwiki linking

You can make easy interwiki links between public and private topics by prefixing them with "db:" for the public wiki and "dbp:" for the private one. For example:

Link to our DocDB and our EngDB

You can easily link to a document, meeting session or conference (collaboration meeting) in our DocDB by invoking a template. For example this: DocDB document#1 is made by typing 

{{Doc|1}}

Similarly you can link to EngDB with 

{{Eng|1}}

You can also set the text to display. For example, this: First DocDB document! is made by typing 

{{Doc|1|First DocDB document!}}

The available templates are:

  • {{Doc|<id>|<optional text>}}
  • {{Session|<id>|<optional text>}}
  • {{Conference|<id>|<optional text>}}

Note, this template is available in both public and private wikis, however they are separately defined at db:Template:Doc and dbp:Template:Doc.

Link to Doxygen

To link to a class's Doxygen documentation use the ClassDox template and specify the package and class names: 

{{ClassDox|Package|Class}}

Example: {{ClassDox|DybKernel|DybAlgorithm}} is DybKernel/DybAlgorithm.

Link to Trac Tickets

To link to Trac ticket 1 at IHEP: 

{{Ticket|1}}

which looks like this: Trac ticket #1

Link to Trac Files

To link to an SVN file displayed by trac use: 

{{TracFile|dybgaudi/trunk/DataModel/doc/clid.txt|The Registry of DataModel class IDs}}

Which looks like this: The Registry of DataModel class IDs

Link to SVN files

Create links into WebSVN areas or files with: 

* {{Websvn|/dybgaudi/trunk/DataModel/doc/clid.txt}}
* {{Websvn|/dybgaudi/trunk/DataModel/doc/clid.txt|Data Model Class ID registry}}
* {{Svnfile|/installation/trunk/dybinst/dybbin}}
* {{Svnfile|/installation/trunk/dybinst/dybbin|dybbin}}

Which gives:

Link to IHEP CVSWEB

Create links to the IHEP CVSWEB source browser with the wiki text : 

{{CVSlog|path/to/filename.type}}
{{CVSrev|path/to/filename.type|revnum}}
{{CVSdiff|path/to/filename.type|revnum1|revnum2}}

Creating links like : 

  CVSlog:G4dyb/src/dywAnalysisManager.cc
  CVSrev:G4dyb/src/dywAnalysisManager.cc:1.33
  CVSdiff:G4dyb/src/dywAnalysisManager.cc:1.33:1.32

These are implemented via the public and private templates : db:Template:CVSlog db:Template:CVSrev db:Template:CVSdiff dbp:Template:CVSlog dbp:Template:CVSrev dbp:Template:CVSdiff

Link to NTU Trac Repositories and Wikis

Create links from MediaWiki to Trac instances by using the NTU template, with the wiki text : 

  {{NTU|env|source:@488}}  Source browser for a specific revision 
  {{NTU|env|source:trunk/root/write_seedfile.C}}

The first parameter names the repository (eg env ) and the second is a TracLink NTU|env|wiki:TracLinks which startes with eg wiki: , source: , changeset: , log:, diff:. Some links may require authentication with the usual credentials followed by a re-try. This creates links like: 

   NTU|env|source:@488 Source browser for a specific revision
   NTU|env|source:trunk/root/write_seedfile.C

Further examples : 

   NTU|env| A blank 2nd argument leads to a search page
   NTU|env|/  Short form of source link
   NTU|env|wiki:G4dybXcode  Wiki Page
   NTU|dyw|r46  Changeset (collection of files modified in a particular commit into the repository)
   NTU|dyw|log:branches/blyth-optical/G4dyb/src/dywAnalysisManager.cc  Revision log for a file

Also link to the dybsvn mirror at NTU (see SVN_Web_Interface) 

     NTU|dybsvn|/core/trunk
     NTU|dybsvn|r1635
     NTU|dybsvn|log:/legacy/trunk


These are implemented in public and private templates db:Template:NTU dbp:Template:NTU. The templates work via a repurposing of NTU|dybsvn|TracLinks search links, allowing most of the TracLinks functionality to be used.

General Tips

This generic and Daya Bay specific tips should help everyone use these wikis more effectively.


Using categories

You should place the special tag: 

[[Category:Category Name]]

at the bottom of every topic, replacing "Category Name" with an existing or a new category name. Topics can be in multiple categories and categories can be in categories. For a list of existing categories see:

Mark private topics for publication

When you see a topic in dayabay-private that you think would be better moved to the public area please either migrate it or tag it with: 

[[Category:Public]]

so it can be reviewed by the subject expert for migration to the public wiki.

File upload

You can upload files such as images. To include an image, first upload it using the Upload file link found in the toolbox then use, for eg: [[image:Dyb_logo.png|DYB english logo]] which results in: DYB english logo

You should not upload files that are better put in our DocDB.

Collection of Figures for talks

An attempt to collect general figures for Daya Bay talks is organized through the Category:Figures category. See top of that page for guidelines that should be followed when contributing your own figures.

Firefox plugin

The plugin It's all text allows users of firefox or derived browsers to use an external editor such as Emacs to edit content. Consider this if the in-browser text editor is not to your liking.

Greek Characters

Greek or other non-ASCII characters can be entered in the usual HTML way using "&;" codes. For example, "&alpha;&beta;&gamma;" gives "αβγ".

A list of characters and their codes can be found in this topic.

Expert level tips

These tips require some level of advanced technical information and are probably not useful to everyday users.

Mount MediaWiki to your file system

If you use Linux you can use the WikipediaFS FUSE module to mount these wikis on to your local file system. This will let each topic be available as a simple text file. WikipediaFS relies on FusePython.

Some notes:

  • Because this wiki is served with https you should install WikipediaFS v0.3 or higher.
  • Due to the authentication timeout it is a good practice to unmount and remount the wiki when using it after any significant idle time.

Your ~/.wikipediafs/config.xml should look something like: 

<wfs-config>
    <general>
        <article-cache-time>300</article-cache-time>
    </general>
    <sites>
        <site>
            <dirname>dayabay-private</dirname>
            <host>wiki.bnl.gov</host>
            <basename>/dayabay-private/index.php</basename>
            <username>USERNAME</username>
            <password>PASSWORD</password>
            <https />
        </site>
        <site>
            <dirname>dayabay</dirname>
            <host>wiki.bnl.gov</host>
            <basename>/dayabay/index.php</basename>
            <username>USERNAME</username>
            <password>PASSWORD</password>
            <https />
        </site>
    </sites>
</wfs-config>

Replace USERNAME and PASSWORD with your own.

Retrieved from "https://wiki.bnl.gov/dayabay/index.php?title=Help:Contents&oldid=3332"