LP1858345 Hatch docs: use backticks to highlight paths/filenames user/dbs/lp1858345_hatch_docs_typos_and_highlights
authorDan Scott <dan@coffeecode.net>
Sun, 5 Jan 2020 17:22:55 +0000 (12:22 -0500)
committerDan Scott <dan@coffeecode.net>
Sun, 5 Jan 2020 17:29:36 +0000 (12:29 -0500)
Helps differentiate paths and filenames from regular text.

Signed-off-by: Dan Scott <dan@coffeecode.net>
INSTALL.adoc

index b30377e..adfe54a 100644 (file)
@@ -8,9 +8,9 @@ from a source checkout but are not documented here.
 
 === Install Hatch ===
 
-Execute the 'Hatch-Installer-(version).exe' executable.
+Execute the `Hatch-Installer-(version).exe` executable.
 
-NOTE: See installer/windows/README.adoc for building the Windows
+NOTE: See `installer/windows/README.adoc` for building the Windows
 installer from Linux or Windows.  When building the Windows installer
 on Windows a full JDK is required for compiling.
 
@@ -62,11 +62,11 @@ $ ./hatch.sh compile
 
 === Configure Native Messaging ===
 
-Edit extension/host/org.evergreen_ils.hatch.(chrome|firefox).json and change the "path"
-value to match the location of your copy of "hatch.sh", found in the root
+Edit `extension/host/org.evergreen_ils.hatch.(chrome|firefox).json` and change the `path`
+value to match the location of your copy of `hatch.sh`, found in the root
 directory of the Hatch repository.
 
-Copy the correct host file, changing the filename to org.evergreen_ils.hatch.json, into the browser's configuration directory.
+Copy the correct host file, changing the filename to `org.evergreen_ils.hatch.json`, into the browser's configuration directory.
 
 For Chrome:
 
@@ -107,7 +107,7 @@ https://addons.mozilla.org/en-US/firefox/addon/hatch-native-messenger/[Firefox A
 
 NOTE: print commands are disabled by default in the tests to avoid
 unexpected printing but they can be added by un-commenting
-them in src/org/evergreen_ils/hatch/TestHatch.java and recompiling.
+them in `src/org/evergreen_ils/hatch/TestHatch.java` and recompiling.
 
 [source,sh]
 -------------------------------------------------------------------------
@@ -145,11 +145,11 @@ $ ./hatch.sh compile
 
 === Configure Native Messaging ===
 
-Edit extension/host/org.evergreen_ils.hatch.(chrome|firefox).json and change the "path"
-value to match the location of your copy of "hatch.sh", found in the root
+Edit `extension/host/org.evergreen_ils.hatch.(chrome|firefox).json` and change the `path`
+value to match the location of your copy of `hatch.sh`, found in the root
 directory of the Hatch repository.
 
-Copy the correct host file, changing the filename to org.evergreen_ils.hatch.json, into the browser's configuration directory.
+Copy the correct host file, changing the filename to `org.evergreen_ils.hatch.json`, into the browser's configuration directory.
 
 For Chrome:
 
@@ -190,7 +190,7 @@ https://addons.mozilla.org/en-US/firefox/addon/hatch-native-messenger/[Firefox A
 
 NOTE: print commands are disabled by default in the tests to avoid
 unexpected printing but they can be added by un-commenting
-them in src/org/evergreen_ils/hatch/TestHatch.java and recompiling.
+them in `src/org/evergreen_ils/hatch/TestHatch.java` and recompiling.
 
 [source,sh]
 -------------------------------------------------------------------------