Re: [Qlandkartegt-users] What should be contained in the FAQ?
@Rainer: Some comments to your proposals/remarks: > Using a numbered list rather than "##" headers more or less empties the "[TOC]" section. Yes, of course. But: the manual main page DocMain consists in principle of the detailed TOC. The automatically added [TOC] at the topic of this page would simply duplicate the entries in the detailed TOC (at least those with a header line). With the numbered list this duplication is avoided. > moving the list of hotkeys from section "Advanced Usage" into the new "Appendix" section? Done. Regards WolfgangTh -- Check out the vibrant tech community on one of the world's most engaging tech sites, SlashDot.org! http://sdm.link/slashdot ___ Qlandkartegt-users mailing list Qlandkartegt-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users
Re: [Qlandkartegt-users] What should be contained in the FAQ?
Wolfgang, On Friday, 2016-12-02 17:04:29 +0100, Wolfgang Thämelt wrote: > ... > please have a look in the QMS wiki! To give you some quick feedback regarding my first impression from just reading "DocMain.html" (I didn't yet get any farther :-): - Using a numbered list rather than "##" headers more or less empties the "[TOC]" section. - I would suggest moving the "Installation" section ahead of "Basic QMapShack usage". After all "Installation" isn't "Usage", neither basic nor advanced. - What do others think about moving the list of hotkeys from section "Advanced Usage" into the new "Appendix" section? And what do oth- ers think about additionally listing the relevant hotkeys under a last header "### Useful Hotkeys" in each of the other pages where this makes sense? Is using hotkeys really "advanced"? - The new "Appendix" section seems a good idea to me. I think the "Glossary" page you already mentioned should also be anchored here. - Since it is quite clear from the very beginning that this is a "QMapShack" manual, we could perhaps remove "QMapShack" from most of the section headers and link texts (like "Advanced QMapShack us- age" or "Troubleshooting QMapShack"). Sincerely, Rainer -- Check out the vibrant tech community on one of the world's most engaging tech sites, SlashDot.org! http://sdm.link/slashdot ___ Qlandkartegt-users mailing list Qlandkartegt-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users
Re: [Qlandkartegt-users] What should be contained in the FAQ?
Oliver, On Friday, 2016-12-02 13:58:40 +0100, you wrote: > ... > The basic stuff is always: > ... [ long list of things omitted ] ... > This is reflected more or less by the current Wiki structure. I agree that your listing includes probably everything currently docum- ented under the "Using QMapShack" header. The big question then is: What are we going to put into the planned new "Advanced Use" section? Sincerely, Rainer -- Check out the vibrant tech community on one of the world's most engaging tech sites, SlashDot.org! http://sdm.link/slashdot ___ Qlandkartegt-users mailing list Qlandkartegt-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users
