From: Nick Dokos <nicholas.dokos@hp.com>
To: Izzie <ml_orgmode.kapush@antichef.net>
Cc: nicholas.dokos@hp.com, emacs-orgmode@gnu.org
Subject: Re: Re: orgmode manual improvement suggestion.
Date: Tue, 05 Apr 2011 12:35:31 -0400 [thread overview]
Message-ID: <12959.1302021331@alphaville.dokosmarshall.org> (raw)
In-Reply-To: Message from Izzie <ml_orgmode.kapush@antichef.net> of "Tue, 05 Apr 2011 08:42:36 -0000." <loom.20110405T084812-187@post.gmane.org>
[Noch ein mal: I forgot to copy the list. Apologies... to Izzie in
particular who is receiving multiple instances. At least, I edited
this version down a bit.]
Izzie <ml_orgmode.kapush@antichef.net> wrote:
> ...
> I was hoping org mode documentation had been made with org mode, I wasn't
> expecting a texi file format I had not been introduced to yet. I can use it to
> generate the manual, but I can't jump into modifying the source.
>
Texinfo format predates org by 20 years or so and is the GNU software
standard for documentation. Since org is GNU software, it has to conform
to the standard. It might be possible to do a texinfo exporter but a)
nobody has done that (yet) and b) it would be a lot of effort to rewrite
the documentation in org.
>
> Thanks. how come this is not part of the manual ? It is a good practice to
> provide information about where to find the manual and how to produce a
> specific format (especially when not providing it).
>
*Which* manual? It *is* part of the texinfo manual. If you are saying why
is it not part of the org manual, why should it be? It has nothing to do
with org.
A link in the Documentation section of org might be warranted however:
``Org mode manuals are written in texinfo and they are part of the
distribution: doc/org.texi and doc/orgguide.texi, although depending
on how you get org, they may be in one of many different places. If
you want to produce documentation in different formats, please
see <a href="http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Output-Formats.html#Output-Formats">here</a>.''
> > > And that the single page version of "the compact Org-mode Guide" is
> > > missing.
> >
> > But I don't know whether the single page document ever was (or should
> > be) available from the orgmode site, so I'm not sure I'd characterize is
> > as "missing": Matt and/or Jason would know better.
>
> It's actually available as a pdf download but this is not what I expected (a
> single html page) so I deemed it "missing". I usually expect to find both
> single page html and one page per section html versions along with gzipped
> versions (for those who want to download it).
>
> IMHO the current "Documentation" section found at http://orgmode.org/ could use
> a quick rewrite. It might be related to english not being my native language
> but when I read "read the online manual" I understand that there is a different
> offline version. Rewritten to "read the manual online" this potential confusion
> is no more (at least for me).
>
> There's also a lack of consistency, for the guide it says:
> * Read the online compact guide or download it as a PDF document. (...)
>
> while for the manual the same info is broken into two different sections:
>
> * Read the online manual. (...)
> * Download the manual as a 200-page PDF document.
>
> Starting the entries with "Read", "Download", "Buy" helps scanning through the
> section by providing info right away, out of luck the specific version i was
> looking for is the one which doesn't follow this pattern:
>
> * You can also have the entire manual in a single monolithic file.
>
> I had the online manual open which offers no easily found way to get to the
> place where other versions of the manual can be found, so I headed for the
> orgmode website, scanned the documentation section and missed the single html
> page version I was looking for, because it breaks the pattern. As I am
> expecting this version to be found I read the whole section from the beginning
> and missed it again, for some reason "single monolithic page" didn't fire up my
> brain looking for a "single html page", At this point I still assume the single
> html page version exists and can be found in this section so I started again
> from the top and clicked each link one after the other until I finally found it.
>
> Leading to this improvement suggestion thread.
>
These sound like reasonable questiions/suggestions to me and I'm sure
the webmasters will consider them carefully (just don't expect immediate
gratification: they all do it in their spare time.)
Nick
prev parent reply other threads:[~2011-04-05 16:36 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-04-04 21:58 orgmode manual improvement suggestion Izzie
2011-04-04 22:47 ` Nick Dokos
2011-04-05 8:42 ` Izzie
2011-04-05 16:35 ` Nick Dokos [this message]
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=12959.1302021331@alphaville.dokosmarshall.org \
--to=nicholas.dokos@hp.com \
--cc=emacs-orgmode@gnu.org \
--cc=ml_orgmode.kapush@antichef.net \
/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).