emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: tsd@tsdye.com (Thomas S. Dye)
To: Org-mode <emacs-orgmode@gnu.org>
Subject: [RFC] Org version of the Org manual
Date: Mon, 25 Feb 2013 10:21:54 -1000	[thread overview]
Message-ID: <m1bob8cffh.fsf@tsdye.com> (raw)

Aloha all,

An experiment to see if it is possible to convert the Org manual to Org
is now (hopefully) at the "proof of concept" stage and I would like to
determine whether or not the approach is viable. The experiment is here:

https://github.com/tsdye/orgmanual.git

The file orgmanual.org has a heading, * Instructions for use, that
explains how to set up asynchronous export with the new exporter. The
repo also contains orgmanual.info in case you don't want to hassle with
exporting the org file and just want to see what it looks like in info.
I'm able to generate an info file without makeinfo raising any errors or
warnings. 

There is also a heading, * Improvements and fixes, that includes a list
of problems that either need to be fixed or are in the process of being
fixed. Obviously, the file is not perfect, but I do believe it is good
enough to judge whether success will be possible. At any rate, I need to
pull myself away from this project for a week or so to do other things
and can't get caught up making editorial changes or working on the (to
me) thorny issues that remain.

Sections with problems have been given FIXME keywords. In some cases,
problem text (especially in macros) has been replaced with `XXX'.
Proposed fixes for these nagging issues will be greatly appreciated.

By way of background, my initial goal was to replicate the Org manual
precisely. This goal was abandoned when I realized that the various
contributors to the manual (including me a few years ago) had different
ideas about what a .texi file should look like and had created a somewhat
eclectic product.  The goal now is to have a "functional equivalent" of
the manual.

The ultimate goal is to maintain the Org manual in Org, rather than
.texi, and to have the infrastructure in place in time to support the
major revisions required by the forthcoming release of version 8.0.

Many thanks to Nicolas Goaziou and to Jonathan Leech-Pepin for their
excellent work on the new exporter framework and the texinfo exporter,
and for their patience with my sometimes exasperated (and exasperating)
queries.  Jonathan showed me the way forward at an early stage and
devised most of the macros.

I look forward to picking this project up again in a week or so, or
learning from my Org colleagues that the project ought to be scuttled.

All the best,
Tom

-- 
T.S. Dye & Colleagues, Archaeologists
735 Bishop St, Suite 315, Honolulu, HI 96813
Tel: 808-529-0866, Fax: 808-529-0884
http://www.tsdye.com

             reply	other threads:[~2013-02-25 20:22 UTC|newest]

Thread overview: 45+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-02-25 20:21 Thomas S. Dye [this message]
2013-02-25 21:21 ` [RFC] Org version of the Org manual Carsten Dominik
2013-03-04 21:28 ` Achim Gratz
2013-03-06  3:14   ` Thomas S. Dye
2013-03-06  7:44     ` Yagnesh Raghava Yakkala
2013-03-06  8:18       ` Achim Gratz
2013-03-06  8:29         ` Bastien
2013-03-06  8:40           ` Nicolas Goaziou
2013-03-06  8:44           ` Achim Gratz
2013-03-06 10:18             ` Jambunathan K
2013-03-07 17:35       ` Thomas S. Dye
2013-03-07 18:22         ` Achim Gratz
2013-03-07 18:49           ` Thomas S. Dye
2013-03-09 23:53           ` Thomas S. Dye
2013-03-10 12:24             ` Achim Gratz
2013-03-10 19:01               ` Jonathan Leech-Pepin
2013-03-10 19:25                 ` Achim Gratz
2013-03-10 19:39                   ` Jonathan Leech-Pepin
2013-03-10 20:23                     ` Nicolas Goaziou
2013-03-10 20:40                       ` Jonathan Leech-Pepin
2013-03-11  0:32               ` Thomas S. Dye
2013-03-11  6:43                 ` Achim Gratz
2013-03-11 16:18                   ` Thomas S. Dye
2013-03-16 16:00 ` Achim Gratz
2013-03-17  1:19   ` Thomas S. Dye
2013-03-17  5:50     ` Carsten Dominik
2013-03-17  6:54       ` Achim Gratz
2013-03-17 12:33         ` Carsten Dominik
2013-03-17 13:34           ` Achim Gratz
2013-03-17 15:37             ` Carsten Dominik
2013-03-17 17:36               ` Achim Gratz
2013-03-17 19:58                 ` Carsten Dominik
2013-03-17  7:01       ` Sebastien Vauban
2013-03-17 12:36         ` Carsten Dominik
2013-03-17 10:28 ` Achim Gratz
2013-03-21 21:02   ` Nicolas Goaziou
2013-03-22  7:50     ` Achim Gratz
2013-03-22 14:22       ` Nicolas Goaziou
2013-03-22 16:46         ` Achim Gratz
2013-03-22 18:17           ` Nicolas Goaziou
2013-03-23  7:32             ` Achim Gratz
2013-03-23 20:17               ` Nicolas Goaziou
2013-04-27 18:16   ` Achim Gratz
2013-04-28  7:29     ` Nicolas Goaziou
2013-04-28  8:28       ` Achim Gratz

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=m1bob8cffh.fsf@tsdye.com \
    --to=tsd@tsdye.com \
    --cc=emacs-orgmode@gnu.org \
    /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).