Creating a handbook page

All changes to documentation made at om.civicpixel.com are automatically propagated to all stations using OM Handbooks. In order to create a new page to for a handbook, the page must be added to om.civicpixel.com and the same child page must be created on the station's website with some specific PHP code.

At om.civicpixel.com.
Navigate to Handbooks.
Create a child page, add a title and content, save content.
Please take note of page's URL.

At station's website.
Navigate to Handbooks.
Create a child page, add a title.
Add <?php om_localize_documentation('PAGE_URL'); ?> to page body.

Example of body text for handbook page on station's website;
<?php om_localize_documentation('http://om.civicpixel.com/handbooks/content-administration-guide/importing-equipment'); ?>

Adding Images to Handbook Pages

Images need to be uploaded into a common directory so that each location can eventually download that directory and 'delocalize' the documentation.  When uploading images using IMCE, select the handbooks directory before uploading.

Scale images inserted into Handbook pages to approximately 75% so they aren't confused with actual HTML.

Version specific documentation

When adding documentation that only applies to a specific version of a module, wrap the documentation in the following code.

<div class="v2"><div>
This does x,y, and z.
</div></div>

Until the new version becomes the supported version, it will appear formatted like this.