aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Klinkovský <j.l.k@gmx.com>2014-02-15 20:35:55 +0100
committerJakub Klinkovský <j.l.k@gmx.com>2014-02-15 20:35:55 +0100
commitaff7cabd5fa16daff866c06e056804d3f6f42500 (patch)
tree9c81612ef756024dd205022d250fc65e2e11eb3a
parent87716ec3ab5b1e9e3c37d2fc5331ed95f3e311e9 (diff)
downloadmarkdown-aff7cabd5fa16daff866c06e056804d3f6f42500.tar.gz
markdown-aff7cabd5fa16daff866c06e056804d3f6f42500.tar.bz2
markdown-aff7cabd5fa16daff866c06e056804d3f6f42500.zip
docs: capitalization fixes, plural fixes, small wording improvements
-rw-r--r--docs/extensions/abbreviations.txt10
-rw-r--r--docs/extensions/admonition.txt4
-rw-r--r--docs/extensions/api.txt2
-rw-r--r--docs/extensions/attr_list.txt14
-rw-r--r--docs/extensions/code_hilite.txt8
-rw-r--r--docs/extensions/definition_lists.txt10
-rw-r--r--docs/extensions/extra.txt2
-rw-r--r--docs/extensions/fenced_code_blocks.txt12
-rw-r--r--docs/extensions/footnotes.txt7
-rw-r--r--docs/extensions/header_id.txt4
-rw-r--r--docs/extensions/index.txt5
-rw-r--r--docs/extensions/meta_data.txt4
-rw-r--r--docs/extensions/nl2br.txt8
-rw-r--r--docs/extensions/smart_strong.txt6
-rw-r--r--docs/extensions/tables.txt6
-rw-r--r--docs/extensions/toc.txt4
-rw-r--r--docs/extensions/wikilinks.txt4
17 files changed, 56 insertions, 54 deletions
diff --git a/docs/extensions/abbreviations.txt b/docs/extensions/abbreviations.txt
index e4c62f6..070bb01 100644
--- a/docs/extensions/abbreviations.txt
+++ b/docs/extensions/abbreviations.txt
@@ -1,7 +1,7 @@
-title: Abbreviation Extension
+title: Abbreviations Extension
prev_title: Extra Extension
prev_url: extra.html
-next_title: Attribute List Extension
+next_title: Attribute Lists Extension
next_url: attr_list.html
Abbreviations
@@ -10,10 +10,10 @@ Abbreviations
Summary
-------
-The Abbreviation Extension adds the ability to define abbreviations.
+The Abbreviations extension adds the ability to define abbreviations.
Specifically, any defined abbreviation is wrapped in an `<abbr>` tag.
-The Abbreviation extension is included in the standard Markdown library.
+The Abbreviations extension is included in the standard Markdown library.
Syntax
------
@@ -39,7 +39,7 @@ will be rendered as:
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `abbr`
+See [Extensions](index.html) for general extension usage, specify `abbr`
as the name of the extension.
This extension does not accept any special configuration options.
diff --git a/docs/extensions/admonition.txt b/docs/extensions/admonition.txt
index 61d410b..088b1fb 100644
--- a/docs/extensions/admonition.txt
+++ b/docs/extensions/admonition.txt
@@ -1,4 +1,4 @@
-title: Admonition
+title: Admonition Extension
prev_title: Smart Strong Extension
prev_url: smart_strong.html
next_title: CodeHilite Extension
@@ -10,7 +10,7 @@ Admonition
Summary
-------
-This extension adds [rST-style][rST] admonitions to Markdown documents.
+The Admonition extension adds [rST-style][rST] admonitions to Markdown documents.
This extension is included in the standard Markdown library.
diff --git a/docs/extensions/api.txt b/docs/extensions/api.txt
index ef256b8..715df6d 100644
--- a/docs/extensions/api.txt
+++ b/docs/extensions/api.txt
@@ -1,5 +1,5 @@
title: Extensions API
-prev_title: Wikilinks Extension
+prev_title: WikiLinks Extension
prev_url: wikilinks.html
next_title: Test Suite
next_url: ../test_suite.html
diff --git a/docs/extensions/attr_list.txt b/docs/extensions/attr_list.txt
index 1af1510..818fe53 100644
--- a/docs/extensions/attr_list.txt
+++ b/docs/extensions/attr_list.txt
@@ -1,7 +1,7 @@
-title: Attribute List Extension
-prev_title: Abbreviation Extension
+title: Attribute Lists Extension
+prev_title: Abbreviations Extension
prev_url: abbreviations.html
-next_title: Definition List Extension
+next_title: Definition Lists Extension
next_url: definition_lists.html
Attribute Lists
@@ -10,15 +10,15 @@ Attribute Lists
Summary
-------
-An extension to Python-Markdown that adds a syntax to define attributes on
-the various HTML elements in markdown's output.
+The Attribute Lists extension adds a syntax to define attributes on the various
+HTML elements in markdown's output.
This extension is included in the standard Markdown library.
Syntax
------
-The basic syntax was inspired by [Maruku][]'s Attribute List feature.
+The basic syntax was inspired by [Maruku][]'s Attribute Lists feature.
[Maruku]: http://maruku.rubyforge.org/proposal.html#attribute_lists
@@ -82,7 +82,7 @@ The above results in the following output:
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `attr_list`
+See [Extensions](index.html) for general extension usage, specify `attr_list`
as the name of the extension.
This extension does not accept any special configuration options.
diff --git a/docs/extensions/code_hilite.txt b/docs/extensions/code_hilite.txt
index cbbac96..2cdb123 100644
--- a/docs/extensions/code_hilite.txt
+++ b/docs/extensions/code_hilite.txt
@@ -10,7 +10,7 @@ CodeHilite
Summary
-------
-The CodeHilite Extension adds code/syntax highlighting to standard
+The CodeHilite extension adds code/syntax highlighting to standard
Python-Markdown code blocks using [Pygments][].
[Pygments]: http://pygments.org/
@@ -37,7 +37,7 @@ language. When that fails, the code block will display as un-highlighted code.
Syntax
------
-The CodeHilite Extension follows the same [syntax][] as regular Markdown code
+The CodeHilite extension follows the same [syntax][] as regular Markdown code
blocks, with one exception. The hiliter needs to know what language to use for
the code block. There are three ways to tell the hiliter what language the code
block contains and each one has a different result.
@@ -104,7 +104,7 @@ direct the reader's attention.
### When No Language is Defined ###
-CodeHilite is completely backward compatible so that if a code block is
+CodeHilite is completely backwards compatible so that if a code block is
encountered that does not define a language, the block is simply wrapped in
`<pre>` tags and output.
@@ -127,7 +127,7 @@ Lets see the source for that:
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `codehilite`
+See [Extensions](index.html) for general extension usage, specify `codehilite`
as the name of the extension.
See the [Library Reference](../reference.html#extensions) for information about
diff --git a/docs/extensions/definition_lists.txt b/docs/extensions/definition_lists.txt
index 3a62f6a..31e8601 100644
--- a/docs/extensions/definition_lists.txt
+++ b/docs/extensions/definition_lists.txt
@@ -1,7 +1,7 @@
-title: Definition List Extension
-prev_title: Attribute List Extension
+title: Definition Lists Extension
+prev_title: Attribute Lists Extension
prev_url: attr_list.html
-next_title: Fenced Code Block Extension
+next_title: Fenced Code Blocks Extension
next_url: fenced_code_blocks.html
Definition Lists
@@ -10,7 +10,7 @@ Definition Lists
Summary
-------
-The Definition List Extension adds the ability to create definition lists in
+The Definition Lists extension adds the ability to create definition lists in
Markdown documents.
This extension is included in the standard Markdown library.
@@ -47,7 +47,7 @@ will be rendered as:
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `def_list`
+See [Extensions](index.html) for general extension usage, specify `def_list`
as the name of the extension.
This extension does not accept any special configuration options.
diff --git a/docs/extensions/extra.txt b/docs/extensions/extra.txt
index ace7a57..b90d1b0 100644
--- a/docs/extensions/extra.txt
+++ b/docs/extensions/extra.txt
@@ -1,7 +1,7 @@
title: Extra Extension
prev_title: Extensions
prev_url: index.html
-next_title: Abreviation Extension
+next_title: Abreviations Extension
next_url: abbreviations.html
Python-Markdown Extra
diff --git a/docs/extensions/fenced_code_blocks.txt b/docs/extensions/fenced_code_blocks.txt
index b03c886..206f6da 100644
--- a/docs/extensions/fenced_code_blocks.txt
+++ b/docs/extensions/fenced_code_blocks.txt
@@ -1,5 +1,5 @@
-title: Fenced Code Block Extension
-prev_title: Definition List Extension
+title: Fenced Code Blocks Extension
+prev_title: Definition Lists Extension
prev_url: definition_lists.html
next_title: Footnotes Extension
next_url: footnotes.html
@@ -10,8 +10,8 @@ Fenced Code Blocks
Summary
-------
-This extension adds a secondary way to define code blocks which overcomes a few
-limitations of the indented code blocks.
+The Fenced Code Blocks extension adds a secondary way to define code blocks,
+which overcomes a few limitations of the indented code blocks.
This extension is included in the standard Markdown library.
@@ -96,12 +96,12 @@ The lines can be specified with PHP Extra's syntax:
[CodeHilite]: code_hilite.html
[Pygments]: http://pygments.org/
-[colon]: ./code_hilite.html#colons
+[colon]: code_hilite.html#colons
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `fenced_code`
+See [Extensions](index.html) for general extension usage, specify `fenced_code`
as the name of the extension.
This extension does not accept any special configuration options.
diff --git a/docs/extensions/footnotes.txt b/docs/extensions/footnotes.txt
index e3207a1..a18fb06 100644
--- a/docs/extensions/footnotes.txt
+++ b/docs/extensions/footnotes.txt
@@ -1,5 +1,5 @@
title: Footnotes Extension
-prev_title: Fenced Code Block Extension
+prev_title: Fenced Code Blocks Extension
prev_url: fenced_code_blocks.html
next_title: Tables Extension
next_url: tables.html
@@ -10,7 +10,8 @@ Footnotes
Summary
-------
-An extension to Python-Markdown that adds footnote syntax.
+The Footnotes extension adds syntax for defining footnotes in Markdown
+documents.
This extension is included in the standard Markdown library.
@@ -63,7 +64,7 @@ is indented consistently and any errors are more easily discernible by the autho
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `footnotes`
+See [Extensions](index.html) for general extension usage, specify `footnotes`
as the name of the extension.
See the [Library Reference](../reference.html#extensions) for information about
diff --git a/docs/extensions/header_id.txt b/docs/extensions/header_id.txt
index ce06f57..afa1fe1 100644
--- a/docs/extensions/header_id.txt
+++ b/docs/extensions/header_id.txt
@@ -35,7 +35,7 @@ Results in:
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `headerid`
+See [Extensions](index.html) for general extension usage, specify `headerid`
as the name of the extension.
See the [Library Reference](../reference.html#extensions) for information about
@@ -94,7 +94,7 @@ The following options are provided to configure the output:
Using with Meta-Data
--------------------
-The HeaderId Extension also supports the [Meta-Data](meta_data.html) Extension.
+The HeaderId extension also supports the [Meta-Data](meta_data.html) extension.
Please see the documentation for that extension for specifics. The supported
meta-data keywords are:
diff --git a/docs/extensions/index.txt b/docs/extensions/index.txt
index b71c2ec..d6d41df 100644
--- a/docs/extensions/index.txt
+++ b/docs/extensions/index.txt
@@ -79,8 +79,9 @@ Third Party Extensions
----------------------
Various individuals and/or organizations have developed extensions which they
-have made available to the public. A [list of third party
-extensions](https://github.com/waylan/Python-Markdown/wiki/Third-Party-Extensions)
+have made available to the public. A [list of third party extensions][list]
is maintained on the wiki for your convenience. The Python-Markdown team
offers no official support for these extensions. Please see the developer of
each extension for support.
+
+[list]: https://github.com/waylan/Python-Markdown/wiki/Third-Party-Extensions
diff --git a/docs/extensions/meta_data.txt b/docs/extensions/meta_data.txt
index bc34999..7ac24e2 100644
--- a/docs/extensions/meta_data.txt
+++ b/docs/extensions/meta_data.txt
@@ -51,7 +51,7 @@ document prior to any further processing by Markdown.
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `meta`
+See [Extensions](index.html) for general extension usage, specify `meta`
as the name of the extension.
This extension does not accept any special configuration options.
@@ -93,7 +93,7 @@ Compatible Extensions
---------------------
The following extensions are currently known to work with the Meta-Data
-Extension. The keywords they are known to support are also listed.
+extension. The keywords they are known to support are also listed.
* [HeaderId](header_id.html)
* `header_level`
diff --git a/docs/extensions/nl2br.txt b/docs/extensions/nl2br.txt
index 1ae8b0b..0fe20c3 100644
--- a/docs/extensions/nl2br.txt
+++ b/docs/extensions/nl2br.txt
@@ -4,13 +4,13 @@ prev_url: meta_data.html
next_title: Sane Lists Extension
next_url: sane_lists.html
-NL2BR Extension
-===============
+NL2BR
+=====
Summary
-------
-The NL2BR Extension will cause newlines to be treated as hard breaks; like
+The NL2BR extension will cause newlines to be treated as hard breaks; like
StackOverflow and [GitHub][] flavored Markdown do.
[Github]: http://github.github.com/github-flavored-markdown/
@@ -31,7 +31,7 @@ Example
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `nl2br`
+See [Extensions](index.html) for general extension usage, specify `nl2br`
as the name of the extension.
This extension does not accept any special configuration options.
diff --git a/docs/extensions/smart_strong.txt b/docs/extensions/smart_strong.txt
index aa34ed7..06b9c9a 100644
--- a/docs/extensions/smart_strong.txt
+++ b/docs/extensions/smart_strong.txt
@@ -10,11 +10,11 @@ Smart_Strong
Summary
-------
-The Smart_Strong Extension adds smarter handling of double underscores within
+The Smart_Strong extension adds smarter handling of double underscores within
words. This does for double underscores what [smart_emphasis][] does for single
underscores.
-The Smart_Strong Extension is included in the standard Markdown library.
+The Smart_Strong extension is included in the standard Markdown library.
[smart_emphasis]: ../reference.html#smart_emphasis
@@ -35,7 +35,7 @@ Example
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `smart_strong`
+See [Extensions](index.html) for general extension usage, specify `smart_strong`
as the name of the extension.
This extension does not accept any special configuration options.
diff --git a/docs/extensions/tables.txt b/docs/extensions/tables.txt
index 820d5a5..46e8437 100644
--- a/docs/extensions/tables.txt
+++ b/docs/extensions/tables.txt
@@ -1,4 +1,4 @@
-title: Table Extension
+title: Tables Extension
prev_title: Footnotes Extension
prev_url: footnotes.html
next_title: Smart Strong Extension
@@ -10,7 +10,7 @@ Tables
Summary
-------
-The Table Extension adds the ability to create tables in Markdown documents.
+The Tables extension adds the ability to create tables in Markdown documents.
This extension is included in the standard Markdown library.
@@ -52,7 +52,7 @@ will be rendered as:
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `tables`
+See [Extensions](index.html) for general extension usage, specify `tables`
as the name of the extension.
This extension does not accept any special configuration options.
diff --git a/docs/extensions/toc.txt b/docs/extensions/toc.txt
index 2204a9c..d13aadb 100644
--- a/docs/extensions/toc.txt
+++ b/docs/extensions/toc.txt
@@ -1,7 +1,7 @@
title: Table of Contents Extension
prev_title: SmartyPants Extension
prev_url: smarty.html
-next_title: Wikilinks Extension
+next_title: WikiLinks Extension
next_url: wikilinks.html
Table of Contents
@@ -44,7 +44,7 @@ would generate the following output:
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `toc`
+See [Extensions](index.html) for general extension usage, specify `toc`
as the name of the extension.
See the [Library Reference](../reference.html#extensions) for information about
diff --git a/docs/extensions/wikilinks.txt b/docs/extensions/wikilinks.txt
index 4f6f23b..ea694a8 100644
--- a/docs/extensions/wikilinks.txt
+++ b/docs/extensions/wikilinks.txt
@@ -46,7 +46,7 @@ becomes
Usage
-----
-See [Extensions](./index.html) for general extension usage, specify `wikilinks`
+See [Extensions](index.html) for general extension usage, specify `wikilinks`
as the name of the extension.
See the [Library Reference](../reference.html#extensions) for information about
@@ -111,7 +111,7 @@ Would cause all wikilinks to be assigned to the class `myclass`.
Using with Meta-Data extension
------------------------------
-The WikiLink Extension also supports the [Meta-Data](meta_data.html) Extension.
+The WikiLink extension also supports the [Meta-Data](meta_data.html) extension.
Please see the documentation for that extension for specifics. The supported
meta-data keywords are: