documentation formatting: Sun May 26 20:58:52 UTC 2019

COMMUNITY.org

@@ -45,7 +45,7 @@ We want the community to be judged based on its moderation actions instead of
 telling people how to behave. The golden rules of the community are to have good
 intentions and stay focused on the project, for anything else that requires
 moderation any future user or contributor can refer to this section to know
-about our past moderation actions. So readers won’t find any example or
+about our past moderation actions. So readers won't find any example or
 definition of what collaborators judge offending or outrageous, instead they
 will find at the end of this section a log of all major moderation actions taken
 by the collaborators since the beginning of the project which started officially
@@ -89,7 +89,7 @@ These guidelines apply to all collaborators of the project, namely @syl20bnr,
     EDIT: [@moderator] action (reason: xxx)
   #+END_EXAMPLE
 
-- The reason is added only when needed (for instance we won’t add a reason for
+- The reason is added only when needed (for instance we won't add a reason for
   formatting edits)
 
 ** Interpretation
@@ -121,4 +121,4 @@ moderation actions have been taken:
 | Date       | Moderator | Action | Issue | Reason                                                          |
 |------------+-----------+--------+-------+-----------------------------------------------------------------|
 | 2016/01/27 | syl20bnr  | lock   | #3484 | comments judged to be offending towards the Spacemacs community |
-| 2016/01/27 | syl20bnr  | unlock | #3484 | let’s make it happen, i.e. this document                        |
+| 2016/01/27 | syl20bnr  | unlock | #3484 | let's make it happen, i.e. this document                        |

CONTRIBUTING.org

@@ -41,7 +41,7 @@ Thanks! :heart: :heart: :heart:
 If you want to ask an usage question, be sure to look first into some places as
 it may hold the answer:
 - [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/FAQ.org][The FAQ]]. Some of the most frequently asked questions are answered there.
-- [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org][The documentation]]. It’s the general documentation of Spacemacs.
+- [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org][The documentation]]. It's the general documentation of Spacemacs.
 - You may also read the =README.org= of the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org][relevant layer(s)]].
 
 If your question is not answered there, then please come into our [[https://gitter.im/syl20bnr/spacemacs][gitter chat]] to
@@ -99,7 +99,7 @@ Submit your contribution against the =develop= branch. You should not use
 your =master= branch to modify Spacemacs, this branch is considered to be
 read-only.
 
-You may want to [[https://github.com/syl20bnr/spacemacs/wiki/Beginner%27s-Guide-to-Contributing-a-Pull-Request-to-Spacemacs][read our beginner’s guide for Pull Requests]].
+You may want to [[https://github.com/syl20bnr/spacemacs/wiki/Beginner%27s-Guide-to-Contributing-a-Pull-Request-to-Spacemacs][read our beginner's guide for Pull Requests]].
 
 /PR = Pull Request/
 
@@ -122,9 +122,9 @@ Those PRs are usually /cherry-picked/.
 Those PRs are /merged/ and explicitly /not fast-forwarded/.
 
 *** Commit messages
-Write commit messages according to adapted [[http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html][Tim Pope’s guidelines]]:
-- Use present tense and write in the imperative: “Fix bug”, not “fixed bug” or
-  “fixes bug”.
+Write commit messages according to adapted [[http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html][Tim Pope's guidelines]]:
+- Use present tense and write in the imperative: "Fix bug", not "fixed bug" or
+  "fixes bug".
 - Start with a capitalized, short (72 characters or less) summary, followed by a
   blank line.
 - If necessary, add one or more paragraphs with details, wrapped at 72
@@ -192,7 +192,7 @@ The file header for =elisp= files should look like the following template:
 #+END_EXAMPLE
 
 You should replace =FILENAME= by the name of the file (e.g. =packages.el=)
-and =NAME= by the name of the layer you are creating, don’t forget to replace
+and =NAME= by the name of the layer you are creating, don't forget to replace
 =YOUR_NAME= and =YOUR_EMAIL= also. Some files already have a template inside
 =core/templates/=, so look in there first.
 Note that if you use =configuration-layer/create-layer=, spacemacs will prepare
@@ -214,8 +214,8 @@ Every README.org file of a layer should contain =#+TAGS:= line:
   ...
 #+END_EXAMPLE
 
-Individual tags are separated with “|” char.
-Example above contains 2 tags: “layer” and “web service”
+Individual tags are separated with "|" char.
+Example above contains 2 tags: "layer" and "web service"
 Tags are listed in =<spacemacs_root>/.ci/spacedoc-cfg.edn=
 
 #+BEGIN_SRC clojure
@@ -230,8 +230,8 @@ Tags are listed in =<spacemacs_root>/.ci/spacedoc-cfg.edn=
 Labels are used to name headlines in =LAYERS.org= file and
 =:spacetools.spacedoc.config/layers-org-query= defines its structure by
 chaining tags into a tree where every leaf turns into a list of
-descriptions pulled out of README.org files that match leaf’s path in the tree.
-“layer” is implicit root tag of the tree and every description can be displayed
+descriptions pulled out of README.org files that match leaf's path in the tree.
+"layer" is implicit root tag of the tree and every description can be displayed
 only once.
 
 *** Contributor to an existing layer
@@ -244,15 +244,15 @@ Key bindings are an important part of spacemacs.
 First if you want to have some personal key bindings, you can freely bind them
 inside the ~SPC o~ and ~SPC m o~ prefixes which are reserved for the user. This
 can be done from the =dotspacemacs/user-config= function of your =.spacemacs=
-file and don’t require any contribution to Spacemacs.
+file and don't require any contribution to Spacemacs.
 
 If you think it worth contributing a new key bindings then be sure to read
 the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/CONVENTIONS.org][CONVENTIONS.org]] file to find the best key bindings, then create a
 PR with your changes.
 
 *ALWAYS* document your new key bindings or key bindings changes inside the
-relevant documentation file. It should be the layer’s =README.org= file for
-layer’s key bindings, or =DOCUMENTATION.org= for general Spacemacs key
+relevant documentation file. It should be the layer's =README.org= file for
+layer's key bindings, or =DOCUMENTATION.org= for general Spacemacs key
 bindings.
 
 ** Contributing a banner

EXPERIMENTAL.org

@@ -158,7 +158,7 @@ In the mingw shell run:
 #+END_SRC
 
 *** Update your dotfile
-In the function =dotspacemacs/init= add the following variables if you don’t
+In the function =dotspacemacs/init= add the following variables if you don't
 have them already and initialize them:
 
 #+BEGIN_SRC emacs-lisp
@@ -191,9 +191,9 @@ have them already and initialize them:
 
 A new user dotfile function has been added which is called before doing the
 dump. The function name is =dotspacemacs/user-load=. You can require additional
-libraries before the dump so they won’t need to be lazy loaded.
+libraries before the dump so they won't need to be lazy loaded.
 
-Add this to your dotfile if you don’t have it already.
+Add this to your dotfile if you don't have it already.
 
 #+BEGIN_SRC emacs-lisp
   (defun dotspacemacs/user-load ()

doc/BEGINNERS_TUTORIAL.org

@@ -43,19 +43,19 @@ modifier keys are:
 ~SPC~ = ~Space~, used as the leader key in Vim editing style.
 ~RET~ = ~Return~ (also known as ~Enter~)
 ~C-~ = ~Ctrl~
-~M-~ (for “meta”) = ~Alt~
+~M-~ (for "meta") = ~Alt~
 ~S-~ = ~Shift~
 
 The modifier keys can be used either in a sequence or as key chords by pressing
 two keys at the same time. ~SPC 1~ is notation for a key sequence and means
 pressing ~Space~ first and pressing ~1~ after it. Key chords are notated by
 writing a ~-~ between the keys. Thus ~C-c~ means pressing ~Ctrl~ and the letter
 ~c~ simultaneously. Key chords and sequences can also be combined: ~C-c a~ means
-“First press ~Ctrl~ and ~c~ simultaneously, then press ~a~”. ~C-c C-a~ means
-“First press ~Ctrl~ and ~c~ simultaneously, then press ~Ctrl~ and ~a~
-simultaneously”.
+"First press ~Ctrl~ and ~c~ simultaneously, then press ~a~”. ~C-c C-a~ means
+"First press ~Ctrl~ and ~c~ simultaneously, then press ~Ctrl~ and ~a~
+simultaneously".
 
-This document assumes you chose the “Vim” editing style and notates accordingly.
+This document assumes you chose the "Vim" editing style and notates accordingly.
 If you chose the Emacs editing style, just substitute ~SPC~ with ~M-m~ in all
 the commands that begin with ~SPC~.
 
@@ -89,7 +89,7 @@ first, in practice it can be learned quickly and once learned is unparallelled
 in speed and ergonomy. Our earlier example of deleting a certain line of text (a
 very common edit task) can be achieved in Spacemacs by simply navigating to the
 line in question with the keys ~j~ and ~k~ (navigation keys) and pressing ~d~
-(for “delete”) two times!
+(for "delete") two times!
 
 You might have noticed that this was achieved entirely without moving your
 fingers from your home row (the row where your fingers lie in rest when
@@ -103,7 +103,7 @@ modal editing.
 
 ** Using the spacebar to launch commands
 Now that you are familiar with writing and editing text it is time to put the
-“Space” into Spacemacs. Because the spacebar is the most accessible key on the
+"Space" into Spacemacs. Because the spacebar is the most accessible key on the
 keyboard and is pressed by the strongest fingers (the thumbs), it is a natural
 choice for launching commands. You can think of it as the start menu of
 Spacemacs.
@@ -112,36 +112,36 @@ A short instant after the spacebar is pressed a menu pops up. This interactive
 menu shows you what submenus and commands can be accessed by subsequent
 keypresses. Browsing around this menu is a great way of finding new features in
 Spacemacs, so keep on eye on the different options! ~ESC~ usually breaks the
-combination you don’t want to use.
+combination you don't want to use.
 
 ** Buffers, windows and frames
-Because Emacs (the extension of which Spacemacs is) was developed in the ’80s
+Because Emacs (the extension of which Spacemacs is) was developed in the '80s
 before the advent of modern graphical user interfaces, Emacs has
-a different name of what we normally call “windows”: in Emacs these are
-called “frames”. A frame is what pops up when you launch Spacemacs from your
+a different name of what we normally call "windows": in Emacs these are
+called "frames". A frame is what pops up when you launch Spacemacs from your
 desktop shortcut. A frame contains windows and buffers.
 
 Windows are the visual spaces a frame is divided into. The default
 is one, but windows can be split to allow editing multiple files in one frame.
-Let’s try this. Press ~SPC~ to bring up the menu. You can see different letters
+Let's try this. Press ~SPC~ to bring up the menu. You can see different letters
 having different submenus associated with them, usually with a mnemonic for
-easier recall. The letter w is assigned for “windows”: press it. A new menu
+easier recall. The letter w is assigned for "windows": press it. A new menu
 opens with further options. Write the character / to split the currently active
 window vertically into two.
 
 Now you should see two windows of this tutorial, and the one on the left should
 be active, as can be seen from the modeline in the bottom or by moving the
-cursor around using the navigation keys. This isn’t very useful, as we
+cursor around using the navigation keys. This isn't very useful, as we
 would probably want to see a different file on the right.
 
 First, activate the window on the right with ~SPC 2~. Now that the window on the
-right is active, we can open a different buffer for a different file. We’ll use
+right is active, we can open a different buffer for a different file. We'll use
 the scratch buffer, which can be used like a notepad. Be warned, unlike other
-buffers it doesn’t prompt you whether you want to save the changes you’ve made
+buffers it doesn't prompt you whether you want to save the changes you've made
 when quitting the program! Press ~SPC b~ to open the buffers menu and then
 switch to the scratch buffer by pressing s. Now you have two different buffers
 in two different windows open, great! You can write something on the scratch
-buffer, and when you’re done, make sure that the scratch window is active and
+buffer, and when you're done, make sure that the scratch window is active and
 close it by pressing ~SPC w d~.
 
 Now the tutorial window fills the whole frame. But you only closed the window,
@@ -168,13 +168,13 @@ By default Spacemacs uses a dotfile called =~/.spacemacs= to control which layer
 to load. Within this file you can also configure certain features. First, split
 the window vertically to view both this tutorial and the dotfile simultaneously
 (~SPC w /~). Open the dotfile by pressing ~SPC f e d~. Navigate to the line
-starting with “dotspacemacs-configuration-layers”. The following lines have
+starting with "dotspacemacs-configuration-layers". The following lines have
 further instructions: uncomment =org= and =git= layers if you want to be
 familiarized with them. More [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org][layers]] for different languages and tools can be
 found by pressing ~SPC h SPC~. The added layers will be installed upon restart
 of Spacemacs.
 
-Some layers require third-party tools that you’ll have to install via your
+Some layers require third-party tools that you'll have to install via your
 favorite package manager. The layer readme will tell if this is the case.
 
 ** Changing the colour theme
@@ -187,15 +187,15 @@ Editing the =dotspacemacs-maximized-at-startup= variable from =nil= to =t= will
 Spacemacs maximized.
 
 ** Quitting
-Save the changes you’ve made to the dotfile with ~SPC f s~ and then quit emacs
+Save the changes you've made to the dotfile with ~SPC f s~ and then quit emacs
 by ~SPC q q~. You can return to this tutorial by clicking it on the home screen!
 
 * Additional features, tips and troubleshooting
 ** Org mode
 Org mode is one of the best features of Spacemacs and enough reason to warrant
-its use. Org mode’s official description tells that it is “for keeping notes,
+its use. Org mode's official description tells that it is "for keeping notes,
 maintaining todo lists, planning projects, and authoring documents with a fast
-and effective plain-text system”, but this gives only a small inkling of its
+and effective plain-text system", but this gives only a small inkling of its
 versatility. If you do any kind of writing at all, chances are that Org mode
 will make it easier and more fun. This tutorial was written in Org mode.
 
@@ -215,7 +215,7 @@ tutorials is also very helpful in finding out the most useful features of it!
 ** Version control - the intelligent way
 Version control means keeping track of the changes and edits you have made to
 your document. Often version control is done by saving different versions of the
-document with different names, such as “document version 13” and so on. This is
+document with different names, such as "document version 13" and so on. This is
 crude in many ways: if you want to, for example, re-add something you deleted,
 you have to manually open several past versions of the document to find the one
 with the deleted part, and then copy-paste it to the most recent file. More
@@ -227,12 +227,12 @@ posts as well.
 Install the git layer, restart Spacemacs and open a file you want to version
 control. You can check the status of your file by pressing ~SPC g s~. Select the
 folder your file is in. You will be prompted whether you want to create a
-repository in the folder. Select yes. You will see a list of “Untracked files”:
-navigate to the file you want to track and press s to “stage changes”. You might
+repository in the folder. Select yes. You will see a list of "Untracked files":
+navigate to the file you want to track and press s to "stage changes". You might
 be prompted to save the file: save it if necessary. Now the new file needs to be
 committed: press c and c again. Two windows pop up: one showing the changes
-you’ve made since the last edit (in this case, the whole document) and another
-prompting for a commit message. Write “Initial commit”, press ESC to exit back
+you've made since the last edit (in this case, the whole document) and another
+prompting for a commit message. Write "Initial commit", press ESC to exit back
 to normal mode and press ~, c~ confirm and quit the commit
 message. To abort, press ~, a~.
 
@@ -256,7 +256,7 @@ comprehensive Spacemacs documentation, including this tutorial and the layer
 documents.
 
 The [[https://gitter.im/syl20bnr/spacemacs][Gitter chat]] can be used to ask questions if the answer cannot be found in
-the documentation. For a detailed review of Spacemacs’s features one can also
+the documentation. For a detailed review of Spacemacs's features one can also
 watch the [[https://www.youtube.com/playlist?list=PLrJ2YN5y27KLhd3yNs2dR8_inqtEiEweE][Spacemacs ABC series]] by Eivind Fonn on Youtube. Some of the
 keybindings have changed since the videos were uploaded but seeing someone in
 action helps spot helpful tricks that would otherwise be missed.

doc/CONVENTIONS.org

@@ -63,7 +63,7 @@ A package is initialized in a function with name =<layer>/init-xxx= where:
   =:config= keywords.
 - If there is only one line of code then try to keep =:init= or =:config=
   keywords on the same line.
-- Don’t nest multiple =use-package= calls unless you have a very good reason
+- Don't nest multiple =use-package= calls unless you have a very good reason
   to do it.
 
 * Key bindings conventions
@@ -194,7 +194,7 @@ should be followed:
 | ~m s r~ | send region                                                  |
 | ~m s R~ | send region and switch to REPL                               |
 
-Note: we don’t distinguish between the file and the buffer.
+Note: we don't distinguish between the file and the buffer.
 
 *** In terminal
 History navigation in shells or REPLs buffers should be bound as well to
@@ -217,7 +217,7 @@ The base prefix for major mode specific compilation is ~SPC m c~.
 | ~m c C~     | clean             |
 | ~m c r~     | clean and compile |
 
-Note: we don’t distinguish between the file and the buffer. We can
+Note: we don't distinguish between the file and the buffer. We can
 implement an auto-save of the buffer before compiling the buffer.
 
 ** Debugging
@@ -346,7 +346,7 @@ share common actions that we can unite under the same key bindings:
 | ~m t t~ | execute the current test (thing at point, function)          |
 | ~m t T~ | execute the current test in debug (thing at point, function) |
 
-Note: we don’t distinguish between the file and the buffer. We can
+Note: we don't distinguish between the file and the buffer. We can
 implement an auto-save of the buffer before executing the tests of
 buffer.
 
@@ -413,4 +413,4 @@ Spacemacs provides an example layer =README.org= file in
   - Note: Many layer =READMEs= do not follow this convention yet. Please fix
     them if you can.
 - To keep things readable only mention the prefix ~SPC~ when documenting
-  key bindings, you don’t need to mention ~M-m~.
+  key bindings, you don't need to mention ~M-m~.