From mboxrd@z Thu Jan 1 00:00:00 1970 From: Stefan Vollmar Subject: index support for publishing Date: Mon, 01 Feb 2010 22:41:47 +0100 Message-ID: <50E7BE9E-C5BE-4DFA-B462-678A8FA47468@nf.mpg.de> Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: quoted-printable Return-path: Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Nc41t-0005zi-Me for emacs-orgmode@gnu.org; Mon, 01 Feb 2010 16:41:57 -0500 Received: from [199.232.76.173] (port=51543 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Nc41t-0005zW-9a for emacs-orgmode@gnu.org; Mon, 01 Feb 2010 16:41:57 -0500 Received: from Debian-exim by monty-python.gnu.org with spam-scanned (Exim 4.60) (envelope-from ) id 1Nc41o-0007NG-Cg for emacs-orgmode@gnu.org; Mon, 01 Feb 2010 16:41:56 -0500 Received: from mail.nf.mpg.de ([134.95.44.50]:36035) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1Nc41n-0007MK-Vv for emacs-orgmode@gnu.org; Mon, 01 Feb 2010 16:41:52 -0500 Received: from [192.168.178.21] (pD9E62855.dip.t-dialin.net [217.230.40.85]) by mail.nf.mpg.de (Sun Java(tm) System Messaging Server 6.3-8.03 (built Apr 24 2009; 32bit)) with ESMTPSA id <0KX600E16N0FCX00@mail.nf.mpg.de> for emacs-orgmode@gnu.org; Mon, 01 Feb 2010 22:43:28 +0100 (MET) List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode Hallo, we have been using org-mode to create HTML output for several projects = and this has worked so well that we want to change some of our software = documentation from LaTeX to org. In this recent example, = http://www.nf.mpg.de/vhist/usage.html, we are happy with the result (we = still use too many macros and will provide the org-source when we have = cleaned it up a bit; I really like the tables with alternating row = styles).=20 However, this is already plenty of content for one single HTML document. = We are now looking for a good strategy on how to split content into = multiple org-files that can then be used to create multiple, linked HTML = files for another, more complex documentation project. With "Publishing", http://orgmode.org/manual/Publishing.html, org-mode = already has a lot of support for this. What is missing, from our point = of view, is support for one (optional) index file. Here is a suggestion: (1)=20 * My Section :INDEX: Special Section Name Some contents... * Another Section :INDEX: more contents... (2) During publishing, for each org-file a corresponding .orgx file = could be written, containing one line for each INDEX line: [[org-link to corresponding section in org-file][desc]] where defaults to the section name but is the argument after = :INDEX: if provided. =20 (3) The index could then be generated by reading all .orgx-files, = sorting the parts of the links and generating a simple list of = sorted links. This might prove useful for LaTeX, but would definetely be = interesting for HTML output. We could manage this on our own, provided = we get some help with (2). Generating the index file is probably pretty = fast, so in (2) one could do this "on-the-fly", however, I have a = feeling that pulling meta information from org-files in corresponding = files might prove useful for all sorts of post-processing later. Warm regards, Stefan --=20 Dr. Stefan Vollmar, Dipl.-Phys. Max-Planck-Institut f=FCr neurologische Forschung Gleuelerstr. 50, 50931 K=F6ln, Germany Tel.: +49-221-4726-213 FAX +49-221-4726-298 Tel.: +49-221-478-5713 Mobile: 0160-93874279 Email: vollmar@nf.mpg.de http://www.nf.mpg.de