From: Gerben Wierda <gerben.wierda@rna.nl>
To: mailing list for ConTeXt users <ntg-context@ntg.nl>
Subject: Re: State of documentation of ConTeXt?
Date: Sun, 20 Jul 2014 23:07:32 +0200 [thread overview]
Message-ID: <D0B26416-4647-47E2-9982-17FC3B2478E2@rna.nl> (raw)
In-Reply-To: <CALBOmsZ5pgvfbkRbjYd3YQJ8YXFMdBa=Fm7fWti4VihrGSOnVg@mail.gmail.com>
On 20 Jul 2014, at 22:24, Mojca Miklavec <mojca.miklavec.lists@gmail.com> wrote:
> On Sun, Jul 20, 2014 at 2:14 PM, Gerben Wierda wrote:
>>
>> Sorry, you can’t expect users to be able to do that. Lamport
>> created LaTeX *and* wrote the “LaTeX User’s Guide and Reference manual”.
>
> <teasing>
> Indeed. Sorry, you can't do that to users. Christian Schenk also
> created MikTeX (I still have MikTeX files from 23 years ago) *and* is
> still developing it actively and answering emails from users.
> </teasing>
>
>> The authors mentioned below were all developers too. You need that level of
>> understanding to write a manual.
>
> What kind of developers? Did they contribute to the LaTeX core? (Many
> ConTeXt users are developers, but it highly depends what you count as
> a developer.)
Some contributed packages, some other stuff (even printer drivers). They all were deeply involved with the inside of TeX and LaTeX at a level that they would have to understand TeX and LaTeX to the core as they were developers in that environment
>> Hans & Taco: how much money would need to be raised to produce something of
>> the quality of Kopka & Daly’s “Guide to LaTeX”? or Goossens, Mittelbach &
>> Samarin’s “The LaTeX Companion”?
>
> What do you mean with "of the quality of these books"? Having a
> similar number of pages written in comparable quality (something like
> a revised beginner's manual) or so complete in description of the
> functionality as the mentioned manuals?
I agree these are now outdated in several areas and less useful as they were half a decade ago. But something that is complete enough for a user (not a TeXnician), doesn’t contain too many white spots and certainly does not contain stuff that isn’t true anymore.
> My estimate would be that a complete context reference with
> well-described options and including trivial examples would require
> cca. 10.000-50.000 pages. Maybe others have different estimates, but
> now do the math. (Existing manuals like MetaFun or the old cont-en.pdf
> are roughly 400 pages. But that's nowhere near 10 % of the ConTeXt
> functionality. One would need to document the whole TeX part, the
> whole metapost part, the whole lua part, the whole xml, all perl, ruby
> and lua scripts, write better man pages, probably list the whole
> Unicode to show the ConTeXt names in one appendix …)
If a tool needs 50.000 pages to document its use, you are in trouble (in more ways than one).
I think in reality a set of manuals, with core functionality and all kinds of extras a manual of 500 pages and maybe a reference manual of the same size would be something useful and thus meaningful. Stuff like MetaFun can have its own manual and doesn’t need to be in a core ConTeXt manual.
A user manual is enough. You don’t need a developer manual. So, documenting all the development you can do with ConTeXt (programming in lua and whatnot) would for me not be what is needed for a user manual. What a user manual does is what cont-en.pdf does, but then up to date and complete.
G
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage : http://www.pragma-ade.nl / http://tex.aanhet.net
archive : http://foundry.supelec.fr/projects/contextrev/
wiki : http://contextgarden.net
___________________________________________________________________________________
next prev parent reply other threads:[~2014-07-20 21:07 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-07-14 12:18 Gerben Wierda
2014-07-14 13:03 ` Rob Heusdens
2014-07-14 17:29 ` Hans Hagen
2014-07-15 9:59 ` Gerben Wierda
2014-07-15 14:42 ` Mojca Miklavec
2014-07-16 11:24 ` Rob Heusdens
2014-07-16 12:14 ` Alan BRASLAU
2014-07-16 15:08 ` Russ Urquhart
2014-07-16 15:20 ` Hans Hagen
2014-07-16 15:23 ` luigi scarso
2014-07-17 16:28 ` Mica Semrick
2014-07-15 14:55 ` luigi scarso
2014-07-15 15:33 ` Yuri Teixeira
2014-07-15 20:08 ` Hans Hagen
2014-07-15 20:23 ` Hans Hagen
2014-07-15 22:26 ` David Wooten
2014-07-15 22:54 ` Hans Hagen
2014-07-15 23:10 ` David Wooten
2014-07-16 6:30 ` Gour
2014-07-20 12:14 ` Gerben Wierda
2014-07-20 14:55 ` Gerben Wierda
2014-07-20 20:24 ` Mojca Miklavec
2014-07-20 21:07 ` Gerben Wierda [this message]
2014-07-21 3:07 ` Henning Hraban Ramm
2014-07-23 12:36 ` Ulrike Fischer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=D0B26416-4647-47E2-9982-17FC3B2478E2@rna.nl \
--to=gerben.wierda@rna.nl \
--cc=ntg-context@ntg.nl \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).