Skip to content

Commit

Permalink
Merge pull request #1541 from smriad/markdown-lint-fix
Browse files Browse the repository at this point in the history
Markdown lint fix
  • Loading branch information
BaseMax authored Apr 4, 2022
2 parents f77ca58 + 65c033d commit 91e08ea
Show file tree
Hide file tree
Showing 107 changed files with 19,673 additions and 19,702 deletions.
20 changes: 10 additions & 10 deletions .pre-commit-config.yaml
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -49,25 +49,25 @@ repos:
- repo: https://github.com/jumanjihouse/pre-commit-hooks
rev: 2.1.5
hooks:
# - id: markdownlint # Configure in .mdlrc
- id: markdownlint # Configure in .mdlrc
- id: reek
- id: rubocop
- id: shellcheck
# - repo: git://github.com/Lucas-C/pre-commit-hooks
# rev: v1.1.9
# hooks:
# - id: forbid-tabs
# - id: remove-tabs
- repo: git://github.com/Lucas-C/pre-commit-hooks
rev: v1.1.9
hooks:
- id: forbid-tabs
- id: remove-tabs
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.9.0
hooks:
- id: python-check-mock-methods
- id: python-no-eval
- id: python-no-log-warn
# - repo: https://github.com/igorshubovych/markdownlint-cli
# rev: v0.30.0
# hooks:
# - id: markdownlint
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.30.0
hooks:
- id: markdownlint
# name: Run markdownlint
# entry: markdownlint -c .github/linters/.markdown-lint.yml .
- repo: https://github.com/adrienverge/yamllint
Expand Down
24 changes: 12 additions & 12 deletions assets/cheatsheets-xml-test-data/GettingStarted/CreatePlot.xml
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<cheatsheet title="Creating a new plot in Debrief">
<intro>
<description>This tutorial will lead you through creating a new, blank plot in Debrief.
</description>
</intro>
<item title="Check you have a Project">
<description>Before you can create a Plot, you must have a Project into which the Plot is created. If you haven't created a project, go to the "Generating a project" cheatsheet, then return here.
</description>
</item>
<intro>
<description>This tutorial will lead you through creating a new, blank plot in Debrief.
</description>
</intro>
<item title="Check you have a Project">
<description>Before you can create a Plot, you must have a Project into which the Plot is created. If you haven't created a project, go to the "Generating a project" cheatsheet, then return here.
</description>
</item>
<item
title="Choose location for plot file">
<description>
Debrief will store the new plot in one of your existing folders. If your navigator contains links to both shared training data and personal data folders, it&apos;s probably best to create this plot in your personal data folder.
</description>
</item>
<item title="Create new plot">
<description>In the Navigator view, right-click on the parent folder for your new plot and select <b>New</b>/<b>Debrief Plot</b> and the Wizard will open. Once the wizard opens, the first step is to confirm where you would like the plot to be stored (it&apos;s <b>Container</b>). If you&apos;re not happy with the specified location click on <b>Browse</b> button and select the top-level folder of your data directories. Also provide a filename.
<item title="Create new plot">
<description>In the Navigator view, right-click on the parent folder for your new plot and select <b>New</b>/<b>Debrief Plot</b> and the Wizard will open. Once the wizard opens, the first step is to confirm where you would like the plot to be stored (it&apos;s <b>Container</b>). If you&apos;re not happy with the specified location click on <b>Browse</b> button and select the top-level folder of your data directories. Also provide a filename.
Using the wizard, follow the series of tabs to indicate what information you&apos;d like shown in the background of the plot, clicking Finish to complete. Some of the steps will not advance until all of the necessary fields have been filled.
</description>
</item>
</description>
</item>
<item
title="Finished">
<description>
Expand Down
202 changes: 101 additions & 101 deletions assets/cheatsheets-xml-test-data/GettingStarted/EditingYourData.xml
Original file line number Diff line number Diff line change
@@ -1,104 +1,104 @@
<?xml version="1.0" encoding="UTF-8"?>
<cheatsheet title="Editing your data" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="..\contentFile.xsd">
<intro>
<description>So, you've found your data, loaded it into Debrief, and now you want to make
some changes to it. This cheat-sheet will give you some pointers.</description>
</intro>
<item title="Check you have some data" href="/org.eclipse.platform.doc.user/concepts/cnav.htm">
<description>In the top left hand corner of Debrief you should find the Navigator window. If
it isn't there, select "Navigator" from Debrief's Window/Show View menu. Also check you
have our sample data-files - it they're not there, find how to load them from the
"Loading sample data" cheat-sheet.</description>
</item>
<item title="Open the sample plot-file">
<description>If it&apos;s not already open, double-click on &apos;sample.xml&apos; in the
Navigator window, and the sample plot will open.</description>
</item>
<item href="/org.mwc.debrief.help/html/legacy/moving_around.html" title="Fit to window">
<description>You can also experiment with zooming in and out. Click the zoom out
button once to zoom out, or put plot into <b>Zoom In</b> mode by clicking on the Zoom In
button. Now, when you drag an area, the map will zoom in on that viewport.<br/>
Lastly, to make sure all of the data is visible, click on the &quot;Fit-to-Window&quot;
toolbar button. Read more about the toolbar buttons by clicking on the help-link to the
right of this text. </description>
</item>
<item title="View the data in tree form">
<description> In addition to viewing your data on the 2D plot, the <b>Outline View</b>
displays it in tree form. Switch to the <b>Outline View</b> view to see the data.
If the Outline View isn't open already, you can open it via the <b>Window/Show View</b> menu.
You&apos;ll see the two tracks there, together with other layers that contain <b>Chart
Features</b> (such as the <b>Grid</b> and <b>Scale</b>), and the <b>Misc</b> layer
that contains graphical annotations. </description>
</item>
<item title="Make sure the properties window is open"
href="/org.eclipse.platform.doc.user/concepts/cpropview.htm">
<description>The properties window is normally at the bottom left of Debrief. If it's there
but not at the top of the 'stack', click on its title to reveal it. If you can't find
it, select "Properties" from the 'Window/Show View" drop-down list.</description>
</item>
<item title="Select an item">
<description>Now double-click on one of the corners of the green rectangle near the centre
of the track plot. You&apos;ll now see its editable attributes appear on the properties
window. Cool. You&apos;ll see that the attributes are grouped for ease of use, and some
must be expanded (those for location &amp; time).</description>
</item>
<item title="Make a change">
<description>Now have a go at changing the rectangle's label color. Click once on the green
rectangle next to 'LabelColor'. A button containing three dots will appear. Click on
this to open the color editor. Click on the red rectangle and then the 'OK' button. The
dialog will close, the label color property will be updated, and the plot will redraw.
Well done.</description>
</item>
<item title="Undo the change">
<description>Oops, it appears we shouldn&apos;t have changed the label color, it
doesn&apos;t meet NATO MilStd 12332 Sub-para 14g (2002 version). To undo a change, first
click on the tab at the top of the <b>sample.xml</b> plot (to tell Debrief which plot
we&apos;re undoing). Now click on the Edit menu, and select Undo (it&apos;s the first
item). The color of the label will now change back. Look on the Edit menu again, and
you&apos;ll see there&apos;s now a &quot;Redo&quot; command available - just in case
you&apos;re undecided about your adherence to sub-para 14g. Note, it&apos;s not just
edits that are undo-able, lots of operations can be undone, just have a look on the Edit
menu whenever you feel the need to step-back. If you think something isn&apos;t on there
but it should be, just ask... <b>But it did
not undo!</b>. The Undo button applies to whichever is the active Debrief view. So,
to undo a change to the plot, first need to select the plot (or the tab containing hte
plot name), then press undo.</description>
</item>
<item title="Edit a position">
<description>To select a position within a track, just double-click on it - its editable
attributes will appear in the properties window. You can now change the symbol or label
(<b>LabelShowing</b> or <b>SymbolShowing</b>,
visibility, or the color (<b>Color</b>) that position will be plotted in. Note: you may have to scroll up &amp; down the
<b>Properties Window</b> to see all of the properties.</description>
</item>
<item title="Edit a whole track">
<description>Aaah, but how do you edit a track? Easy, just use the Outline View to select
it rather than clicking on the plot. Open the Outline View (or select Outline View
from the Window/Show View drop-down menu). In the Outline View click once on the name
of a track, and the whole track's properties will be editable in the Properties View.
The Outline View is also useful for selecting non-geographic entities (such as a grid,
scale, or background data-set) to be edited.</description>
</item>
<item title="Re-arrange the views">
<description>Now, are you finding it a bit of pain switching between the Outline View and
Properties views? Using your mouse, just click and drag the Properties panel upwards -
so it&apos;s on top of the view vertically above it. You can now see the Outline View
and Properties windows at once.</description>
</item>
<item title="Edit directly from the plot itself">
<description>For some attributes, you don't even need to use the Properties View. Just
right-click on an item on your plot. The popup menu shows a series of options and
commands. A drop-down menu is shown next to the current item's name. From this drop-down
menu you'll be able to edit all of the item's true/false or 'select one from many'
attributes. Note, if you click on a vehicle position, a drop-down is shown for the
parent track as well as the position itself. Also note, that the right-click menu is
shown if you click on an item from the Outline View.</description>
</item>
<item title="Don't forget to save">
<description>Now that you've invested all that effort in your plot, don't forget to save it.
Just click on the floppy-disk icon on the main toolbar. If the data you're looking is
actually an REP file, you will be invited to save the file in Debrief's XML plot-file
format - since REPs can't store formatting data.</description>
</item>
xsi:noNamespaceSchemaLocation="..\contentFile.xsd">
<intro>
<description>So, you've found your data, loaded it into Debrief, and now you want to make
some changes to it. This cheat-sheet will give you some pointers.</description>
</intro>
<item title="Check you have some data" href="/org.eclipse.platform.doc.user/concepts/cnav.htm">
<description>In the top left hand corner of Debrief you should find the Navigator window. If
it isn't there, select "Navigator" from Debrief's Window/Show View menu. Also check you
have our sample data-files - it they're not there, find how to load them from the
"Loading sample data" cheat-sheet.</description>
</item>
<item title="Open the sample plot-file">
<description>If it&apos;s not already open, double-click on &apos;sample.xml&apos; in the
Navigator window, and the sample plot will open.</description>
</item>
<item href="/org.mwc.debrief.help/html/legacy/moving_around.html" title="Fit to window">
<description>You can also experiment with zooming in and out. Click the zoom out
button once to zoom out, or put plot into <b>Zoom In</b> mode by clicking on the Zoom In
button. Now, when you drag an area, the map will zoom in on that viewport.<br/>
Lastly, to make sure all of the data is visible, click on the &quot;Fit-to-Window&quot;
toolbar button. Read more about the toolbar buttons by clicking on the help-link to the
right of this text. </description>
</item>
<item title="View the data in tree form">
<description> In addition to viewing your data on the 2D plot, the <b>Outline View</b>
displays it in tree form. Switch to the <b>Outline View</b> view to see the data.
If the Outline View isn't open already, you can open it via the <b>Window/Show View</b> menu.
You&apos;ll see the two tracks there, together with other layers that contain <b>Chart
Features</b> (such as the <b>Grid</b> and <b>Scale</b>), and the <b>Misc</b> layer
that contains graphical annotations. </description>
</item>
<item title="Make sure the properties window is open"
href="/org.eclipse.platform.doc.user/concepts/cpropview.htm">
<description>The properties window is normally at the bottom left of Debrief. If it's there
but not at the top of the 'stack', click on its title to reveal it. If you can't find
it, select "Properties" from the 'Window/Show View" drop-down list.</description>
</item>
<item title="Select an item">
<description>Now double-click on one of the corners of the green rectangle near the centre
of the track plot. You&apos;ll now see its editable attributes appear on the properties
window. Cool. You&apos;ll see that the attributes are grouped for ease of use, and some
must be expanded (those for location &amp; time).</description>
</item>
<item title="Make a change">
<description>Now have a go at changing the rectangle's label color. Click once on the green
rectangle next to 'LabelColor'. A button containing three dots will appear. Click on
this to open the color editor. Click on the red rectangle and then the 'OK' button. The
dialog will close, the label color property will be updated, and the plot will redraw.
Well done.</description>
</item>
<item title="Undo the change">
<description>Oops, it appears we shouldn&apos;t have changed the label color, it
doesn&apos;t meet NATO MilStd 12332 Sub-para 14g (2002 version). To undo a change, first
click on the tab at the top of the <b>sample.xml</b> plot (to tell Debrief which plot
we&apos;re undoing). Now click on the Edit menu, and select Undo (it&apos;s the first
item). The color of the label will now change back. Look on the Edit menu again, and
you&apos;ll see there&apos;s now a &quot;Redo&quot; command available - just in case
you&apos;re undecided about your adherence to sub-para 14g. Note, it&apos;s not just
edits that are undo-able, lots of operations can be undone, just have a look on the Edit
menu whenever you feel the need to step-back. If you think something isn&apos;t on there
but it should be, just ask... <b>But it did
not undo!</b>. The Undo button applies to whichever is the active Debrief view. So,
to undo a change to the plot, first need to select the plot (or the tab containing hte
plot name), then press undo.</description>
</item>
<item title="Edit a position">
<description>To select a position within a track, just double-click on it - its editable
attributes will appear in the properties window. You can now change the symbol or label
(<b>LabelShowing</b> or <b>SymbolShowing</b>,
visibility, or the color (<b>Color</b>) that position will be plotted in. Note: you may have to scroll up &amp; down the
<b>Properties Window</b> to see all of the properties.</description>
</item>
<item title="Edit a whole track">
<description>Aaah, but how do you edit a track? Easy, just use the Outline View to select
it rather than clicking on the plot. Open the Outline View (or select Outline View
from the Window/Show View drop-down menu). In the Outline View click once on the name
of a track, and the whole track's properties will be editable in the Properties View.
The Outline View is also useful for selecting non-geographic entities (such as a grid,
scale, or background data-set) to be edited.</description>
</item>
<item title="Re-arrange the views">
<description>Now, are you finding it a bit of pain switching between the Outline View and
Properties views? Using your mouse, just click and drag the Properties panel upwards -
so it&apos;s on top of the view vertically above it. You can now see the Outline View
and Properties windows at once.</description>
</item>
<item title="Edit directly from the plot itself">
<description>For some attributes, you don't even need to use the Properties View. Just
right-click on an item on your plot. The popup menu shows a series of options and
commands. A drop-down menu is shown next to the current item's name. From this drop-down
menu you'll be able to edit all of the item's true/false or 'select one from many'
attributes. Note, if you click on a vehicle position, a drop-down is shown for the
parent track as well as the position itself. Also note, that the right-click menu is
shown if you click on an item from the Outline View.</description>
</item>
<item title="Don't forget to save">
<description>Now that you've invested all that effort in your plot, don't forget to save it.
Just click on the floppy-disk icon on the main toolbar. If the data you're looking is
actually an REP file, you will be invited to save the file in Debrief's XML plot-file
format - since REPs can't store formatting data.</description>
</item>
</cheatsheet>
Loading

0 comments on commit 91e08ea

Please sign in to comment.