Manage static pages¶

Static pages and security configuration¶

As of version 2.2, AtoM now has advanced configuration settings that will allow a system administrator to enable htmlpurifier on static pages. htmlpurifier is:

…a standards-compliant HTML filter library written in PHP. HTML Purifier will not only remove all malicious code (better known as XSS) with a thoroughly audited, secure yet permissive whitelist, it will also make sure your documents are standards compliant, something only achievable with a comprehensive knowledge of W3C’s specifications.

By default, htmlpurifier is not turned on in AtoM, to allow a broad use of HTML and inline CSS on static pages. System administrators interested in enabling all possible security settings and mitigating the risk of XSS-based attack vectors can enable the library by altering the config/app.yml file. For more information, see:

• config/apps.yml
• Security

When the configuration is set to true, htmlpurifier will limit the available html elements to the following:

Tags allowed

'div', 'span', 'p',
'h1', 'h2', 'h3', 'h4', 'h5', 'h6',
'strong', 'em',
'abbr[title]', 'acronym', 'address',
'blockquote', 'cite', 'code',
'pre', 'br',
'a[href]', 'img[src]',
'ul', 'ol', 'li',
'dl', 'dt', 'dd',
'table', 'tr', 'td', 'th',
'tbody', 'thead', 'tfoot',
'col', 'colgroup', 'caption',
'b', 'i', 'tt',
'sub', 'sup', 'big', 'small', 'hr'

Attributes allowed

'class', 'title', 'src', 'href'

Back to top

Edit an existing static page¶

In AtoM, static pages, that is both the Home page and the About page can be edited by authenticated (i.e. logged-in) administrators or editors to reflect your own institution’s or network’s requirements.

This section contains instructions on how to edit static pages in AtoM. There are two ways to edit static pages - doing so via the Quick links menu in the main menu and selecting either “Home” or “About” from the drop-down menu is the easiest, but to accommodate different workflows, these static pages can also be edited by clicking the the Admin and selecting “Static pages” from the drop-down menu. This second option will route you to a “List” page, where all static pages in the application will be listed. Navigate to the static page you wish to edit by clicking on the blue menu name. Below are instructions to edit to the Home page and the About page.

For more information on navigating in AtoM, see Navigation in AtoM.

Add a new static page¶

In AtoM, new static pages can be added at any time by any authenticated (i.e. logged-in) administrator. Similar to both the Home page and the About page, you may wish to add a new static page in order to include permanent, or “timeless” content to your webpage. Static pages may be customized to offers users instructions or help in navigating the site (i.e. a “Help” page), provide contact information (i.e. a “Contact Us” page), or feature website content, categories, and/or contributors.

To add a new static page in AtoM:

1. Click the the Admin in the header bar and select “Static pages” from the drop-down menu.

2. You will be directed to a “List pages” page, where all static pages, including the Home page and the About page will be listed.

3. Click on the Add new button in the button block to be directed to the edit page for your new static page.

4. On loading, the edit page will display blank “Title”, Slug and “Content” fields. Add data as required.

   Tip

   The slug indicates the word, or sequence of words that will be visible to users in the URL link when they are navigating on a specific static page (e.g.: the slug in the URL www.artefactual.com/help is /help). The slug should be indicative of the content of that specific static page.

   When creating a new static page, the slug field can either be customized or left blank. If you choose to customize the slug, make the slug all lowercase, keep it short, and avoid accented characters (e.g.: “é”; “ñ”; “û”) and punctuation (e.g.: “!”; “;”; “…”). If you leave the field blank, AtoM will automatically generate a slug based on the “Title” you have indicated for your page (e.g.: If your “Title” is About Us, the slug for that static page will automatically be generated as …/about-us). Note that AtoM will automatically replace all accented characters with letters from the English alphabet and punctuation will either be removed or replaced by a dash “-” or percent-encoding (e.g.: If your “Title” is Instructions & More, the slug for that static page will automatically be generated as …/instructions%26more or …/instructions-more, unless otherwise indicated). The slug will also appear in the once blank “Slug” field and can be viewed when switching from the view page to the edit page of that static page.

   Warning

   A slug cannot be duplicated once it has been generated in AtoM. If you duplicate a slug, AtoM will automatically generate a “-2 (or the next subsequent number) at the end of the slug to distinguish it from the other one in the same name (e.g.: Two slugs titled information will result in the second of the two becoming information-2). If you remove an AtoM automatically generated slug from the slug field of a static page you’ve created, AtoM will not re-generate the original slug, regardless of whether or not the “Title” of your page has changed; rather, it will generate a new slug in the form of a series of letters and numbers. This should be avoided, as it creates confusion because it does not accurately indicate the content of that static page. To avoid this, simply enter a custom slug.

5. You can quit the creation process at any time by clicking the “Cancel” button in the button block; any changes made will not be saved. Note that simply navigating away from the page by any other means, without first clicking “Save” will also result in no new static page being created.

6. When you are finished creating your new static page, click the “Save” button in the button block.

You will be directed to the view page of the new static page where you can view your changes. The page can be edited again at any time.

Back to top

Add links to a new static page¶

Once a new static page has been created, a new link must also be created in order to allow users to navigate to the new static page. You can do this by either creating a link within one of the default static pages or by clicking Admin > Menus and clicking the Add new button in the button block or by linking the new static page to an existing menu.

This example shows a newly created “Contact Us” static page that has been added as a menu under the Quick links parent menu:

Here is the result of the above:

The information which will be needed when linking a new static page:

1. Name: an internal name which is not visible to users.
2. Label: how you wish the name of the page to appear in the menu.
3. Parent: which menu you wish the page to be linked from.
4. Path: in the format staticpage/index?slug=yourSlug. yourSlug is the slug you either created or had AtoM generate automatically for you when the page was created.
5. Description: an optional area to describe the purpose of the page.

For more information on managing menus in AtoM, see: Manage Menus.

Back to top

Styling static pages¶

Basic styling of static pages can be achieved by including HTML and inline CSS code to the “Content” field. There are plenty of online tutorials and resources out there for instruction on HTML and inline CSS use, but a few basic examples commonly employed by AtoM users have been included here as an example.

See below for instructions on how to create and edit:

• Headers and subtitles
• Hyperlinks
• Images
• Boxes and dividers

Headers and subtitles¶

To increase the size of a heading or subtitle, wrap the relevant text in <h3> </h3> tags, like so:

<h3>For more information, please contact</h3>.

This will produce the following results:

For larger headings, use smaller numbers, such as <h2> or <h1>. Similarly, for smaller headers, use <h4> or <h5>. To bold, italicize or underline headers and subtitles, simply wrap the relevant text in <strong></strong> for bold, <em> </em> for italics, or <u> </u> for underline. Typing <strong>Artefactual Systems Inc.</strong> will produce the following results:

Hyperlinks¶

To create external links on an AtoM static page, wrap the text you would like to act as a link in a hyperlink <a> </a> tag, and include the web address to which you would like the link to point, using the href=" " attribute - the http address would go in the quotations. Remember to close the element after the text you want to link.

For example, to include a link in the “Contact Us” page, the code would appear as such:

Website: <a href="https://www.accesstomemory.org/en/">AtoM : Open Source
Archival Description Software</a>

The above code would appear like this on the static page:

Images¶

If you have access to the server on which your AtoM instance is located (i.e., if you are hosting it yourself, or can ask the host provider to include a file for you), you can place images in a directory on the host server, and use a local URL to point to them. Images can then be used via the HTML <img> image element, where the src=" " attribute points to the path of the image, similar to how the hyperlinks are used above. For example, if you wanted an image of email, named “contact-image.jpg” included on your static “Contact Us” page, the code might look like this:

``<img src=".../path/to/contact-image.jpg">``

…where /path/to represents the internal URL path to the location of contact-image.jpg on your host server, or the path to a web-accessible image.

To center the image, you can wrap the <img> image element in a <div> element, with a text-center" class, like this:

<div class="text-center"><img src=".../path/to/contact-image.jpg"></div>

You can also reuse some of the existing image classes from Bootstrap, to further style your images. For example, you can round the corners with the img-rounded class:

<img class="img-rounded" src="../path/to/my-bunny-image.jpg">

Produces:

Make an image circular using the img-circle bootstrap class:

<img class="img-circle" src="../path/to/my-bunny-image.jpg">

Produces:

Or give your images a frame, like on our digital object browse page, using the img-polaroid class:

<img class="img-polaroid" src="../path/to/my-bunny-image.jpg">

Produces:

Tip

Resuing existing Bootstrap CSS classes is a good way to style elements when you have the htmlpurifier setting engaged - see above, Static pages and security configuration for more information.

Boxes and dividers¶

You can add styled boxes around text by wrapping content in the HTML <div> element, and then using inline CSS to modify the appearance of the box. For colors, use the HTML or RGB values for the color you would like to use, rather than generic names such as “red,” “blue,” etc. - most browsers support a limited pallette of colors using names such as this, and the results may be inconsistent across browsers. There are many free HTML color wheels available that allow you to choose a color and copy its HTML# or RGB values; for example: http://www.colorpicker.com/

For a small centered box with a green color, you might use code such as this:

<div style="width:600px; margin-left:right; margin-right:right; padding: 5px;
background-color:#39BF34; border:none;">Here is a list of ways that we can be
contacted with any questions or concerns you may have:</div>

This is how the box will appear:

Note

The above example will not work if you have htmlpurifier engaged in AtoM. For more information, see the section above, Static pages and security configuration for more information. The examples below, reusing existing Bootstrap classes, will work even when htmlpurifier is engaged.

Another example of this is the light yellow box that appears on the AtoM demo’s “Welcome” static page warning users that the data will reset every hour. This yellow box is reusing an existing style class from the Bootstrap CSS framework that AtoM uses - you can make use of existing Bootstrap classes to help with styling, like so:

<div style="alert">Welcome message appears here</div>

And here is the result:

Other Bootstrap alert classes that can be used to style containers include alert-success, alert-info, and alert-danger:

Back to top