ebellempire / CTCGuides

An Omeka plugin that adds shortcodes for displaying a list of Simple Pages sub-pages and adding a generated table of contents with back-to-top links. Created specifically for the Cleveland Teaching Collaborative to manage content guides using the default Simple Pages interface.

CTC Guides

An Omeka plugin that adds shortcodes for displaying a list of Simple Pages sub-pages and adding a generated table of contents with back-to-top links. Created specifically for the Cleveland Teaching Collaborative to manage content guides using the default Simple Pages interface.

adapted from @ebellempire/BlogShortcode

Using the [guides] Shortcode

Create a simple page to use as a the parent (for example, a page with the title of "Guides" and the slug "guides"). The slug is important because it will be the main way you control which posts appear. Create a listing of "posts" by adding new simple pages and organizing them as children of the chosen "blog" page (for instance, setting the "parent page" to "Guides"). Add the [guides] shortcode to the page you want to serve as your guide directory. See options below.

Options

• parent: the slug of the parent page whose child pages should be displayed. String (default is current page)
• number: the max. number of child pages to display. Number (default is 10)
• length: the length of the text snippet (excerpt) for each child page. Number (default is 500)
• author: sets whether to display the name of the user who created the page. Boolean (default is true)
• date: sets whether to display the date the page was created. Boolean (default is true)
• more: sets whether to display the "read more" link after the text snippet. Boolean (default is true)

NOTE: Only Simple Pages marked as "public" will appear in the generated output.

Example with no options

[guides]

Placing this on a simple page will display all children of that page as a detailed list, with the most recently-added at the top.

Example with all options

[guides parent="guides" number="10" length="200" author="false" date="true" more="true"]

This example will diplay the 10 most recent children of the page that has the slug guides. Each entry will display a date in the byline but not an author and the text snippet for each entry will be 200 characters long, etc.

Usage outside of Simple Pages

Theme developers may add support for usage anywhere on their Omeka site. For example, you could create a section on the homepage called Recent Guides and add the following to your homepage or other theme template.

<?php
echo $this->shortcodes([guides parent="guides" number="10" length="200" author="false" date="true" more="true"]);
?>

Using the [toc] Shortcode

This one is simple. Just put [toc] anywhere on a page that is structured using H2 elements and that area will display a linked table of contents for the page.Each H2 will be given a unique id (careful, it will replace existing ids) and a "back to top" link will be appended after the H2. Basically, the result is like a standard old-school FAQ.

Using the [banner] Shortcode

This shortcode can be used to create responsive banner images. The image is output as the background-image inside a <figure> element with <figcaption> containing optional caption text and link to the image's original source.

Options

• src: the location of the image file. URL (required)
• caption: a caption for the image. String (optional)
• source: a source where the user can learn more about the image. URL (optional)

Example with only the required src option

[banner src="https://example.com/image.jpg"]

Example with all options

[banner src="https://example.com/image.jpg" caption="An adorable kitten." source="https://example.com"]

Other Notes

Styles

Note that this plugin does not ship with any CSS. If you don't like the way something looks, you can address it in your theme's stylesheet.

JavaScript

Note that tables of contents are generated using JavaScript. The selector for getting all the H2s is .primary article h2 meaning your H2s need to be inside an <article> that is inside a container with the class of primary. If that's not the case in your Omeka theme, you can edit your theme templates or you can edit the ctc_toc.js file. For now, I'm not making this (non-developer) configurable.

If the user doesn't have JavaScript enabled or if there's some sort of error, the page will just look ... normal. No table of contents. Not a big deal. If something isn't working, please check the browser console for obvious content errors (like not having any H2s on the page) before reporting a bug.

Screenshots

add [toc] to any SimplePage that is structured with H2s

add [guides] to a SimplePage or $this->shortcodes([guides]) to any theme template

add [banner] to a SimplePage