suggestion for org manual

suggestion for org manual

[Jonas Stein]

To the creators of org-mode

at first i have to thank you for the great package and the nice 
documentation.

A few suggestions on the manual
part 5.3.3 Tracking your habits
http://orgmode.org/manual/Tracking-your-habits.html

It says
# You have enabled the habits module by customizing the variable 
org-modules.

I would expect here a link about customizing the variable org-modules, 
and how the setting looks like.


It says
# You must also have state logging for the DONE state enabled, in order 
for historical data to be represented in the consistency graph. If it is 
not enabled it is not an error, but the consistency graphs will be 
largely meaningless.


I would expect here
# In order to get meaningful consistency graphs state logging for state 
"DONE" must be enabled.
(Link to article about enable logging or explain it here.)

kind regards,

-- 
Jonas Stein <news@jonasstein.de>

Re: suggestion for org manual

[Memnon Anon]

Moin Jonas,

Jonas Stein <news@jonasstein.de> writes:

> It says
> # You have enabled the habits module by customizing the variable
> org-modules.
>
> I would expect here a link about customizing the variable org-modules,
> and how the setting looks like.

Well, customizing variables belongs to the emacs realm; given that, the
documentation is pretty good. One way to improve it could be something
like "You have enabled the habits module by "`M-x customize-variable'
org-modules". The customize buffer is fairly self-explanatory then I
guess. However, while this would make the manual more newcomer friendly,
it would also be less pleasant to read imho. ... 

> It says
> # You must also have state logging for the DONE state enabled, in
> order for historical data to be represented in the consistency graph.
> If it is not enabled it is not an error, but the consistency graphs
> will be largely meaningless.
>
>
> I would expect here
> # In order to get meaningful consistency graphs state logging for
> state "DONE" must be enabled.
> (Link to article about enable logging or explain it here.)

Tracking TODO state changes is in 5.3.2, i.e. just one "[" keypress
away, if you read the emacs info pages?! But a link rarely hurts, I
guess :).

Thanks for your suggestions!
Memnon

Re: suggestion for org manual

[Bastien]

Hi Memnon,

Memnon Anon <gegendosenfleisch@googlemail.com> writes:

>> I would expect here
>> # In order to get meaningful consistency graphs state logging for
>> state "DONE" must be enabled.
>> (Link to article about enable logging or explain it here.)
>
> Tracking TODO state changes is in 5.3.2, i.e. just one "[" keypress
> away, if you read the emacs info pages?! But a link rarely hurts, I
> guess :).
>
> Thanks for your suggestions!

Can you create a patch for this?

Thanks!

-- 
 Bastien

[PATCH] org.texi: New link (was: suggestion for org manual)

[Memnon Anon]

[-- Attachment #1: Type: text/plain, Size: 82 bytes --]

Bastien <bzg@altern.org> writes:

> Can you create a patch for this?

Like this?


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Patch: Add link --]
[-- Type: text/x-diff, Size: 1349 bytes --]

From 365f6f3d23926647ce40979ca59f88f96086b713 Mon Sep 17 00:00:00 2001
From: Memnon Anon <gegendosenfleisch@gmail.com>
Subject: [PATCH] Add a link to documentation

* doc/org.texi (Tracking your habits): Point to the
  "Tracking TODO state changes" section.

As suggested by Jonas Stein.

TINYCHANGE
---
 doc/org.texi |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index bb248a8..4b8a826 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -4273,10 +4273,10 @@ The TODO may also have minimum and maximum ranges specified by using the
 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
 three days, but at most every two days.
 @item
-You must also have state logging for the @code{DONE} state enabled, in order
-for historical data to be represented in the consistency graph.  If it is not
-enabled it is not an error, but the consistency graphs will be largely
-meaningless.
+You must also have state logging for the @code{DONE} state enabled
+(@pxref{Tracking TODO state changes}), in order for historical data to be
+represented in the consistency graph.  If it is not enabled it is not an
+error, but the consistency graphs will be largely meaningless.
 @end enumerate
 
 To give you an idea of what the above rules look like in action, here's an
-- 
1.7.10.4

Re: [PATCH] org.texi: New link

[Bastien]

Memnon Anon <gegendosenfleisch@googlemail.com> writes:

> Bastien <bzg@altern.org> writes:
>
>> Can you create a patch for this?
>
> Like this?

Exactly!  Applied, thanks a lot,

-- 
 Bastien