Greetings,
I would like to suggest rearranging some items in file "DocMain.md" so
readers have less problems finding what they are looking for. Here is
an annotated (indicated by "# [i]") output from "diff" explaining what I
have in mind:
diff --git a/DocMain.md b/DocMain.md
--- a/DocMain.md
+++ b/DocMain.md
@@ -12,9 +12,14 @@
not reflect the current appearance of the program. The manual will be updated
if there are
large changes to the GUI. However smaller changes will be ignored.
-## User
+## Installing QMapShack
* [Install QMapShack](DocGetQMapShack)
+* [Compile Instructions for Windows](BuildWindowsVisualStudio) # [1]
+* Creating offline documentation # [2]
+
+## Using QMapShack
+
* [Getting started](DocGettingStarted)
* [Command line parameters](DocCmdOptions)
* [Maps & Digital Elevation Model (DEM)](DocInstallMapDem)
@@ -38,15 +43,24 @@
* [Folders and Items](DocGisDatabaseFoldersItems)
* ['Lost & Found' Folder](DocGisDatabaseLostFound)
* [GPS Devices](DocGisDevices)
-* [Frequently Asked Questions](DocFaq) # [3]
-* [Playground - start your new Wiki page](DocPlayground) # [3]
-## Developer & Translators
+## Getting help
+
+* [Frequently Asked Questions](DocFaqConfig) # [2]
+ * [Configuring and running QMapShack](DocFaqConfig) # [4]
+ * [Databases and projects](DocFaqData) # [4]
+ * [Data handling](DocFaqHandling) # [4]
+ * [Maps and routing](DocFaqMaps) # [4]
+* [Reporting a bug](ReportBugs) # [5]
+* [Requesting a feature](RequestFeatures) # [5]
+
+## Developing QMapShack
* [Commit Code](DeveloperCommitCode)
* [Coding Guideline](DeveloperCodingGuideline)
-* [Compile Instructions for Windows](BuildWindowsVisualStudio) # [3]
* [Add translations](DeveloperTranslate)
+* Developing Documentation # [2]
+* [Playground - start your new Wiki page](DocPlayground) # [1]
- - -
Prev () | [Home](Home) | [Manual](DocMain) | [Top](#) | (Install QMapShack)
[Next](DocGetQMapShack)
Annotations:
[1]: Moved from elsewhere to here for better grouping of topics.
[2]: Part of my former "README.txt" file. Being created slowly :-)
[3]: Moved from here to elsewhere for better grouping of topics.
[4]: Currently file "DocFaq.md" introduces a sub-level of documentation
which prevents meaningful navigation bars in the various FAQ files.
So I would suggest to just move the list of FAQ files contained
therein one level up. Apart from this list file "DocFaq.md" only
contains a remark about another server being temporarily down, that
I would like to remove anyway.
[5]: Duplicated from file "Home.md" (where it should remain), but this
link is important enough to be also kept in the documentation it-
self (in particular for those reading the documentation offline).
What do you mean? Any comments welcome :-)
Sincerely,
Rainer
------------------------------------------------------------------------------
_______________________________________________
Qlandkartegt-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users
