Hi Rainer thanks for the detailed description.
Just a few comments: * Most users will use the HTML GUI of Bitbucket to create a new file. And Bitbucket will use the headline as file name. This will happen before they ever read the README :) I don't know how to solve this other than to rename the stuff for them. Imho that is ok as the traffic for new files is very low. But if you have another idea it's welcome. * I would suggest to add the TOC to the navigation bar insert. Sure there might be one ore two pages with just a single heading, but these are the minority and usually things grow. * As men do not read instructions and especially not lengthy instructions like this) it would need a very dense summary of necessary commands and a checklist on the dos and donts when writing pages right on top of the README. * As most users, especially the new ones, will experience the Wiki via Bitbucket, they won't see the README.txt until they checkout the repository. Why not make the README.txt a README.md and add it to the main TOC? Oliver Am 28.07.2016 um 19:22 schrieb Dr Rainer Woitok: > Greetings, > > some time ago Wolfgang wanted to edit or add wiki documentation files, > asked on this list about appropriate guidelines, and Oliver pointed him > to my file "README.txt". However, this file only contains dry remarks > about running "make" or "make nav" and what prerequisites have to be met > in either case. > > Probably not the kind of information Wolfgang was asking for ... > > So I finally sat down, took a deep breath, and tried to add some meat to > the bones in file "README.txt", subjecting the file to a thorough over- > haul and in particular adding a section about the dos and don'ts of ed- > iting "*.md" files. > > Have a look, and if you find any omissions, errors, incomprehensible > passages, or whatever: just let me know :-) > > Sincerely, > Rainer > > ------------------------------------------------------------------------------ > _______________________________________________ > Qlandkartegt-users mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users ------------------------------------------------------------------------------ _______________________________________________ Qlandkartegt-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/qlandkartegt-users
