notes.org @@ -6,7 +6,7 @@ lang="en" xml:lang="en"> <title>EMACS ORG-INFO.JS</title> <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/> <meta name="generator" content="Org-mode"/> -<meta name="generated" content="2008-09-06 15:38:25 CEST"/> +<meta name="generated" content="2008-09-06 17:34:16 CEST"/> <meta name="author" content="Sebastian Rose"/> <style type="text/css"> html { font-family: Times, serif; font-size: 12pt; } @@ -116,31 +116,31 @@ org_html_manager.setup(); // activate after the parameterd are set -The org-info.js JavaScript (subsequently called the script) and its setup -are still under development and might change frequently. This documentation -might as well be outdated by the time you read this. If you don't mind using -it anyway and adjust your org export options at times we wish you good luck -and hope the fun will outweigh your effort. +WARNING org-info.js is under development and changes frequently. This documentation is likely to be out of date. -The aim of this little script is to implement a part of emacs Org-mode -facilities (folding in the first place) in the XHTML-exported files and to -display them in a linuxdoc like way. This documentation is one XHTML file, -exported from one *.org file using a single keyboard shortcut. No additional -postprocessing was done. +org-info-js (subsequently called the script) implements part of +Emacs Org-mode in it's XHTML-exported files, allowing them to be +rendered and browsed in a linuxdoc/info style. + + +This documentation is one XHTML file, exported from one *.org file +using a single keyboard shortcut. No additional postprocessing was +done. There are no external dependencies and the script is small +and fast, even for large files. It is used on the <a href="http://orgmode.org/Changes.html">org-mode site</a> to +display <code>ORGWEBPAGE/Changes.org</code> which has over 220. -There are no external dependencies. The script is quite small and fast enough -for larger files too. I tested it with the file <code>ORGWEBPAGE/Changes.org</code> in -the <code>Org-mode</code> package which gave me 225 pages to handle and on my old -omnibook it still worked nicely. The current version tries to do so over the -net too (see <a href="http://orgmode.org/Changes.html">http://orgmode.org/Changes.html</a>). +If you don't mind using it despite the health warnings and +adjusting your org export options occaisionally we wish you good +luck and hope the fun will outweigh your effort. -There are some drawbacks though. It is currently not possible to open internal -links in another tab (e.g. using middle click in Firefox) due my poor -JavaScript knowledge. This is not very high on my TODO list since the history -mechanism of the script is a good alternative to tab usage. +There are some drawbacks though. It is currently not possible to +open internal links in another tab (e.g. using middle click in +Firefox) due my poor JavaScript knowledge. This is not very high on +my TODO list since the history mechanism of the script is a good +alternative to tab usage. A list of Changes can be found <a href="changes.ord">here</a> (separat file). @@ -495,38 +495,35 @@ Thanks Carsten, for this beautifull table! -This section describes the setup of your org files for the utilisation of the -script. <a href="#sec-4.1">Export-Setup - the new Way</a> will guide you to setup your org XHTML -export. That section refers to an Org-mode version >= 6.02. For those using an +This section describes how to setup your org files to use the +script. <a href="#sec-4.1">Export-Setup - the new Way</a> covers setting up org XHTML +export with Org-mode version >= 6.02. For those using an older Org-mode version < 6.02 the next section (<a href="#sec-4.2">Export-Setup - the old Way</a>) remains. <a href="#sec-9.1">Using Set()</a> contains a list of all supported options for adjusting the <code>org_html_manager</code> to suit your needs. -A sufficient up to date version is available for download on <a href="http://orgmode.org/#sec-3">orgmode.org</a> or -in the git repo: +A reasonably recent version is available for download on <a href="http://orgmode.org/#sec-3">orgmode.org</a> +whilst the latest version is in the git repo: <pre class="example"> -git-clone git://repo.or.cz/org-mode.git +git-clone git://github.com/SebastianRose/org-info-js.git </pre> -This script will not work with the XHTML export as distributed with the -current Org-mode package (and hence emacs 22.x) anymore (??). But I'm afraid -there are good chances the new exporter is in emacs before this thing here -enters a somewhat stable state :-) +This script will not work with the XHTML exporter that comes with +Org-mode in Emacs 22.x. -To produce this XHTML file I used the current version of Org-mode and it's -XHTML export. The structure of the exported XHTML has changed a bit in -beginning of March 2008 to support scripting an other tools that work on -<code>XML</code>. Thanks to Carsten Dominik who found the time to modify the current -export modul to produce the draft version of the next generation XHTML. The -new structure won't break any of your stylesheets though. +The current version of Org-mode was used to produce this XHTML file +with the new exporter which was revised by Carsten Dominik in March +2008 (in Org-mode v5.23a+) to better support <code>XML</code>. You can use +<code>M-x org-version</code> to see which version of Org-mode you have +installed. -The new export made it into git somewhere around version 5.23a+. Try <code>M-x org-version</code> to find out about your Org-mode version. +The new XHTML structure won't break any of your stylesheets. </div> @@ -537,9 +534,9 @@ The new export made it into git somewhere around version 5.23a+. Try <code>M-x -There is no need to do something you don't do occasionally in Org-mode when -it comes to XHTML export. Just use one of the ordinary ways to include -something into the head of the resulting html file. +org-info-js now supports the standard Org-mode methods for +exporting XHTML, and including extra data in the head of the +exported file. The modern way of org export setup provides extra options to include and @@ -960,8 +957,8 @@ The functionality of the script is based on <code>DOM</code>. This leads to some incompatibility with legacy browsers. But hey, it's 2008, isn't it? -So what browsers are supported then? Well - I do not know for -shure. JavaScript™ 1.4 plus <code>DOM</code> should make +So what browsers are supported then? Well - I don't know for +sure. JavaScript™ 1.4 plus <code>DOM</code> should make <ul> <li> Netscape 6.0 and higher @@ -983,7 +980,7 @@ Safari 1.0 I have written and tested the script only in current Firefox, Opera and IE 6 -so far for a lack of spare time, operation systems on my laptop, and installed +so far for a lack of spare time, operating systems on my laptop, and installed browsers. IE is not fully supported (position fixed…) but fairly working. Firefox 2 is anyoing slow as with all web pages heavily utilising JavaScript. I recently installed Firefox 3.0 Beta which works much better. For @@ -1352,7 +1349,7 @@ the usefull tips. Espacially the negative margin trick and key input. And again big thanks to Carsten Dominik for making the inclusion and configuration of the script so easy for the users, all the inspired ideas and the great org radio table trick. A lot of the power of the final make up is -your merit! We all love to read the best of all mailing lists because of the +your merit! We all love to read the Org-mode mailing lists because of the kind and relaxed tone that is yours. @@ -1405,7 +1402,7 @@ indentation. <code>ALT+LEFT/RIGHT</code> promotes and demotes the subtree. <div id="postamble"> Author: Sebastian Rose <a href="mailto:sebastian_rose@gmx.de"><sebastian_rose@gmx.de></a> - Date: 2008-09-06 15:38:25 CEST + Date: 2008-09-06 17:34:16 CEST HTML generated by org-mode 6.06b in emacs 23 </div></body> </html> index.html @@ -10,28 +10,28 @@ * The Name of the Game - The org-info.js JavaScript (subsequently called /the script/) and its setup - are still under development and might change frequently. This documentation - might as well be outdated by the time you read this. If you don't mind using - it anyway and adjust your org export options at times we wish you good luck - and hope the fun will outweigh your effort. + *WARNING org-info.js is under development and changes frequently. + This documentation is likely to be out of date.* - The aim of this little script is to implement a part of emacs Org-mode - facilities (folding in the first place) in the XHTML-exported files and to - display them in a linuxdoc like way. This documentation is one XHTML file, - exported from one *.org file using a single keyboard shortcut. No additional - postprocessing was done. - - There are no external dependencies. The script is quite small and fast enough - for larger files too. I tested it with the file =ORGWEBPAGE/Changes.org= in - the =Org-mode= package which gave me 225 pages to handle and on my old - omnibook it still worked nicely. The current version tries to do so over the - net too (see [[http://orgmode.org/Changes.html]]). - - There are some drawbacks though. It is currently not possible to open internal - links in another tab (e.g. using middle click in Firefox) due my poor - JavaScript knowledge. This is not very high on my TODO list since the history - mechanism of the script is a good alternative to tab usage. + org-info-js (subsequently called /the script/) implements part of + Emacs Org-mode in it's XHTML-exported files, allowing them to be + rendered and browsed in a linuxdoc/info style. + + This documentation is one XHTML file, exported from one *.org file + using a single keyboard shortcut. No additional postprocessing was + done. There are no external dependencies and the script is small + and fast, even for large files. It is used on the [[http://orgmode.org/Changes.html][org-mode site]] to + display =ORGWEBPAGE/Changes.org= which has over 220. + + If you don't mind using it despite the /health warnings/ and + adjusting your org export options occaisionally we wish you good + luck and hope the fun will outweigh your effort. + + There are some drawbacks though. It is currently not possible to + open internal links in another tab (e.g. using middle click in + Firefox) due my poor JavaScript knowledge. This is not very high on + my TODO list since the history mechanism of the script is a good + alternative to tab usage. A list of Changes can be found [[file:changes.ord][here]] (separat file). @@ -208,46 +208,42 @@ * <<<Setup>>> - This section describes the setup of your org files for the utilisation of the - script. [[Export-Setup - the new Way]] will guide you to setup your org XHTML - export. That section refers to an Org-mode version >= 6.02. For those using an + This section describes how to setup your org files to use the + script. [[Export-Setup - the new Way]] covers setting up org XHTML + export with Org-mode version >= 6.02. For those using an older Org-mode version < 6.02 the next section ([[Export-Setup - the old Way]]) remains. [[Using Set()]] contains a list of all supported options for adjusting the =org\_html\_manager= to suit your needs. - A sufficient up to date version is available for download on [[http://orgmode.org/#sec-3][orgmode.org]] or - in the git repo: + A reasonably recent version is available for download on [[http://orgmode.org/#sec-3][orgmode.org]] + whilst the latest version is in the git repo: - :git-clone git://repo.or.cz/org-mode.git + :git-clone git://github.com/SebastianRose/org-info-js.git - This script will not work with the XHTML export as distributed with the - current Org-mode package (and hence emacs 22.x) anymore (??). But I'm afraid - there are good chances the new exporter is in emacs before this thing here - enters a somewhat stable state :-) + This script will not work with the XHTML exporter that comes with + Org-mode in Emacs 22.x. - To produce this XHTML file I used the current version of Org-mode and it's - XHTML export. The structure of the exported XHTML has changed a bit in - beginning of March 2008 to support scripting an other tools that work on - =XML=. Thanks to Carsten Dominik who found the time to modify the current - export modul to produce the draft version of the next generation XHTML. The - new structure won't break any of your stylesheets though. + The current version of Org-mode was used to produce this XHTML file + with the new exporter which was revised by Carsten Dominik in March + 2008 (in Org-mode v5.23a+) to better support =XML=. You can use + =M-x org-version= to see which version of Org-mode you have + installed. - The new export made it into git somewhere around version 5.23a+. Try =M-x - org-version= to find out about your Org-mode version. + The new XHTML structure won't break any of your stylesheets. ** <<Export-Setup - the new Way>> - There is no need to do something you don't do occasionally in Org-mode when - it comes to XHTML export. Just use one of the ordinary ways to include - something into the head of the resulting html file. + org-info-js now supports the standard Org-mode methods for + exporting XHTML, and including extra data in the head of the + exported file. - The modern way of org export setup provides extra options to include and - configure the script, as well as a emacs customize interface for this same - purpose. Options set in customize may be overwritten on a per-file basis - using one or more special =#+INFOJS_OPT:= lines in the head of your org - file. + The modern way of org export setup provides extra options to include and + configure the script, as well as a emacs customize interface for this same + purpose. Options set in customize may be overwritten on a per-file basis + using one or more special =#+INFOJS_OPT:= lines in the head of your org + file. - As an example, the head of this org file looks like: + As an example, the head of this org file looks like: #+BEGIN_SRC org #+INFOJS_OPT: path:org-info.js #+INFOJS_OPT: toc:nil localtoc:t view:info mouse:underline @@ -479,8 +475,8 @@ org_html_manager.setup (); The functionality of the script is based on =DOM=. This leads to some incompatibility with legacy browsers. But hey, it's 2008, isn't it? - So what browsers are supported then? Well - I do not know for - shure. JavaScript™ 1.4 plus =DOM= should make + So what browsers are supported then? Well - I don't know for + sure. JavaScript™ 1.4 plus =DOM= should make + Netscape 6.0 and higher + Internet Explorer 5.0 and up + Firefox 1.0 ++ - 2.0.0.12 and 3.0 Beta tested @@ -488,7 +484,7 @@ org_html_manager.setup (); + Safari 1.0 I have written and tested the script only in current Firefox, Opera and IE 6 - so far for a lack of spare time, operation systems on my laptop, and installed + so far for a lack of spare time, operating systems on my laptop, and installed browsers. IE is not fully supported (position fixed...) but fairly working. Firefox 2 is anyoing slow as with all web pages heavily utilising JavaScript. I recently installed Firefox 3.0 Beta which works much better. For @@ -724,7 +720,7 @@ org_html_manager.setup (); And again big thanks to Carsten Dominik for making the inclusion and configuration of the script so easy for the users, all the inspired ideas and the great org radio table trick. A lot of the power of the final make up is - your merit! We all love to read the best of all mailing lists because of the + your merit! We all love to read the Org-mode mailing lists because of the kind and relaxed tone that is yours. Thanks a lot for OrgMode! index.org 293db34752b5a622441b4b5e275a55fca4836e0d 5ffeff6cd0042fad1e78a35339367e3920b1ac91 Sebastian Rose, Hannover, Germany sebastian_rose@gmx.de http://github.com/SebastianRose/org-info-js/commit/4bb410089d48b193fb6ecf63cf57f5751d7d7d2f 4bb410089d48b193fb6ecf63cf57f5751d7d7d2f

2008-09-06T08:34:43-07:00

mergerd Ricks changes. 5fb30415f9357d02d9ce71666443ffe269e40a05 Sebastian Rose, Hannover, Germany sebastian_rose@gmx.de