Templating Toolkit on ScipioERP

Grid

Fri, 06 May 2016 00:00:00 +0000

standard/htmlStructure.ftl

Grid column layout documentation

Displaying content within a (flexible) grid is a way of structuring content on a website. The grid itself works as a layer on top of the basic html structure. Everything visible is grouped inside columns and individual cells. The SCIPIO framework uses the standard 12 column grid that is used by modern CSS frameworks, such as foundation or bootstrap.

Content Elements

Fri, 06 May 2016 00:00:00 +0000

standard/htmlContent.ftl

The SCIPIO framework comes with a set of standard content elements. The elements are largely based on standard html elements so the transition should be straight forward. Since all macros also standardize the html patterns, it is recommended to rely on the SCIPIO tag alternatives for all html. All macros start with “<@”, so tags can be converted by adding an @ in front of them.

The SCIPIO content elements add new options that can be added as attributes. For example, whereas <@table > will create a default table, <@table responsive=true> will generate the very same with added resizing for smaller devices. The available options and their respective use are outlined by this document.

Information & Notifications

Fri, 06 May 2016 00:00:00 +0000

standard/htmlInfo.ftlThe information and notification elements can be used to define content that should catch the users attention, such as modals, panels and alerts.

Included by htmlTemplate.ftl.

NOTES:

May have implicit dependencies on other parts of Scipio API.

Definitions:#

alert , commonMsg , modal , panel

macro `modal`#

Creates a modal UI element.

Modal dialog macro documentation example

Form Elements

Fri, 06 May 2016 00:00:00 +0000

standard/htmlForm.ftlIn the same fashion as the content elements, SCIPIO form elements are meant as a mean to standardize the development of complexe forms. The elements follow standard html patterns, with the only difference being the @field attribute replacing the input tag.

All elements come with additional options, that simplifies their use quite a bit. A good example are the <@field definitions, where each element are wrapped in containing rows and cells, labels added when defined and ids set automatically. The use of the SCIPIO elements largely simplify the creation of complexe forms and standardize the html output for visualization.

Navigation & Menus

Fri, 06 May 2016 00:00:00 +0000

standard/htmlNav.ftlNavigational elements that can be used to generate complexe menus, pagination controls or other navigation elements (magelan, step elements, breadcrumbs or alike). The usage should be largely simplified by the elements provided.

Included by htmlTemplate.ftl.

NOTES:

May have implicit dependencies on other parts of Scipio API.

Definitions:#

cmsmenu , isMenuMarkupItemsInline , makeMagTargetAttribMap , menu , menuitem , mli , mtarget , nav , paginate , step , treeitem , treemenu

Nav List#

macro `nav`#

Creates a navigation list, for example based on magellan-destination or breadcrumbs.

HTML & Script Wrappers

Fri, 06 May 2016 00:00:00 +0000

standard/htmlScript.ftlWrapping HTML, such as the boiler plate html head content or the javascript definition tags have been enhanced in order to strip templates from unneccessary information. Additional options are available for each element.

Included by htmlTemplate.ftl.

NOTES:

May have implicit dependencies on other parts of Scipio API.

Definitions:#

commonElemAttribStr , commonElemEventAttribStr , htmlHeadOpen , requireScriptOfbizUrl , script , scripts

HTML Head Open#

macro `htmlHeadOpen`#

Opens an HTML document and header section.

Utility Functions

Fri, 06 May 2016 00:00:00 +0000

utilities.ftlA set of standalone utility functions and macros, largely devoid of markup and independent from templating macros and styles and with minimal dependencies, part of standard Scipio Freemarker API. Generally CSS-framework-agnostic. Intended as platform-agnostic (html, fo, etc.) though some individually are only applicable for specific platforms. Automatically included at all times, for all themes, independently of theme markup override files.NOTES:

Macros expect to be called using named arguments, except where otherwise noted.

Template includes

Fri, 06 May 2016 00:00:00 +0000

standard/htmlTemplate.ftlA set of HTML templating macros, part of the standard Scipio Templating Toolkit for Freemarker language (https://freemarker.apache.org/docs/ ) – master include. Automatically included at all times, unless overridden by properties or themes. Intended to be swappable. Includes all other default Scipio standard markup macros.

Alongside this master include exists a global variables and styles definition file, htmlVariables.groovy, which defines global styles used by most macros and utilities (currently has no HTML documentation – mostly relevant to theme writers – see source).

Templating Toolkit on ScipioERP

Grid

Content Elements

Information & Notifications

Definitions:#

Modal#

macro modal#

Form Elements

Navigation & Menus

Definitions:#

Nav List#

macro nav#

HTML & Script Wrappers

Definitions:#

HTML Head Open#

macro htmlHeadOpen#

Utility Functions

Template includes

macro `modal`#

macro `nav`#

macro `htmlHeadOpen`#