Changeset 762112

Timestamp:

08/25/2013 09:09:50 PM (12 years ago)

Author:

setzer

Message:

A few minor readme tweaks

Location:

side-matter

Files:

• tags/1.2/readme.txt (modified) (6 diffs)
• trunk/readme.txt (modified) (6 diffs)

side-matter/tags/1.2/readme.txt

@@ -1 +1 @@
 === Side Matter ===
 Contributors: setzer
-Tags: academic, annotation, annotations, bibliography, bibliographic, citation, citations, cite, commentary, endnote, endnotes, footnote, footnotes, margin, marginal, matter, note, notes, ref, reference, references, scholar, scholarship, shortcode, side, sidebar, sidenote, sidenotes, widget
+Tags: academic, annotate, annotation, annotations, bibliography, bibliographic, citation, citations, cite, commentary, endnote, endnotes, footnote, footnotes, margin, marginal, matter, note, notes, ref, reference, references, scholar, scholarship, shortcode, side, sidebar, sidenote, sidenotes, widget
 Requires at least: 3.0
 Tested up to: 3.6
@@ -12 +12 @@
 == Description ==
 
-Side Matter turns footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Easily add citations, digressions, or editorial remarks to pages and posts with a simple shortcode and widget. Writers, editors, and scholars will find the plugin of particular use.
+Side Matter turns footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Easily add citations, digressions, or editorial remarks to pages and posts with a simple shortcode and widget. Scholars, editors, and writers of all kinds will find the plugin of particular use.
 
-Margin notes have been used in printed texts for centuries. They function equally well on the Web, perching humbly and accessibly beside the lines to which they refer.
+Sidenotes have been used in printed texts for centuries, and are equally well suited to the Web. Unlike hyperlinked footnotes or endnotes, sidenotes do not require a jump down the page to pursue each reference; instead, they perch humbly and accessibly beside the lines to which they refer.
 
 Side Matter includes an options menu as well as a set of built-in classes for [styling with CSS](http://wordpress.org/extend/plugins/side-matter/other_notes/). To use, place the Side Matter widget in your sidebar, then enclose sidenote text in a page or post using the `[ref]` shortcode, like so:
@@ -43 +43 @@
 = My notes just sit at the top of the sidebar. =
 
-This usually happens when your theme has not loaded `side-matter/js/side-matter.js`, the script that aligns sidenotes. Check the page source to make sure that `side-matter.js` has been linked. (Theme templates must include calls to [`wp_head`](http://codex.wordpress.org/Function_Reference/wp_head) and [`wp_footer`](http://codex.wordpress.org/Function_Reference/wp_footer) to work with Side Matter.)
+This most commonly occurs when your theme has not loaded `side-matter/js/side-matter.js`, the script that aligns sidenotes. Check the page source to make sure that `side-matter.js` has been linked. (If you're developing a custom theme, your templates must include calls to [`wp_head`](http://codex.wordpress.org/Function_Reference/wp_head) and [`wp_footer`](http://codex.wordpress.org/Function_Reference/wp_footer) to load plugin assets.)
 
 = My notes appear at a vertical offset from their proper position. =
@@ -51 +51 @@
 = Some numeral figures don't display properly in my browser. =
 
-Browser support for the CSS `armenian`, `georgian`, `lower-greek`, `hebrew`, `hiragana`, and `katakana` list styles varies. (See [Web Platform Docs](http://docs.webplatform.org/wiki/css/properties/list-style-type) for more information.) Use Decimal, Latin, or Roman figures if this becomes a problem.
+Browser support for the CSS `armenian`, `georgian`, `lower-greek`, `hebrew`, `hiragana`, and `katakana` list styles is not universal. (See the [`list-style-type` documentation on Web Platform Docs](http://docs.webplatform.org/wiki/css/properties/list-style-type#Compatibility_notes) for more information.) Use Decimal, Latin, or Roman figures if this becomes a problem.
 
 = Why doesn't the plugin work with my theme? =
@@ -71 +71 @@
 == Screenshots ==
 
-1. Side Matter uses a simple shortcode and widget to magically place each note in the sidebar beside its corresponding reference in the text.
+1. Side Matter extracts note text with a shortcode, then magically places each note in the sidebar beside its corresponding reference in the text.
 
 2. Modify default settings using Side Matter's options menu on the Reading Settings screen.
@@ -147 +147 @@
     }
 
-Notes and references may be styled with greater precision using element-specific class selectors. The following pair of rules will render reference and list numerals in red while leaving sidenote text black:
+Notes and references may be styled with greater precision using element-specific class selectors. The following pair of rules will render reference and list numerals in red and sidenote text in black:
 
     a.side-matter-ref, ol.side-matter-list {

side-matter/trunk/readme.txt

@@ -1 +1 @@
 === Side Matter ===
 Contributors: setzer
-Tags: academic, annotation, annotations, bibliography, bibliographic, citation, citations, cite, commentary, endnote, endnotes, footnote, footnotes, margin, marginal, matter, note, notes, ref, reference, references, scholar, scholarship, shortcode, side, sidebar, sidenote, sidenotes, widget
+Tags: academic, annotate, annotation, annotations, bibliography, bibliographic, citation, citations, cite, commentary, endnote, endnotes, footnote, footnotes, margin, marginal, matter, note, notes, ref, reference, references, scholar, scholarship, shortcode, side, sidebar, sidenote, sidenotes, widget
 Requires at least: 3.0
 Tested up to: 3.6
@@ -12 +12 @@
 == Description ==
 
-Side Matter turns footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Easily add citations, digressions, or editorial remarks to pages and posts with a simple shortcode and widget. Writers, editors, and scholars will find the plugin of particular use.
+Side Matter turns footnotes into sidenotes, magically aligning each note in the sidebar next to its corresponding reference in the text. Easily add citations, digressions, or editorial remarks to pages and posts with a simple shortcode and widget. Scholars, editors, and writers of all kinds will find the plugin of particular use.
 
-Margin notes have been used in printed texts for centuries. They function equally well on the Web, perching humbly and accessibly beside the lines to which they refer.
+Sidenotes have been used in printed texts for centuries, and are equally well suited to the Web. Unlike hyperlinked footnotes or endnotes, sidenotes do not require a jump down the page to pursue each reference; instead, they perch humbly and accessibly beside the lines to which they refer.
 
 Side Matter includes an options menu as well as a set of built-in classes for [styling with CSS](http://wordpress.org/extend/plugins/side-matter/other_notes/). To use, place the Side Matter widget in your sidebar, then enclose sidenote text in a page or post using the `[ref]` shortcode, like so:
@@ -43 +43 @@
 = My notes just sit at the top of the sidebar. =
 
-This usually happens when your theme has not loaded `side-matter/js/side-matter.js`, the script that aligns sidenotes. Check the page source to make sure that `side-matter.js` has been linked. (Theme templates must include calls to [`wp_head`](http://codex.wordpress.org/Function_Reference/wp_head) and [`wp_footer`](http://codex.wordpress.org/Function_Reference/wp_footer) to work with Side Matter.)
+This most commonly occurs when your theme has not loaded `side-matter/js/side-matter.js`, the script that aligns sidenotes. Check the page source to make sure that `side-matter.js` has been linked. (If you're developing a custom theme, your templates must include calls to [`wp_head`](http://codex.wordpress.org/Function_Reference/wp_head) and [`wp_footer`](http://codex.wordpress.org/Function_Reference/wp_footer) to load plugin assets.)
 
 = My notes appear at a vertical offset from their proper position. =
@@ -51 +51 @@
 = Some numeral figures don't display properly in my browser. =
 
-Browser support for the CSS `armenian`, `georgian`, `lower-greek`, `hebrew`, `hiragana`, and `katakana` list styles varies. (See [Web Platform Docs](http://docs.webplatform.org/wiki/css/properties/list-style-type) for more information.) Use Decimal, Latin, or Roman figures if this becomes a problem.
+Browser support for the CSS `armenian`, `georgian`, `lower-greek`, `hebrew`, `hiragana`, and `katakana` list styles is not universal. (See the [`list-style-type` documentation on Web Platform Docs](http://docs.webplatform.org/wiki/css/properties/list-style-type#Compatibility_notes) for more information.) Use Decimal, Latin, or Roman figures if this becomes a problem.
 
 = Why doesn't the plugin work with my theme? =
@@ -71 +71 @@
 == Screenshots ==
 
-1. Side Matter uses a simple shortcode and widget to magically place each note in the sidebar beside its corresponding reference in the text.
+1. Side Matter extracts note text with a shortcode, then magically places each note in the sidebar beside its corresponding reference in the text.
 
 2. Modify default settings using Side Matter's options menu on the Reading Settings screen.
@@ -147 +147 @@
     }
 
-Notes and references may be styled with greater precision using element-specific class selectors. The following pair of rules will render reference and list numerals in red while leaving sidenote text black:
+Notes and references may be styled with greater precision using element-specific class selectors. The following pair of rules will render reference and list numerals in red and sidenote text in black:
 
     a.side-matter-ref, ol.side-matter-list {