Structured Headings¶

Features¶

• Simplifies the process of adding headings to a document. Instead of having to choose between a heading 1-6 in the containers panel, those options are replaced with one single “Heading” option that inserts a heading at the same level as the preceding heading in the document.
• Makes it easier to adjust heading levels properly. In order to change the level of a heading, the indent and outdent tools can be used to lower and raise the level of the heading respectively. The indent tool will also prevent a user from indenting a heading more than one level below its preceding heading.
• Automatically numbers headings to better outline a document.
• Provides an optional tool that can be used to automatically fix improper heading structure in a document (although it’s still in development).
• More features to come on further development.

Applying Structured Headings Styling outside of the Editor¶

The numbering added to headings in the editor is not parsed with the content of the document, but rather, it is added as styling using CSS in IE8+, Chrome, and Firefox, or it is added as separate content using a stand-alone JavaScript function with additional CSS styling in IE7.

To apply the heading numbering to a document outside of the editor, follow these steps:

1. Get the CSS for the structured headings. If you are using IE8+, Chrome, or Firefox, enter the WYMeditor.printStructuredHeadingsCSS() command in the browser console on the page of the editor using the structured headings plugin to print the CSS to the console. If you are using IE7, it uses different CSS than the other browsers, and you can get this CSS from its stylesheet structured_headings_ie7_user.css available in the plugin’s directory.

2. Either copy this CSS to an existing stylesheet or make a new stylesheet with this CSS.

3. Apply the stylesheet with the CSS to all of the pages that contain documents that had heading numbering added to them in the editor.

4. If you are using IE7, in addition to the previous steps, add the script jquery.wymeditor.structured_headings.js available in the plugin’s directory to all of the pages that contain documents that had heading numbering added to them in the editor. This script provides the function numberHeadingsIE7() which detects which headings on the page were assigned numbering in WYMeditor and adds the numbering for these headings into the page. This function should be called in a script on document ready after the jquery.wymeditor.structured_headings.js script is included on the page. Here is an example of what that script should look like:

   jQuery(document).ready(function() { numberHeadingsIE7(); });
   

Browser Support¶

The plugin supports IE7+, Chrome, and Firefox, but it works less conveniently in IE7 as you can see by the additional steps it requires for implementation in that browser.