Greetings,
my own words in the new version of file "README.txt" in the wiki repos-
itory about looking out for dead files haunted me ever since I wrote
them. Thus I added a new makefile target "check" to file "Makefile" and
added script "LinkCheck.sh" which searches for files not reachable from
"Home.md" by repeatedly clicking on local links, for local links not
pointing to a file in the repository, and for files other than "DocMain.
md" containing links pointing to itself (file "DocMain.md" contains two
links in the two navigation bars which point to "DocMain").
And lo and behold, there are in fact quite a few unreachable files. The
trailing comments do NOT originate in the script, they were manually
added by me:
$ make check
Unreferenced files:
DeveloperCodeStructure.md # [1].
DocGisHowToRouting.md # [2].
DocGisHowToSaveYourWork.md # [2].
DocGisItemsTrk.md # [3].
DocUseCaseMotorcycleNavigation.md # [2].
ReportBugs.md # [4].
images/DocControlMapDem/maproom4.png # [5].
images/DocControlMapDem/maproom9.png # [5].
images/DocGettingStarted/maproom5.png # [5].
images/DocGisDatabaseFolderItems/maproom2.png # [5].
images/DocGisDatabaseLostFound/maproom3.png # [5].
images/DocGisDatabaseWorkspaceDatabase/maproom1.png # [5].
images/DocGisDevices/qmapshack1.png # [5].
images/DocGisDevices/qmapshack3.png # [5].
images/DocGisItemsTrk/ScreenOptions.png # [3].
images/DocGisItemsTrk/maproom2.png # [3].
images/DocGisItemsTrk/maproom3.png # [3].
images/DocGisItemsTrk/maproom4.png # [3].
images/DocGisItemsTrk/maproom5.png # [3].
images/DocGisItemsTrk/maproom6.png # [3].
images/DocGisItemsTrk/maproom7.png # [3].
images/DocGisItemsWpt/Bubble.png # [5].
images/DocGisItemsWpt/Copy.png # [5].
images/DocGisItemsWpt/DeleteOne.png # [5].
images/DocGisItemsWpt/WptBubble.png # [5].
images/DocGisItemsWpt/WptHighlight.png # [5].
$
Comments:
[1]: This file should probably be linked somewhere into the "Developer &
Translators" section in file "DocMain.md".
[2]: These are files created by Wolfgang which are still in the making.
Side note: these files are not yet ready to be sanitized via "make
nav". Their existence makes it difficult to run "make nav" to san-
itize other files (like "DocFaq.md" and "QuickWayToPrepareRaster-
MapForQMapShack.md") because one always has to manually undo the
sanitizing effects in Wolfgang's files afterwards. I assume that's
the reason for "DocFaq.md" and "QuickWay*.md" not yet being sanit-
ized.
Since files "DocFaq.md" and "QuickWay*.md" seem ready for sanitiz-
ing (at least to me), I will do so when providing my next update to
"NavBar.sh" which will add a Markdown "[TOC]" directive to every
file except "Home.md".
To prevent such a situation in the future it would perhaps be worth
considering to simply place such unfinished files into a separate,
author or topic specific sub-directory (for instance "Wolfgang/" in
this case) until they are finished. Since "make nav" will not dive
into sub-directories, unfinished files will be safe there and will
thus not prevent "make nav" from being run against other files. If
we could agree on this procedure, I would mention it in my "README.
txt".
[3]: These could just be old versions of the corresponding "**DocGis-
ItemsTrk2**" files. If someone knows for sure, these files could
simply be "hg rm"-ed.
[4]: This file is similar to "BugFeatures.md" but it's difficult to tell
which is the more recent one. They should perhaps be merged using
either name and the link in file "Home.md" should then be updated
accordingly.
[5]: Plenty of unreferenced images. Either the corresponding links were
erroneously removed somewhere back in time, or the files are just
outdated and meanwhile replaced with more recent ones, in which
case the old versions should just be "hg rm"-ed.
Sincerely,
Rainer
------------------------------------------------------------------------------
_______________________________________________
Qlandkartegt-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users
