From: Bastien <bzg@altern.org>
To: "François Pinard" <pinard@iro.umontreal.ca>
Cc: Bernt Hansen <bernt@norang.ca>,
emacs-orgmode@gnu.org,
Carsten Dominik <carsten.dominik@gmail.com>
Subject: Re: The reportmode report does not count the running clock
Date: Wed, 04 Jan 2012 02:37:41 +0100 [thread overview]
Message-ID: <878vlont7e.fsf@altern.org> (raw)
In-Reply-To: <87mxa4u6oe.fsf@iro.umontreal.ca> ("François Pinard"'s message of "Tue, 03 Jan 2012 10:50:09 -0500")
Hi François,
pinard@iro.umontreal.ca (François Pinard) writes:
> Hello, everybody. Let me wish you all that the Year Started Well, and
> will continue that way all along!
Thanks!
> Carsten Dominik <carsten.dominik@gmail.com> writes:
>
>> Note that there is a million variables which are not referred to
>> in the manual - simply too many to mention them all.
>
> A million? You *always* exaggerate! :-)
Well, I counted more than 1070 variables... describing 5 of them
per page would take 214 pages. Not something I'd like to read :)
>> It might be useful to mentions this one, otherwise I would urge
>> restraint. A good way to find unknown variables is described here:
>> http://orgmode.org/worg/org-tutorials/org-customize.html
>
> The manual should be reference, and should mention all variables. A
> textual search in the manual should yield anything worth finding.
Emacs is The All-Mighty Self-Documenting Editor ;)
Wrt documentation, Emacs is its own reference, by letting you access
everything with C-h v org-*.
The manual is a secondary reference: one that contains the most useful
things to know about Org to use it efficiently. It should cover 100% of
the core feature, and most of the rest -- but there is a trade-off in
this last area. Between readability and completeness.
> However nicely and carefully the customization has been organized, one
> should ideally not have to guess and retry customize branches in hope of
> finding something, or peruse the sources, after having tried the manual.
>
> Do not misread me, I'm not at all saying that there is something wrong
> with the customization, or the availability of the sources! :-)
Another point: there is a lot to do to improve the current docstrings
and the manual. This is a matter of 1) pulling from git, 2) modifying
the file, 3) run `C-x v =' in the buffer, 4) send the patch.
:)
> Maybe an appendix to the manual could be mechanically generated out of
> all customization information, with some Makefile/Emacs machinery for
> keeping it up-to-date? Easier said than done, I know... But I would
> like at least to throw the idea in the field.
This crossed my mind recently.
See this file: http://lumiere.ens.fr/~guerry/u/org.org
which presents all functions/options/variables from some org*el
files.
The code to produce this is here:
http://lumiere.ens.fr/~guerry/u/org-lto.el
This is broken in many respect -- no cleanup is done on the
docstring, and there is nearly no formatting. Also, it does not
export well (see http://lumiere.ens.fr/~guerry/u/org.html)
If you're interested in improving this, please go ahead, I'd be
interested in getting something working along these lines.
Best regards,
--
Bastien
next prev parent reply other threads:[~2012-01-04 1:36 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-13 4:28 The reportmode report does not count the running clock François Pinard
2011-12-13 11:39 ` Bernt Hansen
2011-12-13 14:22 ` François Pinard
2011-12-13 15:30 ` Bernt Hansen
2011-12-13 17:17 ` Carsten Dominik
2011-12-14 18:10 ` [PATCH] * doc/org.texi (Agenda commands): Document org-clock-report-include-clocking-task Bernt Hansen
2011-12-14 18:15 ` Bastien
2011-12-15 2:41 ` Bernt Hansen
2012-01-03 21:30 ` Sebastien Vauban
2012-01-03 23:18 ` Bastien
2012-01-05 5:10 ` François Pinard
2012-01-04 12:13 ` Bernt Hansen
2012-01-03 15:50 ` The reportmode report does not count the running clock François Pinard
2012-01-04 1:37 ` Bastien [this message]
2012-01-04 3:33 ` François Pinard
2012-01-04 10:14 ` Bastien
2012-01-04 15:08 ` François Pinard
2012-01-06 1:59 ` François Pinard
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
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=878vlont7e.fsf@altern.org \
--to=bzg@altern.org \
--cc=bernt@norang.ca \
--cc=carsten.dominik@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=pinard@iro.umontreal.ca \
/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.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).