/Alias ODB tree: Difference between revisions

Revision as of 11:28, 7 August 2014

Purpose

The ODB /Alias tree provides the user with a way to access other webpages via buttons placed on the mhttpd Status Page. It can provide links to external webpages, or symbolic links (short-cuts) to ODB sub-trees.

Creating the /Alias tree

The /Alias tree is optional, and is not present until created by the user.

Keys in the /Alias tree

Any key created under /Alias will appear as a button (i.e. alias-button) on the Status Page, with the same name as the key (except as noted below).

By default, the clicking of an alias-button in the web interface will spawn a new frame. To force the display of the alias page in the same frame, an "&" has to be appended to the name of the alias key. The "&" is stripped off the alias name when it appears as an alias-button (see example).

External links

The following odbedit commands demonstrate how to make a link to an external webpage:

[local:t2kgas:S] cd /Alias
[local:t2kgas:S]create string triumf
String length [32]:
[local:t2kgas:S] set triumf "http://triumf.ca"

This will cause a button triumf on the status page, Clicking on this alias-button will show the contents of the link in a new frame.

Symbolic Links

The /Alias tree may also contain a list of symbolic links to any desired ODB location.

The following odbedit commands demonstrate creating alias-buttons linking to ODB keys :

[local:t2kgas:S] cd /Alias
[local:t2kgas:S] ln /Equipment/TpcGasPlc/Common/ "TPC Common"       *** New frame, no &
[local:t2kgas:S] ln /Equipment/TpcGasPlc/Settings/ "TPC Settings&"  *** Same frame, with &
    (comments are preceded by ***)

This would create two alias-buttons TPC Common and TPC Settings. Clicking on TPC Common would open the page in a new frame. Clicking on TPC Settings would open the page in the same frame (see above).

@@ Line 11: / Line 11: @@
 == Creating the /Alias tree ==
-The <span style="color: purple; font-style:italic;">/Alias</span> tree is optional, and is not present until created by the user.
+The <span style="color: purple; font-style:italic;">/Alias</span> tree is optional, and is not present until [[ODB#Creating ODB keys|created by the user]].
-;Notes
-# All examples in this page are shown using [[odbedit]] for simplicity. Alternatively, the [[mhttpd]] ODB page editor can be used.
-# The <span style="color: purple; font-style:italic;">/Alias</span> tree is used by <span style="color:darkcyan;">''mhttpd''</span>,  and ignored by <span style="color:darkcyan;">''odbedit''</span>.
 <div id="Alias-Button"></div>
-== Contents of the /Alias tree ==
+== Keys in the /Alias tree ==
 Any key created under <span style="color: purple; font-style:italic;">/Alias</span> will appear as a button (i.e. '''alias-button''') on the [[Status Page]], with the same name as the key (except as noted below).
@@ Line 33: / Line 30: @@
 This will cause a button <span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
 	padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">triumf</span>
-on the status page,  Clicking on the alias-button
+on the status page,  Clicking on this alias-button will show the contents of the link in a new frame.
-<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">triumf</span>  will show the contents of the link in a new page.
 === Symbolic Links ===
@@ Line 52: / Line 48: @@
 Clicking on
 <span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">TPC&nbsp;Common</span> would open the page in a '''new''' frame. Clicking on
-<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">TPC&nbsp;Settings</span> would open the page in the '''same''' frame (see [[#Contents of the /Alias tree|above]]).
+<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">TPC&nbsp;Settings</span> would open the page in the '''same''' frame (see [[#Keys in the /Alias tree|above]]).
 [[Category:ODB Tree]]