[FOSS-GPS] FoxtrotGPS documentation (format?)

[Joshua Judson Rosen]

Charles Curley <charlescurley at charlescurley.com> writes:
>
> On Sat, 10 Nov 2012 12:21:22 +1100
> David Bannon <dbannon at internode.on.net> wrote:
>
> > http://www.users.on.net/~dbannon/FoxDoc/foxtrotgps.html
>
> I think it's useful. I had no idea the keyboard shortcuts were there!
> There's a lot of work to complete it, but this is an excellent start.

The listing of keyboard shortcuts is from the manpage update last week;
I think the question isn't really about whether to document things,
or even about what to document, but really of what `source format'
should be used for documentation.

Right now our source-format for documention is troff (with `mandoc'
macros). It's great for formatting, which makes it great for printing
and OK for reading with a `man page' reader (e.g.: man, info, tkman, yelp)
but it has a little bit of a learning curve and is (I find) somewhat hard
to read. Apparently other people also find it hard to read ;)

Also, I guess there also is (or should be) a question of what license to use
for the documentation--because it should be easy for people to `repurpose'
it into useful formats that may not have been thought of yet. Right now,
there's no license declared specifically for the documentation;
if we leave it like that, then we're probaby implying that it's
GPL'd along with the rest of the codebase, and then technically people
are supposed to distributed annotated source whenever they publish it...,
which might put people off from, say, making `FoxtrotGPS quick-reference',
mugs or T-shirts (it could happen!).

Daniel Baumann wrote the initial version of the man page and generously
offered to basically let us distribute it under whatever license terms
we wanted, and all of the other content added so far to that man page
(which, granted, isn't that much!) has been written by me, so it's
not too late to actually *pick a license for the documentation*.

I don't know what the popular free license for documentation is,
these days--seems like GFDL never really cought on; Creative Commons
BY-SA (Attribution Share-Alike), maybe? Or 3-clause BSD?

-- 
"Don't be afraid to ask (λf.((λx.xx) (λr.f(rr))))."