From 8b32d60ea7fb59510f1544f7a050ec31eb497588 Mon Sep 17 00:00:00 2001 From: Dan Gowans Date: Wed, 28 Sep 2022 14:03:07 -0400 Subject: [PATCH] markdown linting --- docs/mapImages.md | 15 +++++++-------- docs/shortcuts.md | 2 +- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/mapImages.md b/docs/mapImages.md index 67d99164..2d57de47 100644 --- a/docs/mapImages.md +++ b/docs/mapImages.md @@ -19,10 +19,10 @@ These two features are heavilty relied on by the Lot Occupancy System. Take the screenshot above. -- The map has two main sections, D and E. -- Within each section, there are groups 1, 2, and 3. -- Each group has a north side (N) and a south side (S). -- Each side has 3 or 6 lots. +- The map has two main sections, D and E. +- Within each section, there are groups 1, 2, and 3. +- Each group has a north side (N) and a south side (S). +- Each side has 3 or 6 lots. The `id` for the top leftmost lot is `E-1-N-1`. The `id` for the bottom rightmost lot is `D-3-S-3`. @@ -32,12 +32,11 @@ The `id` for the bottom rightmost lot is `D-3-S-3`. In order to link the lot record in the application to the lot path in the image, the `id` attribute of the `` tag should match the Map SVG ID set on the lot record. -Non-exact matching can also be done. If all lot paths in the SVG image are grouped, +Non-exact matching can also be done. If all lot paths in the SVG image are grouped, and those groups have their `id` attributes set, the application will for the first matching path or group, removing pieces from the end of the configured Map SVG ID. For example, if the application comes across a new lot with Map SVG ID `E-1-N-7`, -there is no exact match. The application will then look for `E-1-N`, -which will match a group of six lots. The six lots will be highlighted +there is no exact match. The application will then look for `E-1-N`, +which will match a group of six lots. The six lots will be highlighted until the map is revised with the new lot. - diff --git a/docs/shortcuts.md b/docs/shortcuts.md index d2bc3400..ea5e8b3a 100644 --- a/docs/shortcuts.md +++ b/docs/shortcuts.md @@ -4,7 +4,7 @@ # Keyboard Shortcuts -Note that the keys needed to access the keyboard shortcuts +Note that the key combinations needed to access the keyboard shortcuts vary by browser and operating system. For example, the Mozilla Firefox web browser running on Windows uses Shift + Alt,