From 0b33623111a587e78e93e37285a2da688f121d1b Mon Sep 17 00:00:00 2001 From: Jason Yundt Date: Aug 03 2021 14:53:40 +0000 Subject: Make quotation marks more consistent Before this change, this documentation in this repo would present the reader with both U+0022 and U+201D quotation marks. The documentation should always present U+0022 when it’s required for technical reasons (i.e., bash commands). To be consistent, when U+0022 isn’t required, the documentation should either 1. always present U+0022 QUOTATION MARKs at the beginning and end of quotations or 2. always present a U+201C LEFT DOUBLE QUOTATION MARK at the beginning and always present a U+201D RIGHT DOUBLE QUOTATION MARK at the end of quotations. I chose option 2 because Unicode says that it’s preferred.[1] The correct way to implement this choice (unfortunately) depends on which file in this repo we’re looking at. For AsciiDoc, I decided to use substitution. I could have included the Unicode characters directly, but including characters that aren’t on most keyboards seems to go against AsciiDoc’s philosophy. AsciiDoc is supposed to be easy to write.[2] Plus, including non-ASCII characters in AsciiDoc just seems wrong. For Markdown, I just included the Unicode characters directly since Markdown is meant to look good even before it’s been converted to another format.[3] Links: 1. https://www.unicode.org/charts/PDF/U0000.pdf#page=3 2. https://asciidoctor.org/docs/what-is-asciidoc/#the-zen-of-writing-asciidoc 3. https://daringfireball.net/projects/markdown/ --- diff --git a/README.md b/README.md index 82ad1f6..75928aa 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Fedora Modularity Docs Please report Issues and submit Pull Requests for **Content Fixes** here. -Never done a pull request (or "PR")? Here's the [Pagure documentation for +Never done a pull request (or “PR”)? Here's the [Pagure documentation for Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html). diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 0af771a..e8a7be5 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -13,7 +13,7 @@ We also preserve older documentation on this site for historical interest and to In 1997, Richard Stallman wrote: ____ -"The biggest deficiency in free operating systems is not in the software — it is the lack of good free manuals that we can include in these systems.”footnote:[Free Software and Free Manuals, available from link:http://www.gnu.org/philosophy/free-doc.html[]] +"`The biggest deficiency in free operating systems is not in the software — it is the lack of good free manuals that we can include in these systems.`"footnote:[Free Software and Free Manuals, available from link:http://www.gnu.org/philosophy/free-doc.html[]] ____ We thank everybody who worked hard to correct that deficiency for previous versions of Fedora.