Merge pull request #32 from pryrt/fix-internal-links

Fix formatting according to CONTRIBUTION.md; fix cross-document links.

Author: pryrt

CONTRIBUTION.md

@@ -22,3 +22,7 @@ Your pull requests are welcome; however, they may not be accepted for various re
     * Use the checkbox **Search > Find > Search Mode: ☑ Regular Expression** to enable regular expressions in your search
 
 4. For text that you want to indicate as user-entered (such as regular expressions or values entered into dialog box prompts), and for filenames and directories, use backticks to set the `monospaced / code` formatting.
+
+## Cross-Links
+
+To properly link from one page in the user-manual docs to another, use the syntax `[link name](../page/)` to link to the top level, or `[link name](../page/#anchor)` to link to an anchor (like a heading) in another document.  Note that `page` does _not_ include the `.md` extension.  The anchor names are the lower-case version of the section headers, with spaces replaced by hyphens.  Thus, from the [Themes](content/docs/themes/) page, link to the [**Preferences > Style Configurator**](content/docs/preferences/#style-configurator) using the syntax `[**Preferences > Style Configurator**](../preferences/#style-configurator)

content/docs/auto-completion.md

@@ -7,14 +7,15 @@ weight: 80
 Function List Panel is a zone to display all the functions (or method) found in the current file. The user can use the Function List Panel to access a function definition quickly by double clicking function item on the list. Function List can be customized to list the functions for whichever language. For customizing Function List to recognize your favorite language, please check below.
 
 
-Function list contains a search engin (by using regular expression) and a panel to display the search result (function list). It is designed to be as generic as possible, and allows user to modify the way to search, or to add new parser for any programming language.
-In order to make function list work for your language (if not supported), you should modify `functionList.xml`. It can be found in %APPDATA%\notepad++\ or in Notepad++ installed directory if you use zip package.
+Function list contains a search engine (by using regular expression) and a panel to display the search result (function list). It is designed to be as generic as possible, and allows user to modify the way to search, or to add new parser for any programming language.
+In order to make function list work for your language (if not supported), you should modify `functionList.xml`. It can be found in `%APPDATA%\notepad++\` or in the Notepad++ installed directory if you use zip package.
 
 ## How to customize function list
 In parser node it contains:
-- id: uniq ID for this parser
-- displayName: reserved for future use.
-- comment: Optional. you can make a RE in this attribute in order to identify comment zones. The identified zones will be ignored by search.
+
+- `id`: uniq ID for this parser
+- `displayName`: reserved for future use.
+- `comment`: Optional. you can make a regular expression in this attribute in order to identify comment zones. The identified zones will be ignored by search.
 
 There are 3 kinds of parsers: function parser, class parser and mix parser.
 Define a function parser if the language has only functions to parse (for example C).
@@ -27,41 +28,44 @@ A mix parser contains both function and classRange nodes.
 
 ### Function parser
 In function node it contains:
-- mainExpr: it's the regex to get the whole string which contains all the informations you need.
-- displayMode: reserved for future use.
-- functionName: define a or several RE to get the function name from the result of "mainExpr" attribute of "function" node.
-    - nameExpr: 1..N
-        - expr: here you define the RE to find the function name.
 
-- className: define a or several RE to get the class name from the result of "mainExpr".
-    - nameExpr: 1..N
-        - expr: here you define the RE to find the function name.
-    
-Both functionName and className nodes are optional.
-If functionName and className are absent, then the found string by mainExpr RE will be processed as function name, and the class name won't be used.
+- `mainExpr`: it's the regex to get the whole string which contains all the informations you need.
+- `displayMode`: reserved for future use.
+- `functionName`: define a or several regular expression to get the function name from the result of "mainExpr" attribute of "function" node.
+    - `nameExpr`: 1..N
+        - `expr`: here you define the regular expression to find the function name.
+
+- `className`: define a or several regular expression to get the class name from the result of "mainExpr".
+    - `nameExpr`: 1..N
+        - `expr`: here you define the regular expression to find the function name.
+
+Both `functionName` and `className` nodes are optional.
+If `functionName` and `className` are absent, then the found string by `mainExpr` regular expression will be processed as function name, and the class name won't be used.
 
 
-The nodes functionName and className have the same structure, and they have the same parsing behaviour. For example, in the functionName node, we got 2 nameExpr nodes:
-If the function parser find the first result by mainExpr attribute, then it will use the first nameExpr to search in the first result, if found (the 2nd result), then it will use the 2nd nameExpr to search in the 2nd result. If found, then the function name is solved.
+The nodes `functionName` and `className` have the same structure, and they have the same parsing behaviour. For example, in the `functionName` node, we got 2 `nameExpr` nodes:
+If the function parser find the first result by `mainExpr` attribute, then it will use the first `nameExpr` to search in the first result, if found (the 2nd result), then it will use the 2nd `nameExpr` to search in the 2nd result. If found, then the function name is solved.
 
 ### Class parser
 In classRange node it contains:
-- mainExr: the main whole string to serach
-- displayMode: reserved for future use.
-- openSymbole & closeSymbole: they are optional. if defined, then the parser will determinate the zone of this class. It find first openSymbole from the first character of found string by mainExpr attribute. then it determinates the end of class by closeSymbole found. The algorithm deals with the several levels of imbrication. for example: \{\{\{\}\{\}\}\{\}\}
-- className: 1 (or more) nameExpr node for determinating class name (from the result of mainExpr searching).
-- function: search in the class zone by using mainExpr attribute and the functionName nodes.
+
+- `mainExr`: the main whole string to serach
+- `displayMode`: reserved for future use.
+- `openSymbole` & `closeSymbole`: they are optional. if defined, then the parser will determinate the zone of this class. It find first `openSymbole` from the first character of found string by mainExpr attribute. then it determinates the end of class by `closeSymbole` found. The algorithm deals with the several levels of imbrication. for example: `\{\{\{\}\{\}\}\{\}\}`
+- `className`: 1 (or more) `nameExpr` node for determinating class name (from the result of `mainExpr` searching).
+- `function`: search in the class zone by using `mainExpr` attribute and the `functionName` nodes.
 
 ### Mix parser
-Mix Parser contains Class parser (classRange node) and Function parser (function node).
+Mix Parser contains Class parser (`classRange` node) and Function parser (`function` node).
 Class parser will be applied firstly to find class zones, then function parser will be applied on non-class zones.
 
 ### Link to Language
 Once you finish to defined your parser, you can associate it with Notepad++ internal language id (or with file extension), in order to make it works with the language you want. All you need to do is add association node(s) into associationMap node.
 
-In associationMap, it contains:
-- association: 1 or several nodes to make associations between defined parsers and languages.
-    - langID: Notepad++ internal language ID.
-    - userDefinedLangName: User Defined Language Name. It makes association between User Defined Language and the parser. If langID is present, this attribute will be ignored.
-    - ext: File name extesion (should contain '.'). If langID or userDefinedLangName is present, this attribute will be ignored.
-    - id: Parser ID.
+In `associationMap`, it contains:
+
+- `association`: 1 or several nodes to make associations between defined parsers and languages.
+    - `langID`: Notepad++ internal language ID.
+    - `userDefinedLangName`: User Defined Language Name. It makes association between User Defined Language and the parser. If langID is present, this attribute will be ignored.
+    - `ext`: File name extesion (should contain `.`). If `langID` or `userDefinedLangName` is present, this attribute will be ignored.
+    - `id`: Parser ID.

content/docs/function-list.md

@@ -15,11 +15,11 @@ position of the cursor and will (normally speaking) operate relative on it.
 
 ## Record a macro
 
-To record a macro, select `Macro -> Start` Recording or press the  button on the
+To record a macro, select **Macro > Start Recording** or press the  button on the
 toolbar. Notepad++ will now keep track of the changes you make on a document or
 certain actions you perform.
 
-To stop recording, select `Macro -> Stop` Recording or select the  button on the
+To stop recording, select **Macro > Stop Recording** or select the  button on the
 toolbar. As an exception to most commands, you can toggle this behavior with a
 special shortcut combination that is not listed in the menu but solely in the
 Shortcut mapper (see Settings, Shortcutmapper). By default, this is the
@@ -32,23 +32,23 @@ recording another macro without saving your earlier work, it will be lost.
 
 ## Play a recoded macro
 
-To play the macro in the buffer, select `Macro->Playback` or press the button.
+To play the macro in the buffer, select **Macro > Playback** or press the button.
 This will perform the macro once at the current position.
 
 
 ## Save a recorded macro
 
-To save the macro in the buffer, select `Macro->Save` current recorded macro or
+To save the macro in the buffer, select **Macro > Save** current recorded macro or
 press the button. A dialog will pop up asking for a name of the macro and the
-default key combination. These can later be changed (and deleted) using the
-Shortcutmapper (see Shortcut Mapper). When saved, the macro will be available
-from the Macro menu or the Macro playlist.
+default key combination. These can later be changed (and deleted) using
+[**Settings > Shortcut Mapper**](../preferences/#shortcut-mapper).
+When saved, the macro will be available from the Macro menu or the Macro playlist.
 
 
 ## Play a recoded macro multiple times
 
 To play the current macro in the buffer or any saved macro once or multiple
-times, select `Macro->Run` a macro multiple times... or press the  button.
+times, select **Macro > Run** a macro multiple times... or press the  button.
 A dialog will pop up allowing you to select what macro to perform (buffer
 macro or any saved macro) and how many times. You can also opt to perform the
 macro until the cursor reaches the end of the current file (starting from
@@ -60,6 +60,6 @@ Note that if no macro's are available, this dialog is inaccessible.
 
 To edit or delete an existing macro shortcut, you can use the Shortcut mapper,
 which displays all shortcuts of all kinds, and allows changing or removing a key
-binding. The interface is also available through the `Macro -> Modify
-shortcut / Delete macro` entry on the Macros menu. Note that the contents of a
-macro definition can be edited only in the shortcuts.xml file.
+binding. The interface is also available through the **Macro > Modify
+shortcut / Delete macro** menu entry. Note that the contents of a
+macro definition can be edited only in the `shortcuts.xml` file.

content/docs/macros.md

@@ -6,21 +6,22 @@ weight: 160
 
 ## Notepad Replacement
 Notepad is a default text editor shipped with Windows. You may want to use Notepad++ instead of Notepad. However, there's no obvious way to do it.
-From the version 7.5.9 you can run the following command to make Notepad++ replace Notepad (run in cmd.exe with Administrator privileges):
+From the version 7.5.9 onward, you can run the following command to make Notepad++ replace Notepad (run in `cmd.exe` with Administrator privileges):
 
 ```batch
 reg add "HKLM\Software\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\notepad.exe" /v "Debugger" /t REG_SZ /d "\"%ProgramFiles(x86)%\Notepad++\notepad++.exe\" -notepadStyleCmdline -z" /f
 ```
 
-Note that you may need to use "%ProgramFiles%\Notepad++\" to substitute for "%ProgramFiles(x86)%\Notepad++\" if you have Notepad++ 64-bit installed, or use other path if your Notepad++ is installed in a non-default location.
+Note that you may need to use `%ProgramFiles%\Notepad++\` to substitute for `%ProgramFiles(x86)%\Notepad++\` if you have Notepad++ 64-bit installed, or use other path if your Notepad++ is installed in a non-default location.
 
 
 Use the the following comment to undo the replacement:
 ```batch
 reg delete "HKLM\Software\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\notepad.exe" /v "Debugger" /f
 ```
+
 ## Notepad++ Cheat sheet
-### Tab
+### Tabs
 - Tab navigation
   - To switch between first and last tab, use <kbd>CTRL</kbd> + <kbd>SHIFT</kbd> + ```MOUSEWHEEL``` on tabs. ```MOUSEWHEEL``` up will take to first tab while down will take to last tab.  
   ![FirstAndLast](https://user-images.githubusercontent.com/14791461/35479755-b37a09fc-0424-11e8-9a5c-905bf18b957e.gif)
@@ -32,4 +33,3 @@ reg delete "HKLM\Software\Microsoft\Windows NT\CurrentVersion\Image File Executi
 
   - To move tab from one position to other position, use <kbd>SHIFT</kbd> + ```MOUSEWHEEL``` on tabs. ```MOUSEWHEEL``` up will move currently selected tab to previous position while down will move to next position.  
   ![MoveTabs](https://user-images.githubusercontent.com/14791461/66017596-1b72aa80-e4f9-11e9-9ff0-87632415bd91.gif)
-  

content/docs/other-resources.md

@@ -59,7 +59,7 @@ and [PluginDefinition.cpp](https://github.com/npp-plugins/plugintemplate/blob/ma
 
 A good sample illustrates better the whole picture than a detailed documentation.
 You can check [Notepad++ Plugin Demo](https://github.com/npp-plugins/plugindemo/releases)
-to learn how to make some commands more complex. 
+to learn how to make some commands more complex.
 
 However, the knowledge of Notepad++ plugin system is required, if you want to
 accomplish some sophisticated plugin commands.
@@ -99,13 +99,13 @@ the latest version of wingup
 [32-bit](https://notepad-plus-plus.org/pluginListTestTools/wingup.release.x32.zip)
 or
 [64-bit](https://notepad-plus-plus.org/pluginListTestTools/wingup.release.x64.zip)
-and nppPluginList.json (you should rename it from pl.x64.json or pl.x86.json,
-according your plugin's architecture). Replace notepad++.exe and GUP.exe of your
+and nppPluginList.json (you should rename it from `pl.x64.json` or `pl.x86.json`,
+according your plugin's architecture). Replace `notepad++.exe` and `GUP.exe` of your
 Notepad++ installation by downloaded ones, copy `pl.x64.json` or `pl.x86.json` to
 `%PROGRAMDATA%\Notepad++\plugins\Config\nppPluginList.json`
 (or `<NPP_INST_DIR>\plugins\Config\nppPluginList.json` - see New Plugins Home), then
-you're all set - the menu item "Plugin Admin" will be under menu "Plugin" of your
-debug mode notepad++.exe. Launch this command will launch the Plugin Admin dialog
+you're all set - the menu item **Plugins Admin** will be under menu **Plugins** of your
+debug mode notepad++.exe. Launch this command will launch the **Plugins Admin** dialog
 and the rest should be intuitive.
 
 ### Rules for adding your plugins into list
@@ -122,7 +122,7 @@ and the rest should be intuitive.
    SHA-256. This id is checked with the downloaded dll to avoid
    [MITM](https://en.wikipedia.org/wiki/Man-in-the-middle_attack).
    You can use Notepad++ to get your plugin's SHA-256 hash
-   (Menu: `Tools->SHA-256>Generate from files...`) or some online sha256 generators.
+   (Menu: **Tools > SHA-256 > Generate from files...**) or some online sha256 generators.
 4. Update info: the value of **version** is exact the version of your plugin binary
    version which you want to be deployed. This version will compare with installed
    plugin's version to decide if update should be applied.
@@ -133,14 +133,14 @@ and the rest should be intuitive.
 6. Packaging: Only zip package is supported. Your plugin (DLL) should have the same
    name as the **folder-name** and the plugin DLL file should be placed at the root
    level of the ZIP file. Otherwise Plugin Admin won't install it. Any additionals
-   files (dll or data) can be placed at the root level or in an arbitrary subfolder.
+   files (DLL or data) can be placed at the root level or in an arbitrary subfolder.
 
 ### Do your PR to join plugin list
 
 Once your test has been done, and everything is ok, you can fork and do your PR on:
 https://github.com/notepad-plus-plus/nppPluginList/. Only the json part you should
-modify. The json file will be built into the a binary (nppPluginList.dll), which will
-be signed (for thes sake of security) and be included in the official distribution. 
+modify. The json file will be built into the a binary (`nppPluginList.dll`), which will
+be signed (for thes sake of security) and be included in the official distribution.
 
 ### Questions & support
 

content/docs/plugins.md

@@ -27,8 +27,8 @@ Almost 80 Programming Languages are supported by Notepad++:
 | Verilog      | XML                | YAML                   |               |               |
 
 
-Notepad++ supports for their syntax highlighting(customizable), syntax folding,
-[auto-completion](../auto-completion/) (customizable),
+Notepad++ supports for their [syntax highlighting](../preferences/#style-configurator) (customizable),
+syntax folding, [auto-completion](../auto-completion/) (customizable),
 [function list](../function-list/) (customizable via PCRE in xml file).
 
 If your beloved language is not in the list above, you can define it by your

content/docs/programing-languages.md

@@ -4,7 +4,7 @@ weight: 110
 ---
 
 
-Themes are pre-defined sets of formatting rules, which often try to use a consistent color scheme between languages.  You may choose your theme using the [**Preferences > Style Configurator** dialog](./preferences/#style-configurator).
+Themes are pre-defined sets of formatting rules, which often try to use a consistent color scheme between languages.  You may choose your theme using the [**Preferences > Style Configurator** dialog](../preferences/#style-configurator).
 
 Notepad++ comes packaged with a default theme and a number of other themes to start with.  You may customize any of those themes using the Style Configurator dialog, or by editing the underlying XML files.