WordPress.org
Get WordPress

Plugin Directory

Changeset 742053


Ignore:
Timestamp:
07/17/2013 04:07:27 AM (12 years ago)
Author:
setzer
Message:

A few minor readme updates

Location:
side-matter
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • side-matter/tags/1.0/readme.txt

    r741998 r742053  
    11=== Side Matter ===
    22Contributors: setzer
    3 Tags: academic, annotation, annotations, bibliography, bibliographic, citation, citations, cite, commentary, endnote, endnotes, footnote, footnotes, note, notes, reference, references, scholar, shortcode, side, sidebar, sidenote, sidenotes, widget
     3Tags: academic, annotation, annotations, bibliography, bibliographic, citation, citations, cite, commentary, endnote, endnotes, footnote, footnotes, margin, matter, note, notes, ref, reference, references, scholar, scholarship, shortcode, side, sidebar, sidenote, sidenotes, widget
    44Requires at least: 3.0
    55Tested up to: 3.6
    … …  
    1212== Description ==
    1313
    14 Side Matter turns your footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Easily incorporate citations, digressions, and editorial remarks into the sidebar of a page or post with a simple-to-use shortcode and widget. Scholars, editors, and writers will find Side Matter of particular benefit.
    15 
    16 Sidenotes have a centuries-long history of use in printed texts, from the Geneva Bible to the works of Edward Tufte, and function equally well on the Web. Unlike hyperlinked footnotes, sidenotes don't require the user to click away from a page's main content to follow a reference; instead, they perch humbly and accessibly alongside the material to which they refer.
     14Side Matter turns your footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Easily incorporate citations, digressions, and editorial remarks into the sidebar of a page or post with a simple-to-use shortcode and widget. Scholars, editors, and writers of all kinds will find particular benefit in the plugin.
     15
     16Sidenotes have a centuries-long history of use in printed texts, from the Geneva Bible to the works of Edward Tufte. They function equally well on the Web: unlike hyperlinked footnotes, sidenotes don't require the user to click away from a page's main content to follow up a reference. Instead, they perch humbly and accessibly alongside the material to which they refer.
    1717
    1818Side Matter includes an options menu for toggling settings, as well as a set of built-in classes for [styling sidenotes and references with CSS](http://wordpress.org/extend/plugins/side-matter/other_notes/). The plugin works well with many popular base themes, including Twenty Twelve, Twenty Ten, Responsive, and Toolbox.
    … …  
    4747= My notes just sit at the top of the sidebar. =
    4848
    49 Your theme may not be linking `side-matter.js`, the script that aligns sidenotes. Check the page source to see if `side-matter.js` has been linked; if not, the plugin may not be compatible with your theme.
     49Your theme may not be linking `side-matter.js`, the script that aligns sidenotes. Check the page source to see if `side-matter.js` has been linked.
    5050
    5151= My notes appear at a regular vertical offset from their proper position. =
    … …  
    5555= Why doesn't the plugin work with some themes? =
    5656
    57 Not all themes are built to absorb a new layout component like Side Matter. The plugin works well with most base themes that incorporate a conventional sidebar, but it isn't guaranteed to display notes perfectly within all themes. Tinkering with note offset or CSS will fix most problems; in other cases, it's best to consult the theme author.
     57Not all themes are built to neatly absorb a layout addition like Side Matter. The plugin works well with most base themes that incorporate a conventional sidebar, but it isn't guaranteed to display notes perfectly within all themes. Tinkering with note offset or CSS will fix most problems; in other cases, it's best to consult the theme author.
    5858
    5959= Can sidenotes be displayed without using the widget? =
    … …  
    6767= Some numeral formats don't display properly in my browser. =
    6868
    69 Browser support for the CSS `armenian`, `georgian`, `hebrew`, and `lower-greek` list styles varies. ([See Web Platform Docs](http://docs.webplatform.org/wiki/css/properties/list-style-type) for compatibility tables.) Decimal, Latin, and Roman numerals enjoy wide support and can serve as reliable fallbacks.
     69Browser support for the CSS `armenian`, `georgian`, `hebrew`, and `lower-greek` list styles varies. (See [Web Platform Docs](http://docs.webplatform.org/wiki/css/properties/list-style-type) for compatibility specifics.) Decimal, Latin, and Roman numerals enjoy wide support and can serve as reliable fallbacks.
    7070
    7171== Screenshots ==
    … …  
    7878
    7979= 1.0 =
    80 * Added support for Armenian, Georgian, Greek, and Hebrew numeral formats, as well as the option to hide numeral figures.
    81 * Fixed two IE-specific bugs related to list numeral and `title` attribute display.
     80* Added support for Armenian, Georgian, Greek, and Hebrew numeral formats, as well as the option to hide numeral figures entirely.
     81* Fixed two IE-specific bugs related to proper display of `title` attributes and list numerals.
     82* Made various minor adjustments and fixes for appearance and performance.
    8283* Numbered classes have been removed.
    8384* Plugin is now localization-ready.
    … …  
    142143== Styling Side Matter with CSS ==
    143144
    144 As of version 0.9, Side Matter's options menu includes a color picker for rendering notes and figures in custom colors. Altering the appearance of Side Matter elements beyond this requires some tinkering with Cascading Style Sheets (CSS). This guide assumes some familiarity with CSS; if you're a beginner, start with a [tutorial](http://www.htmldog.com/guides/css/beginner/).
     145Side Matter's options menu allows you to render notes and figures in custom colors by way of the Iris color picker. Changing other aspects of Side Matter elements' appearance, such as typeface, indentation, or spacing, requires some tinkering with Cascading Style Sheets (CSS). This guide assumes some familiarity with CSS; if you're a beginner, start with a [tutorial](http://www.htmldog.com/guides/css/beginner/).
    145146
    146147 The simplest way to add custom styles to your site is to employ a plugin that houses your custom CSS in the WordPress database, thus preserving it even if Side Matter (or your theme) is updated. [Jetpack Custom CSS](http://wordpress.org/extend/plugins/jetpack/) is a good example.
    … …  
    148149(Note that inline color styles set in the Side Matter options menu will generally override any custom styles you set elsewhere. If you're planning to use a custom stylesheet as described here, be sure to disable custom colors in the options menu.)
    149150
    150 Side Matter comes with a set of built-in classes that make it easy to customize the appearance of sidenote and reference elements using [class selectors](http://www.htmldog.com/guides/css/intermediate/classid/). For example, all Side Matter elements may be styled at once using the class `side-matter`. The following rule will render all Side Matter content (reference numerals, sidenote numerals, and sidenote text) in blue:
     151Side Matter comes with a set of built-in classes that make it easy to customize the appearance of sidenote and reference elements using [class selectors](http://www.htmldog.com/guides/css/intermediate/classid/). For example, all Side Matter elements can be styled at once using the class `side-matter`. The following rule will render all Side Matter content (reference numerals, sidenote numerals, and sidenote text) in blue 12-pixel serif type:
    151152
    152153    .side-matter {
    153154        color: blue;
     155        font-family: serif;
     156        font-size: 12px;
    154157    }
    155158
    … …  
    164167    }
    165168
    166 In some cases, your custom CSS may fail to take effect because the theme CSS has a greater [specificity](http://www.htmldog.com/guides/css/intermediate/specificity/). There are ways around this. For example, if you can't modify the color of superscript reference links because your theme's rules have greater specificity, try overriding the theme stylesheet via nesting or an ID selector:
     169In some cases, your custom CSS may fail to take effect because the theme CSS carries greater [specificity](http://www.htmldog.com/guides/css/intermediate/specificity/). There are ways around this. For example, if you can't modify the color of superscript reference links because your theme's rules have greater specificity, try overriding the theme stylesheet's specificity with nesting or an ID selector:
    167170
    168171    .entry-content > p > a.side-matter.side-matter-ref {
    … …  
    174177    }
    175178
    176 The `!important` declaration should be used only in rare cases, but may resolve a stubborn CSS conflict where other methods have failed:
     179The `!important` declaration should be used only in rare cases, but may resolve a stubborn CSS conflict where other efforts have failed:
    177180
    178181    a.side-matter-ref {
    179182        color: red !important;
    180183    }
    181 
    182 A full list of included class and ID selectors may be found below.
    183184
    184185= List of Class Selectors =
    … …  
    191192* `li.side-matter-note` selects individual sidenote `li` (list item) elements. Target a specific note using the note's ID selector (e.g. `#note-6`).
    192193* `div.side-matter-text` selects the `div` elements that enclose sidenote text, but not sidenote list numerals. Use this to style sidenote text separately from sidenote numerals.
    193 * WordPress further wraps each note paragraph in a `p` tag. Because they are generated outside Side Matter, these `p` elements cannot be selected directly using the `side-matter` class. Instead, target them using a [child selector](http://www.htmldog.com/guides/css/advanced/selectors/), e.g. `div.side-matter-text > p`.
     194* WordPress further wraps each note paragraph in a `p` tag. Because they are generated outside Side Matter, these `p` elements cannot be selected directly using the `side-matter` class. Instead, target them indirectly with a [child selector](http://www.htmldog.com/guides/css/advanced/selectors/), e.g. `div.side-matter-text > p`.
    194195
    195196= Default CSS =
    196 Side Matter sets a few default rules by way of the stylesheet `side-matter.css`. These may be readily superseded by your theme stylesheet or custom CSS.
     197Side Matter sets a few default rules in the included stylesheet `css/side-matter.css`. Their low-specificity selectors allow these rules to be easily superseded by your theme stylesheet or custom CSS.
    197198
    198199The first rule removes underlines from reference numeral links:

  • side-matter/trunk/readme.txt

    r741998 r742053  
    11=== Side Matter ===
    22Contributors: setzer
    3 Tags: academic, annotation, annotations, bibliography, bibliographic, citation, citations, cite, commentary, endnote, endnotes, footnote, footnotes, note, notes, reference, references, scholar, shortcode, side, sidebar, sidenote, sidenotes, widget
     3Tags: academic, annotation, annotations, bibliography, bibliographic, citation, citations, cite, commentary, endnote, endnotes, footnote, footnotes, margin, matter, note, notes, ref, reference, references, scholar, scholarship, shortcode, side, sidebar, sidenote, sidenotes, widget
    44Requires at least: 3.0
    55Tested up to: 3.6
    … …  
    1212== Description ==
    1313
    14 Side Matter turns your footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Easily incorporate citations, digressions, and editorial remarks into the sidebar of a page or post with a simple-to-use shortcode and widget. Scholars, editors, and writers will find Side Matter of particular benefit.
    15 
    16 Sidenotes have a centuries-long history of use in printed texts, from the Geneva Bible to the works of Edward Tufte, and function equally well on the Web. Unlike hyperlinked footnotes, sidenotes don't require the user to click away from a page's main content to follow a reference; instead, they perch humbly and accessibly alongside the material to which they refer.
     14Side Matter turns your footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Easily incorporate citations, digressions, and editorial remarks into the sidebar of a page or post with a simple-to-use shortcode and widget. Scholars, editors, and writers of all kinds will find particular benefit in the plugin.
     15
     16Sidenotes have a centuries-long history of use in printed texts, from the Geneva Bible to the works of Edward Tufte. They function equally well on the Web: unlike hyperlinked footnotes, sidenotes don't require the user to click away from a page's main content to follow up a reference. Instead, they perch humbly and accessibly alongside the material to which they refer.
    1717
    1818Side Matter includes an options menu for toggling settings, as well as a set of built-in classes for [styling sidenotes and references with CSS](http://wordpress.org/extend/plugins/side-matter/other_notes/). The plugin works well with many popular base themes, including Twenty Twelve, Twenty Ten, Responsive, and Toolbox.
    … …  
    4747= My notes just sit at the top of the sidebar. =
    4848
    49 Your theme may not be linking `side-matter.js`, the script that aligns sidenotes. Check the page source to see if `side-matter.js` has been linked; if not, the plugin may not be compatible with your theme.
     49Your theme may not be linking `side-matter.js`, the script that aligns sidenotes. Check the page source to see if `side-matter.js` has been linked.
    5050
    5151= My notes appear at a regular vertical offset from their proper position. =
    … …  
    5555= Why doesn't the plugin work with some themes? =
    5656
    57 Not all themes are built to absorb a new layout component like Side Matter. The plugin works well with most base themes that incorporate a conventional sidebar, but it isn't guaranteed to display notes perfectly within all themes. Tinkering with note offset or CSS will fix most problems; in other cases, it's best to consult the theme author.
     57Not all themes are built to neatly absorb a layout addition like Side Matter. The plugin works well with most base themes that incorporate a conventional sidebar, but it isn't guaranteed to display notes perfectly within all themes. Tinkering with note offset or CSS will fix most problems; in other cases, it's best to consult the theme author.
    5858
    5959= Can sidenotes be displayed without using the widget? =
    … …  
    6767= Some numeral formats don't display properly in my browser. =
    6868
    69 Browser support for the CSS `armenian`, `georgian`, `hebrew`, and `lower-greek` list styles varies. ([See Web Platform Docs](http://docs.webplatform.org/wiki/css/properties/list-style-type) for compatibility tables.) Decimal, Latin, and Roman numerals enjoy wide support and can serve as reliable fallbacks.
     69Browser support for the CSS `armenian`, `georgian`, `hebrew`, and `lower-greek` list styles varies. (See [Web Platform Docs](http://docs.webplatform.org/wiki/css/properties/list-style-type) for compatibility specifics.) Decimal, Latin, and Roman numerals enjoy wide support and can serve as reliable fallbacks.
    7070
    7171== Screenshots ==
    … …  
    7878
    7979= 1.0 =
    80 * Added support for Armenian, Georgian, Greek, and Hebrew numeral formats, as well as the option to hide numeral figures.
    81 * Fixed two IE-specific bugs related to list numeral and `title` attribute display.
     80* Added support for Armenian, Georgian, Greek, and Hebrew numeral formats, as well as the option to hide numeral figures entirely.
     81* Fixed two IE-specific bugs related to proper display of `title` attributes and list numerals.
     82* Made various minor adjustments and fixes for appearance and performance.
    8283* Numbered classes have been removed.
    8384* Plugin is now localization-ready.
    … …  
    142143== Styling Side Matter with CSS ==
    143144
    144 As of version 0.9, Side Matter's options menu includes a color picker for rendering notes and figures in custom colors. Altering the appearance of Side Matter elements beyond this requires some tinkering with Cascading Style Sheets (CSS). This guide assumes some familiarity with CSS; if you're a beginner, start with a [tutorial](http://www.htmldog.com/guides/css/beginner/).
     145Side Matter's options menu allows you to render notes and figures in custom colors by way of the Iris color picker. Changing other aspects of Side Matter elements' appearance, such as typeface, indentation, or spacing, requires some tinkering with Cascading Style Sheets (CSS). This guide assumes some familiarity with CSS; if you're a beginner, start with a [tutorial](http://www.htmldog.com/guides/css/beginner/).
    145146
    146147 The simplest way to add custom styles to your site is to employ a plugin that houses your custom CSS in the WordPress database, thus preserving it even if Side Matter (or your theme) is updated. [Jetpack Custom CSS](http://wordpress.org/extend/plugins/jetpack/) is a good example.
    … …  
    148149(Note that inline color styles set in the Side Matter options menu will generally override any custom styles you set elsewhere. If you're planning to use a custom stylesheet as described here, be sure to disable custom colors in the options menu.)
    149150
    150 Side Matter comes with a set of built-in classes that make it easy to customize the appearance of sidenote and reference elements using [class selectors](http://www.htmldog.com/guides/css/intermediate/classid/). For example, all Side Matter elements may be styled at once using the class `side-matter`. The following rule will render all Side Matter content (reference numerals, sidenote numerals, and sidenote text) in blue:
     151Side Matter comes with a set of built-in classes that make it easy to customize the appearance of sidenote and reference elements using [class selectors](http://www.htmldog.com/guides/css/intermediate/classid/). For example, all Side Matter elements can be styled at once using the class `side-matter`. The following rule will render all Side Matter content (reference numerals, sidenote numerals, and sidenote text) in blue 12-pixel serif type:
    151152
    152153    .side-matter {
    153154        color: blue;
     155        font-family: serif;
     156        font-size: 12px;
    154157    }
    155158
    … …  
    164167    }
    165168
    166 In some cases, your custom CSS may fail to take effect because the theme CSS has a greater [specificity](http://www.htmldog.com/guides/css/intermediate/specificity/). There are ways around this. For example, if you can't modify the color of superscript reference links because your theme's rules have greater specificity, try overriding the theme stylesheet via nesting or an ID selector:
     169In some cases, your custom CSS may fail to take effect because the theme CSS carries greater [specificity](http://www.htmldog.com/guides/css/intermediate/specificity/). There are ways around this. For example, if you can't modify the color of superscript reference links because your theme's rules have greater specificity, try overriding the theme stylesheet's specificity with nesting or an ID selector:
    167170
    168171    .entry-content > p > a.side-matter.side-matter-ref {
    … …  
    174177    }
    175178
    176 The `!important` declaration should be used only in rare cases, but may resolve a stubborn CSS conflict where other methods have failed:
     179The `!important` declaration should be used only in rare cases, but may resolve a stubborn CSS conflict where other efforts have failed:
    177180
    178181    a.side-matter-ref {
    179182        color: red !important;
    180183    }
    181 
    182 A full list of included class and ID selectors may be found below.
    183184
    184185= List of Class Selectors =
    … …  
    191192* `li.side-matter-note` selects individual sidenote `li` (list item) elements. Target a specific note using the note's ID selector (e.g. `#note-6`).
    192193* `div.side-matter-text` selects the `div` elements that enclose sidenote text, but not sidenote list numerals. Use this to style sidenote text separately from sidenote numerals.
    193 * WordPress further wraps each note paragraph in a `p` tag. Because they are generated outside Side Matter, these `p` elements cannot be selected directly using the `side-matter` class. Instead, target them using a [child selector](http://www.htmldog.com/guides/css/advanced/selectors/), e.g. `div.side-matter-text > p`.
     194* WordPress further wraps each note paragraph in a `p` tag. Because they are generated outside Side Matter, these `p` elements cannot be selected directly using the `side-matter` class. Instead, target them indirectly with a [child selector](http://www.htmldog.com/guides/css/advanced/selectors/), e.g. `div.side-matter-text > p`.
    194195
    195196= Default CSS =
    196 Side Matter sets a few default rules by way of the stylesheet `side-matter.css`. These may be readily superseded by your theme stylesheet or custom CSS.
     197Side Matter sets a few default rules in the included stylesheet `css/side-matter.css`. Their low-specificity selectors allow these rules to be easily superseded by your theme stylesheet or custom CSS.
    197198
    198199The first rule removes underlines from reference numeral links:
Note: See TracChangeset for help on using the changeset viewer.