=== Side Matter === Contributors: setzer Tags: footnote, footnotes, endnote, endnotes, sidenote, sidenotes, annotation, annotations, citation, citations, shortcode, widget Requires at least: 3.2 Tested up to: 3.5.1 Stable tag: 0.6 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html Side Matter turns your footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. == Description == Side Matter turns your footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Its easy-to-use shortcode and widget make it a lightweight, visually elegant tool for annotating WordPress posts and pages. Like marginal notes in a printed text, Side Matter notes are well-suited for citations, digressions, commentary, and cross-references. The effect is similar to that used for sidebar notes by Grantland and other websites. To use, simply place the Side Matter widget in your sidebar, then enclose sidenote text in a page or post using the `[ref]` shortcode, like so: > Here's the text to annotate.`[ref]`Sidenote text goes here.`[/ref]` Side Matter works well with many popular base themes, such as Twenty Twelve, Twenty Ten, Responsive, and Toolbox. The appearance of sidenotes and references can be easily customized by editing the stylesheet `side-matter/side-matter.css` or by copying its contents to your theme's stylesheet and modifying as needed. == Installation == 1. Upload the `side-matter` directory to your `wp-content/plugins` directory. 2. Activate Side Matter using your dashboard's Plugins menu. 3. Using your dashboard's Widgets menu, place the Side Matter widget in a sidebar used by your pages and/or posts. 4. You may now use the `[ref]` shortcode to generate sidenotes in a page or post, like so: > Here's the text to annotate.`[ref]`Sidenote text goes here.`[/ref]` == Frequently Asked Questions == = Does Side Matter work with responsive themes? = Yes. By default, Side Matter will automatically re-position sidenotes to their proper places when the browser window is resized or zoomed. To disable this function, set the value of `var isResponsive` in `side-matter/side-matter.js` to `false`. = My notes don't appear in the sidebar. = Be sure you've placed the Side Matter widget in the sidebar that appears on your pages and posts. (By default, sidenotes and references only appear on the permalinked, full version of a page or post — not on the front page of your site or in search results.) You'll also want to make sure that your theme's stylesheet is not interfering with the display of your notes. If your notes still aren't showing up, Side Matter may be incompatible with your current theme. = My notes appear in the sidebar, but they're bunched together instead of aligned with their references in the text. = Your theme may not be loading `side-matter/side-matter.js`, the script that aligns Side Matter notes. Be sure your theme templates include calls to `wp_head()` and `wp_footer()`; otherwise, the files required to display Side Matter notes will not load properly. = My notes appear at a consistent vertical offset from their corresponding references in the text. = In some cases, theme structure causes notes to appear at a regular vertical offset from their proper position. To correct this problem, modify the value (in px) of `var noteAdjust` in the file `side-matter/side-matter.js`. Positive values push sidenotes up; negative values push sidenotes down. = How do I modify the appearance of sidenote list numerals without also restyling sidenote text? = The stylesheet `side-matter/side-matter.css` includes instructions for styling sidenote numerals and text separately. In short, styles applied to the `ol.side-matter` or `li.side-matter` tags will target list numerals; styles applied to the `span.side-matter` tag will affect sidenote text. = Can I display Side Matter notes without using the widget? = Yes. To display sidenotes outside of the Side Matter widget, use the custom action `side_matter_list_notes` in your templates as seen below. Note that by default, Side Matter notes are enabled only on single posts and pages. == Screenshots == 1. Side Matter captures footnote text using the [ref] shortcode, then automatically positions each footnote alongside its corresponding reference. == Changelog == = 0.6 = * Expanded plugin documentation. * Rewrote `side-matter.php`, simplifying and consolidating code for future development. * Sidenote numerals can now be styled separately from sidenote text. * Streamlined CSS classes and jQuery selectors. * Widget markup now better follows WordPress convention. = 0.5 = * Fixed a class instantiation error that was preventing plugin activation for some users. = 0.4 = * Initial release. == Upgrade Notice == = 0.6 = This update includes a number of tweaks and fixes, including improved classes for CSS and separate styling for sidenote numerals. Users who have customized their copy of `side-matter.css` are advised to make a backup copy before downloading. = 0.5 = This update fixes an error that was preventing plugin activation for some users. Recommended. == For Theme Authors == As an alternative to the Side Matter widget, theme authors may use the custom action `side_matter_list_notes` in their templates: This generates an ordered list of Side Matter notes (without the `div` that encloses the widget). If using Side Matter with a custom theme, note that your theme templates must include calls to `wp_head()` and `wp_footer()` to properly enable the plugin. Detailed information about styling Side Matter elements with a range of class selectors may be found in the stylesheet `side-matter/side-matter.css`.