/Alias ODB tree: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/odb_keys/#alias /Alias] on the ODB keys page and [https://midas.triumf.ca/docs/develop/features/core_system/web/configuring/#aliases-extra-menu-links Aliases (extra menu links)] on the Web interface: configuring page for the new documentation about the /Alias ODB keys.
* [[Midas_documentation|Midas Documentation]]
* [[Feature_listing|Feature Listing]]
* [[Application_listing|Application Listing]]
* [[Online_Database|Online Database]]
</div>
 
 
== 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.
 
;Notes
# All examples in this page are shown using [[odbedit]] for simplicity. Alternatively, the [[mhttpd]] ODB page editor can be used.
# The /Alias tree is used by mhttpd,  and ignored by odbedit.
 
== Contents of the /Alias tree ==
Any key created under /Alias will appear as a Button on the [[Status Page]], with the same name as the key (except as noted below).
 
By default, the clicking of the 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 a button on the status page (see [[#Symbolic Links|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 <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
<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 ===
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
<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> and
<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>.
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]]).
 
 
[[Category:ODB Tree]]

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See /Alias on the ODB keys page and Aliases (extra menu links) on the Web interface: configuring page for the new documentation about the /Alias ODB keys.