Difference between revisions of "Internal Custom Page"

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...")
 
 
(4 intermediate revisions by the same user not shown)
Line 22: Line 22:
  
 
= Introduction =
 
= Introduction =
An Internal custom page has the following features:
+
An '''Internal''' custom page is one where the html code is fully stored in the Online Database (ODB), whereas an  [[Custom Page#Introduction|External]] custom page has the html code stored as an external file. All the features described for [[Custom Page|Custom Pages]] should work for internal pages, but may not have been tested. External custom pages are recommended, unless the custom page code is small.
*        The html code is fully stored in the Online Database (ODB).
 
*        Limited capability, size restricted.
 
*        The page is web editable.
 
  
Since external custom pages do not suffer from the size restriction, external pages are recommended. All the features described for [[Custom Page|Custom Pages]] should work for internal pages, but may not have been tested.
+
= How to create an Internal Custom Page =
 +
An internal custom page (written in HTML) may be imported under a given [[/Custom ODB tree|/Custom]] ODB key. The name of this custom key will appear on the [[Status Page]] as a [[/Custom ODB tree#Custom-Button|custom-button]]  
 +
The name of the custom key is chosen by the user, however some characters in the name (i.e. "&","!") have special meaning, and some restrictions apply (see [[/Custom ODB tree#Key names|custom key names]]).
  
= How to create an Internal Custom Page =
+
By clicking on this custom-button, the contents of this key is interpreted as HTML content. Figure 1 shows an internal custom page which has been imported into the ODB at key <span style="color: purple; font-style:italic;">/Custom/Overview&</span>.
An internal custom page (written in HTML) may be imported under a given [[/Custom ODB tree|/Custom]] ODB key. The name of this key will appear on the [[Status Page]] as an [[/Alias ODB tree#Alias-Button|alias-button]]. By clicking on this button, the contents of this key is interpreted as HTML content. Figure 1 shows an internal custom page which has been imported into the ODB at key <span style="color: purple; font-style:italic;">/Custom/Overview&</span>.
 
 
<br>
 
<br>
  
Line 52: Line 50:
 
'''Note:'''
 
'''Note:'''
  
* Once the file is imported into ODB, you can ONLY edit it through the web through the [[ODB Page]]. Clicking the Edit link under the <span style="color: purple; font-style:italic;">/Custom/Overview&</span> ODB key (Figure 2) will open an editing window (Figure 3).
+
* Once the file is imported into ODB, you can ONLY edit it through the web through the [[ODB Page]]. Clicking the Edit link under the ODB key <span style="color: purple; font-style:italic;">/Custom/Overview&</span> (Figure 2) will open an editing window (Figure 3) which can be used to edit the code. Note that Figure 2 also shows a link to an external webpage at <span style="color: purple; font-style:italic;">Custom functions&</span>.
 
* The Custom page can also be exported back to a ASCII file using the [[odbedit]] command <span style="color:saddlebrown; font-style:bold; ">"export"</span>, e.g.
 
* The Custom page can also be exported back to a ASCII file using the [[odbedit]] command <span style="color:saddlebrown; font-style:bold; ">"export"</span>, e.g.
 
  [local:midas:Stopped]/>cd Custom/
 
  [local:midas:Stopped]/>cd Custom/
Line 61: Line 59:
  
 
<div style="clear: both"></div>
 
<div style="clear: both"></div>
[[Category:Custom Page]]
+
[[Category:Custom]]

Latest revision as of 15:46, 13 July 2015

Links

Purpose

This page describes how to create an internal Custom Page.

Introduction

An Internal custom page is one where the html code is fully stored in the Online Database (ODB), whereas an External custom page has the html code stored as an external file. All the features described for Custom Pages should work for internal pages, but may not have been tested. External custom pages are recommended, unless the custom page code is small.

How to create an Internal Custom Page

An internal custom page (written in HTML) may be imported under a given /Custom ODB key. The name of this custom key will appear on the Status Page as a custom-button The name of the custom key is chosen by the user, however some characters in the name (i.e. "&","!") have special meaning, and some restrictions apply (see custom key names).

By clicking on this custom-button, the contents of this key is interpreted as HTML content. Figure 1 shows an internal custom page which has been imported into the ODB at key /Custom/Overview&.

Click on thumbnails to enlarge
Figure 1: Internal Custom Page example
Figure 2: Internal custom page imported into key Overview&
Figure 3: Contents of key Overview& can be edited

The insertion of a new Internal Custom page requires the following steps:

[local:midas:S]/custom>import int_custom.html Overview&


Note:

  • Once the file is imported into ODB, you can ONLY edit it through the web through the ODB Page. Clicking the Edit link under the ODB key /Custom/Overview& (Figure 2) will open an editing window (Figure 3) which can be used to edit the code. Note that Figure 2 also shows a link to an external webpage at Custom functions&.
  • The Custom page can also be exported back to a ASCII file using the odbedit command "export", e.g.
[local:midas:Stopped]/>cd Custom/
[local:midas:Stopped]/Custom>export test&
File name: mcustom.html
[local:midas:Stopped]/Custom>