Custom Page Features: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
(Created page with "<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4"> * Midas Documentation * Feature Listing * Application_lis...")
 
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
(36 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/api/javascript/deprecated/ Deprecated web features] and [https://midas.triumf.ca/docs/develop/features/monitoring_and_control/custom_pages/ Custom pages: overview] for the new documentation about the older custom page features.
* [[Midas_documentation|Midas Documentation]]
* [[Feature_listing|Feature Listing]]
* [[Application_listing|Application Listing]]
* [[Online_Database|Online Database]]
</div>
 
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[Mhttpd|mhttpd MIDAS web server]]
* [[ODB Page]]
* [[Custom Page]]
* [[/Custom ODB tree]]
* [[Mhttpd.js|MIDAS Javascript library]]
* [[odbedit]]
</div>
 
= Introduction =
This page describes some of the special features provided for use on a user-created [[mhttpd]]  [[Custom Page#Custom Web Page]].
 
=    Access to the ODB using the MIDAS Javascript Library =
Access to the ODB is through the  [[Mhttpd.js|MIDAS Javascript Library]]. However, if Javascript is not available, the older HTML-style <odb..> tags are still available.
 
=    Access to the ODB using HTML-style <odb> tags =
;NOTE
: It is recommended that the [[Mhttpd.js|MIDAS Javascript Library]] be used for ODB access. However, if Javascript is not available, the older HTML-style <odb..> tags are still available. Access through the <odb..> tag is very limited.
 
The HTML-style <odb...> tag has been defined for read/write access to the ODB under HTML. The <odb...> tags are declared within enclosing HTML <form...>....</form> tags.
 
{|  style="text-align: left; width: 100%; background-color: rgb(255, 255, 255);" border="3" cellpadding="2" cellspacing="2"
|+ Caption  Access to ODB from HTML
|-
| colspan="1" rowspan="1" style="vertical-align: top; background-color: rgb(255, 255, 204); font-weight: bold;" | HTML ODB tag
| colspan="1" rowspan="1" style="vertical-align: top; background-color: rgb(255, 255, 204); font-weight: bold;" | Meaning
 
 
|- 
| colspan="1" rowspan="1"  style="vertical-align: top; background-color: rgb(255, 255, 255); color: black"  |<odb src="odb path">
| colspan="1" rowspan="1"  style="vertical-align: top; background-color: rgb(255, 255, 255); color: black"  |Display ODB field (read only)
|- 
| <odb src="odb path" edit=1 pwd="CustomPwd">
| Display an Editable ODB field (inline style). Optional password protection with '''pwd''' .
 
|- 
| <odb src="odb path" edit=2 pwd="CustomPwd">
| Display an Editable ODB field (popup style). Optional password protection with '''pwd''' .
|}
 
==Usage: ==
 
Experiment Name: <odb src="/Experiment/Name">
Run Number: <odb src="/runinfo/run number" edit=1>
 
== Example ==
See [[Custom Page#How to write a Custom Page|HTML Custom Page example]].
 
 
= Json support]] =
Json support is provided with the [[Mhttpd.js|MIDAS Javascript Library]].
 
 
=  Access to the standard MIDAS Menu buttons =
Access to the standard MIDAS Menu buttons can be provided with HTML <input...> tags of the form:
<input name="cmd" value=''<button-name>'' type="submit" >
Valid values are the standard MIDAS Menu buttons, i.e. (Start, Pause, Resume, Stop, ODB, Elog, Alarms, History, Programs etc). The <input...> tags must be declared within enclosing HTML <form...>....</form> tags (see above).
 
The following HTML fragment shows the inclusion of three of the standard buttons, giving access to the Main Status, ODB and Messages pages :
<form name="form1" method="Get" action="/CS/MyExpt&">
<input name="cmd" value="Status" type="submit">
<input name="cmd" value="ODB" type="submit">
<input name="cmd" value="Messages" type="submit">
...
</form>
 
= CustomScript Buttons =
[[/Customscript ODB tree#Customscript-button|CustomScript buttons]] can be provided on [[Custom Page|Custom Pages]]. These buttons are equivalent to optional [[/Script ODB tree#Script-button|script buttons]] on the [[Status Page]], and allow a particular action to be performed when the button is pressed. Customscript buttons can be set up through the [[/Customscript ODB tree]].
 
Any key <span style="color:purple; font-style:italic">/CustomScript/my button</span> will appear as a customscript-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;">my button</span> on a custom page whose code includes an HTML <input...> tag of the form:
 
        <input type=submit name=customscript value="my button">
 
where the action of the 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;">my button</span> will be found in the <span style="color:purple; font-style:italic">/customscript/my button</span> subdirectory.
 
After pressing a customscript-button, the [[Status Page]] will be shown, unless a redirect input tag is included to redirect back to the original custom page.
 
 
=    External stylesheet =
[[File:Mhxcustom03_keys.jpg|thumb|left|Figure 1: Keys in /Custom ODB tree for external stylesheet and Demo html code ]]
[[File:Mhxcustom03.jpg|thumb|left|Figure 2: Demo Custom Page using MIDAS stylesheet]]
 
A stylesheet can of course be included in an HTML page. However, it is often convenient to use an external stylesheet that can be used for several custom pages.  The MIDAS packate provides a condensed stylesheet  (mhttpd.css) for users who would like their custom pages to have a similar "look and feel" to that of the the standard pages.
 
An external stylesheet can be used in a [[Custom Page]] by creating a link in the [[/Custom]] tree to a stylesheet file on the local disk. It is convenient to end the link name with "!" to prevent a [[/Custom ODB tree#Custom-Button|custom-button]] appearing on the [[Status Page]] (see [[Custom ODB tree|Keys in the /Custom tree]]).  For example, the links for the Demo Custom Page myexpt.html and the style sheet mhttpd.css are shown using the [[ODB Page]] in Figure 1.
 
A <link> tag to link in the stylesheet is then placed in the header of the custom page html code (myexpt.html)  e.g.
<link type="text/css" rel="stylesheet" href="/CS/stylesheet!" title="Stylesheet">
 
The resulting custom page is shown in Figure 1, which can be compared with [[Custom Page#How to write a custom page|Figure 4 (no stylesheet)]].
 
 
 
=    Password protection of ODB variables =
Being able to control an experiment through a web interface of course raises the question of safety. This is not so much about external access (for which there are other protection schemes firewalls, host lists etc.) but about accidental access by the normal shift crew. If a single click on a web page opens a critical valve, this might be a problem. In order to restrict access to some "experts", an additional password can be chosen for all or some controls on a custom page.
 
Password protection is optional, and must be set up by the user as decribed in [[/Custom ODB tree#Pwd subtree]].
 
Password protection is available for
 
    Password protection of Edit Boxes
    ODBSet JavaScript function
    Area map with password check
 
If password protection is set up, [[mhttpd]] will check the supplied password against the ODB entry, and show an error if they don't match.
 
 
*    Page refresh
*    Alias-Buttons and Hyperlinks
*    Access to MIDAS message log with the [[#MIDAS Javascript library|MIDAS Javascript Library]]
*    Include checkboxes on a custom page
*    Periodic update of parts of a custom page
*    Image insertion into a Custom page
**        Inserting a history image in a custom page
**        Mapping active areas onto the image
**        Display mouse position
**        Superimposing Labels, Bars and Fills onto an image
**        Edit boxes floating on top of a graphic

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See Deprecated web features and Custom pages: overview for the new documentation about the older custom page features.

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Custom_Page_Features&oldid=3686"