WordPress.org
Get WordPress

Plugin Directory

Changeset 711082


Ignore:
Timestamp:
05/10/2013 08:55:39 PM (13 years ago)
Author:
setzer
Message:

Some minor updates to readme.txt

Location:
side-matter
Files:
2 edited

Legend:

Unmodified
Added
Removed

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

    r711075 r711082  
    4343= Does Side Matter work with responsive layouts? =
    4444
    45 Yes. The plugin includes an option, turned off by default, to enable sidenote re-positioning upon resize/zoom in responsive themes. Enable this feature using the Responsive Positioning control in Side Matter's options menu. (It's best to leave this feature disabled if your theme is not responsive; doing so will spare your readers the unnecessary script load on window resize and zoom.)
     45Yes. The plugin includes an option, turned off by default, to enable sidenote re-positioning upon resize/zoom in responsive themes. Enable this feature using the Responsive Positioning control in Side Matter's options menu. (It's best to leave this feature disabled if your theme is not responsive.)
    4646
    4747= My notes just sit at the top of the sidebar. =
    … …  
    5555= Why doesn't the plugin work with some themes? =
    5656
    57 Not all themes are built to support a major layout addition like Side Matter. While the plugin works well with most base themes featuring a sidebar (including Twenty Twelve, Twenty Ten, Responsive, and Toolbox), it isn't guaranteed to display notes perfectly within all layouts. In many cases, a little tinkering with note offset or CSS will fix the problem. If you have questions about implementing sidenotes within a particular theme, your best resource may be the theme author.
     57Not all themes are built to support the grafting-on of a substantial layout component like Side Matter. While the plugin works well with most base themes featuring a sidebar (including Twenty Twelve, Twenty Ten, Responsive, and Toolbox), it isn't guaranteed to display notes perfectly within all layouts. In many cases, a little tinkering with note offset or CSS will fix the problem. If you have ongoing questions about implementing sidenotes within a particular theme, though, your best resource may be the theme author.
    5858
    5959= Can sidenotes be displayed without using the widget? =
    … …  
    7676
    7777= 0.9 =
    78 * Added a link to Side Matter's options menu to its entry on the Installed Plugins screen.
    7978* Added a preview field to the options menu.
    80 * Added an option to display reference figures in Latin alphabet and Roman numeral formats.
     79* Added an option to display reference figures in alphabet and Roman numeral formats.
    8180* Added an option to set inline colors for Side Matter elements.
    82 * Reference numeral `a` tags have been given a `title` attribute for accessibility.
     81* Reference numeral link tags have been given a `title` attribute for accessibility.
    8382* Removed deprecated element classes `side-matter-ol` and `side-matter-li`. Numbered classes, e.g. `side-matter-sup-6`, are now deprecated.
    8483* Responsive positioning and fade effects are now turned off by default to spare inexperienced users the script load.
     84* Side Matter's options menu is now linked from its entry on the Installed Plugins screen.
    8585
    8686= 0.8 =
    … …  
    131131== Styling Side Matter with CSS ==
    132132
    133 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/).
    134 
    135  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.
    136 
    137 (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.)
     133As 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 basic familiarity with CSS; beginning users may wish to start with a [CSS tutorial](http://www.htmldog.com/guides/css/beginner/).
     134
     135 The easiest way to add custom styles to your site is to use a plugin that houses your custom CSS in the WordPress database, preserving it even when Side Matter (or your theme) is updated. [Jetpack Custom CSS](http://wordpress.org/extend/plugins/jetpack/) is a good example.
    138136
    139137Side 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:
    … …  
    143141    }
    144142
    145 Notes and references may be styled with greater precision using element-specific class selectors. The following rules will render reference and list numerals in red while leaving sidenote text black (see [Screenshots](http://wordpress.org/extend/plugins/side-matter/screenshots/) for a similar example):
     143Notes and references may be styled with greater precision using element-specific class selectors. The following rules will render reference and list numerals in red while leaving sidenote text black:
    146144
    147145    a.side-matter-ref, ol.side-matter-list {
    … …  
    172170
    173171= Default CSS =
    174 Side Matter sets a few rules by default in the stylesheet `side-matter.css`. These may be superseded by your theme stylesheet or custom CSS.
     172Note that inline color styles set in the Side Matter options menu will generally override any style rules you set in a custom CSS plugin or elsewhere. If you're planning to modify a element's `color` property in your stylesheets, remember to disable custom colors in the options menu!
     173
     174Side Matter also sets a few rules by default in the stylesheet `side-matter.css`. These may be readily superseded by your theme stylesheet or custom CSS.
    175175
    176176    a.side-matter-ref:link,
    … …  
    189189    }
    190190
    191 The above rules remove underlines from reference links and specify the appearance of superscript figures.
     191The above rules remove underlines from reference links (`text-decoration: none`) and specify a consistent, cross-theme appearance for superscript figures.
    192192
    193193= List of Class Selectors =

  • side-matter/trunk/readme.txt

    r711075 r711082  
    4343= Does Side Matter work with responsive layouts? =
    4444
    45 Yes. The plugin includes an option, turned off by default, to enable sidenote re-positioning upon resize/zoom in responsive themes. Enable this feature using the Responsive Positioning control in Side Matter's options menu. (It's best to leave this feature disabled if your theme is not responsive; doing so will spare your readers the unnecessary script load on window resize and zoom.)
     45Yes. The plugin includes an option, turned off by default, to enable sidenote re-positioning upon resize/zoom in responsive themes. Enable this feature using the Responsive Positioning control in Side Matter's options menu. (It's best to leave this feature disabled if your theme is not responsive.)
    4646
    4747= My notes just sit at the top of the sidebar. =
    … …  
    5555= Why doesn't the plugin work with some themes? =
    5656
    57 Not all themes are built to support a major layout addition like Side Matter. While the plugin works well with most base themes featuring a sidebar (including Twenty Twelve, Twenty Ten, Responsive, and Toolbox), it isn't guaranteed to display notes perfectly within all layouts. In many cases, a little tinkering with note offset or CSS will fix the problem. If you have questions about implementing sidenotes within a particular theme, your best resource may be the theme author.
     57Not all themes are built to support the grafting-on of a substantial layout component like Side Matter. While the plugin works well with most base themes featuring a sidebar (including Twenty Twelve, Twenty Ten, Responsive, and Toolbox), it isn't guaranteed to display notes perfectly within all layouts. In many cases, a little tinkering with note offset or CSS will fix the problem. If you have ongoing questions about implementing sidenotes within a particular theme, though, your best resource may be the theme author.
    5858
    5959= Can sidenotes be displayed without using the widget? =
    … …  
    7676
    7777= 0.9 =
    78 * Added a link to Side Matter's options menu to its entry on the Installed Plugins screen.
    7978* Added a preview field to the options menu.
    80 * Added an option to display reference figures in Latin alphabet and Roman numeral formats.
     79* Added an option to display reference figures in alphabet and Roman numeral formats.
    8180* Added an option to set inline colors for Side Matter elements.
    82 * Reference numeral `a` tags have been given a `title` attribute for accessibility.
     81* Reference numeral link tags have been given a `title` attribute for accessibility.
    8382* Removed deprecated element classes `side-matter-ol` and `side-matter-li`. Numbered classes, e.g. `side-matter-sup-6`, are now deprecated.
    8483* Responsive positioning and fade effects are now turned off by default to spare inexperienced users the script load.
     84* Side Matter's options menu is now linked from its entry on the Installed Plugins screen.
    8585
    8686= 0.8 =
    … …  
    131131== Styling Side Matter with CSS ==
    132132
    133 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/).
    134 
    135  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.
    136 
    137 (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.)
     133As 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 basic familiarity with CSS; beginning users may wish to start with a [CSS tutorial](http://www.htmldog.com/guides/css/beginner/).
     134
     135 The easiest way to add custom styles to your site is to use a plugin that houses your custom CSS in the WordPress database, preserving it even when Side Matter (or your theme) is updated. [Jetpack Custom CSS](http://wordpress.org/extend/plugins/jetpack/) is a good example.
    138136
    139137Side 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:
    … …  
    143141    }
    144142
    145 Notes and references may be styled with greater precision using element-specific class selectors. The following rules will render reference and list numerals in red while leaving sidenote text black (see [Screenshots](http://wordpress.org/extend/plugins/side-matter/screenshots/) for a similar example):
     143Notes and references may be styled with greater precision using element-specific class selectors. The following rules will render reference and list numerals in red while leaving sidenote text black:
    146144
    147145    a.side-matter-ref, ol.side-matter-list {
    … …  
    172170
    173171= Default CSS =
    174 Side Matter sets a few rules by default in the stylesheet `side-matter.css`. These may be superseded by your theme stylesheet or custom CSS.
     172Note that inline color styles set in the Side Matter options menu will generally override any style rules you set in a custom CSS plugin or elsewhere. If you're planning to modify a element's `color` property in your stylesheets, remember to disable custom colors in the options menu!
     173
     174Side Matter also sets a few rules by default in the stylesheet `side-matter.css`. These may be readily superseded by your theme stylesheet or custom CSS.
    175175
    176176    a.side-matter-ref:link,
    … …  
    189189    }
    190190
    191 The above rules remove underlines from reference links and specify the appearance of superscript figures.
     191The above rules remove underlines from reference links (`text-decoration: none`) and specify a consistent, cross-theme appearance for superscript figures.
    192192
    193193= List of Class Selectors =
Note: See TracChangeset for help on using the changeset viewer.