-
Notifications
You must be signed in to change notification settings - Fork 17
/
index.html
1376 lines (1163 loc) · 45.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
lang="en" xml:lang="en">
<head>
<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-10-27 02:15:26 CET"/>
<meta name="author" content="Sebastian Rose"/>
<style type="text/css">
<![CDATA[
html { font-family: Times, serif; font-size: 12pt; }
.title { text-align: center; }
.todo { color: red; }
.done { color: green; }
.tag { background-color:lightblue; font-weight:normal }
.target { }
.timestamp { color: grey }
.timestamp-kwd { color: CadetBlue }
p.verse { margin-left: 3% }
pre {
border: 1pt solid #AEBDCC;
background-color: #F3F5F7;
padding: 5pt;
font-family: courier, monospace;
font-size: 90%;
overflow:auto;
}
table { border-collapse: collapse; }
td, th { vertical-align: top; }
dt { font-weight: bold; }
.org-info-js_info-navigation { border-style:none; }
#org-info-js_console-label { font-size:10px; font-weight:bold;
white-space:nowrap; }
.org-info-js_search-highlight {background-color:#ffff00; color:#000000;
font-weight:bold; }
]]>
</style><link rel="stylesheet" type="text/css" href="stylesheet.css" />
<script type="text/javascript" src="org-info.js"></script>
<script type="text/javascript" >
/* <![CDATA[ */
org_html_manager.set("TOC_DEPTH", "3");
org_html_manager.set("LINK_HOME", "http://orgmode.org");
org_html_manager.set("LINK_UP", "http://orgmode.org/worg/");
org_html_manager.set("LOCAL_TOC", "1");
org_html_manager.set("VIEW_BUTTONS", "0");
org_html_manager.set("MOUSE_HINT", "underline");
org_html_manager.set("FIXED_TOC", "0");
org_html_manager.set("TOC", "0");
org_html_manager.set("VIEW", "info");
org_html_manager.setup(); // activate after the parameterd are set
/* ]]> */
</script>
</head><body>
<h1 id="title">EMACS ORG-INFO.JS</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#sec-1">1 The Name of the Game</a>
<ul>
<li><a href="#sec-1.1">1.1 Terms used throughout this Document</a></li>
</ul>
</li>
<li><a href="#sec-2">2 Features</a>
<ul>
<li><a href="#sec-2.1">2.1 Appearance</a></li>
<li><a href="#sec-2.2">2.2 Keyboard navigation</a></li>
<li><a href="#sec-2.3">2.3 Searching</a></li>
<li><a href="#sec-2.4">2.4 Miscelaneous</a></li>
</ul>
</li>
<li><a href="#sec-3">3 Shortcuts</a></li>
<li><a href="#sec-4">4 Setup</a>
<ul>
<li><a href="#sec-4.1">4.1 Export-Setup - the new Way</a>
<ul>
<li><a href="#sec-4.1.1">4.1.1 Using customize</a></li>
<li><a href="#sec-4.1.2">4.1.2 Per File Basis: #+INFOJS_OPT</a></li>
</ul>
</li>
<li><a href="#sec-4.2">4.2 Export-Setup - the old Way</a>
<ul>
<li><a href="#sec-4.2.1">4.2.1 Using a special * COMMENT Section</a></li>
<li><a href="#sec-4.2.2">4.2.2 Using customize</a></li>
<li><a href="#sec-4.2.3">4.2.3 Export-Setup per Project</a></li>
</ul></li>
</ul>
</li>
<li><a href="#sec-5">5 Linking to Files using the Script</a></li>
<li><a href="#sec-6">6 CSS</a></li>
<li><a href="#sec-7">7 Supported Browsers</a>
<ul>
<li><a href="#sec-7.1">7.1 People reported it works in</a></li>
</ul>
</li>
<li><a href="#sec-8">8 Why Do I Need a T.O.C?</a></li>
<li><a href="#sec-9">9 The XHTML</a>
<ul>
<li><a href="#sec-9.1">9.1 Using Set()</a></li>
</ul>
</li>
<li><a href="#sec-10">10 How it works</a></li>
<li><a href="#sec-11">11 Presentations with org-info.js</a></li>
<li><a href="#sec-12">12 History</a></li>
<li><a href="#sec-13">13 Thanks</a></li>
<li><a href="#sec-14">14 License</a></li>
<li><a href="#sec-15">15 THE END</a></li>
</ul>
</div>
</div>
<div id="outline-container-1" class="outline-2">
<h2 id="sec-1">1 The Name of the Game</h2>
<div id="text-1">
<p>
<b>WARNING org-info.js is under development and changes frequently. This documentation is likely to be out of date.</b>
</p>
<p>
org-info-js (subsequently called <i>the script</i>) implements part of
Emacs Org-mode in it's XHTML-exported files, allowing them to be
rendered and browsed in a linuxdoc/info style.
</p>
<p>
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.
</p>
<p>
If you don't mind using it despite the <i>health warnings</i> and
adjusting your org export options occaisionally we wish you good
luck and hope the fun will outweigh your effort.
</p>
<p>
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.
</p>
<p>
A list of Changes can be found <a href="#sec-1">here</a> (separat file).
</p>
<p>
Go to the next section by pressing '<code>n</code>'.
</p>
<p>
Find out about shortcuts in section <a href="#sec-3">Shortcuts</a> (and come back here
pressing '<code>b</code>').
</p>
<p>
'<code>?</code>' will show all shortcuts available.
</p>
</div>
<div id="outline-container-1.1" class="outline-3">
<h3 id="sec-1.1">1.1 <span class="target">Terms used throughout this Document</span> </h3>
<div id="text-1.1">
<p>
I tend to talk about view modes. One may toggle the view mode by pressing
'<code>m</code>' or click the <i>toggle view</i> link. Currently two view modes exist.
</p>
<dl>
<dt><b>info view mode</b></dt><dd>
<p>
This mode displays the sections one by one, paged like the typical
linuxdoc or texinfo files. This is the view mode you should face when
first visiting this documentation.
</p>
</dd>
<dt><b>plain view mode</b></dt><dd>
<p>
This mode displays the entire file. In this mode the sections are foldable
by clicking the headlines or pressing '<code>f</code>' (fold). The entire structure
of the document my be (un-)folded using '<code>F</code>'.
</p>
</dd>
<dt><b>presentation mode</b></dt><dd>
<p>
This mode displays sections one by as slides. Still
very rustic and experimental. Rick Moynihan embarked and we plan a separat
tool for presentations.
</p>
</dd>
</dl>
<p><b>T.O.C.</b> is used for the table of contents. The table of contents may be
visited using '<code>i</code>' (index) regardless of its visibility.
</p>
<p>
A <b>section</b> is everything with a headline.
</p>
</div>
</div>
</div>
<div id="outline-container-2" class="outline-2">
<h2 id="sec-2">2 <span class="target">Features</span> </h2>
<div id="text-2">
</div>
<div id="outline-container-2.1" class="outline-3">
<h3 id="sec-2.1">2.1 Appearance</h3>
<div id="text-2.1">
<dl>
<dt><b>Toggle plain view, info view and presentation</b></dt><dd>
<p>
One can click the script-generated links in info view mode to read through
the whole file page by page. By clicking on '<i>toggle view</i>' (or pressing
`m´) you can switch between info and plain view mode. The presentation mode
is very rudimentary and just a quick hack realy. Press 'x' to see it.
</p></dd>
<dt><b>Keep place in file when toggling</b></dt><dd>
<p>
When changing the view mode via the '<i>toggle view</i>' links, the reader gets
the same part of the document presented after the view change as he saw
before.
</p></dd>
<dt><b>Cut the TOC</b></dt><dd>
<p>
You may cut the table of contents to a certain depth. The splitting of the
document is not affected by this option. Hence you might set the level of
headlines to 4, but cut the TOC to show only the first two levels.
</p></dd>
<dt><b>Optional subindexes</b></dt><dd>
<p>
The script optionally creates subindexes under the headline of a section
containing subsections not exceeding <code>org-export-headline-levels</code>. This
was done to get a more texinfo/linuxdoc kind of feel and a better
orientaton.
</p></dd>
<dt><b>Startupview customizable</b></dt><dd>
<p>
Choose how to display the document on load. Info-like or plain and more.
</p></dd>
<dt><b>Toggle links everywhere / only on top</b></dt><dd>
<p>
You may choose to display the '<i>toggle view</i>' links above every headline
or just next the current sections headline.
</p></dd>
<dt><b>Numbered pages</b></dt><dd>
<p>
In info view mode every page gets a page number starting from one.
</p></dd>
<dt><b>Markright alike headings</b></dt><dd>
<p>
Info view mode only. Similar to the <code>\markright</code> command in LaTeX
the Title of the current sections parent appears on top of each page. In
subsections this heading can be use as link up to start of the parent
section (see top of this page when you're in info view mode). You can move
to the parent section by pressing `u´ (up).
</p></dd>
<dt><b>Tooltips</b></dt><dd>
<p>
Moving the mouse on the navigation links shows a tooltip with name of
next/previous section.
</p></dd>
<dt><b>Hide T.O.C.</b></dt><dd>
<p>
The T.O.C. can be hidden completly. Hitting '<code>i</code>' still will show it. When
showing the T.O.C. hitting '<code>i</code>' any navigation command ('<code>n</code>', '<code>p</code>',
'<code>s</code>'…) will trigger an history-back. Thus the T.O.C. will not get in your
way when navigating the history later on.
</p>
</dd>
</dl>
</div>
</div>
<div id="outline-container-2.2" class="outline-3">
<h3 id="sec-2.2">2.2 Keyboard navigation</h3>
<div id="text-2.2">
<dl>
<dt><b>Easy keyboard navigation</b></dt><dd>
<p>
See Section <a href="#sec-3">Shortcuts</a> for a list of shortcuts.
</p></dd>
<dt><b>Customizable features</b></dt><dd>
<p>
All features are customizable simply by setting up your export options
template (see <a href="#sec-1">Usage</a>).
</p></dd>
<dt><b>Folding</b></dt><dd>
<p>
Emulates the way of folding in emacs Org-mode. Mouse supported.
</p>
</dd>
</dl>
</div>
</div>
<div id="outline-container-2.3" class="outline-3">
<h3 id="sec-2.3">2.3 Searching</h3>
<div id="text-2.3">
<dl>
<dt><b>Full text-search with highlighting</b></dt><dd>
<p>
Search forward, backwards, repeated search… This is still experimental.
</p></dd>
<dt><b>Occur mode</b></dt><dd>
<p>
As experimental as the text-search, but I love this one. You may link to a
file using this script like this: <code>index.html?OCCUR=java</code>
</p></dd>
<dt><b>Tags index</b></dt><dd>
<p>
'<code>C</code>' shows a table of contents based on tags. Inherited tags are not
supported yet. This was an <a href="http://lists.gnu.org/archive/html/emacs-orgmode/2008-07/msg00434.html">idea of Rick Moynihan</a>.
</p>
</dd>
</dl>
</div>
</div>
<div id="outline-container-2.4" class="outline-3">
<h3 id="sec-2.4">2.4 Miscelaneous</h3>
<div id="text-2.4">
<dl>
<dt><b>Inter-linking</b></dt><dd>
<p>
The exported pages can be linked to the homepage and an directory index or
some other sort of parent file.
</p></dd>
<dt><b>Adjusted internal links</b></dt><dd>
<p>
Internal links to section headings are automatically adjusted to work with
this script. When following such internal links, one may go back again
using '<code>b</code>'.
</p></dd>
<dt><b>Detect the target in the URL</b></dt><dd>
<p>
If the URL is suffixed by '<code>#sec-x.y.z</code>' that section will be displayed
after startup.
</p></dd>
<dt><b>Structure is taken from export preferences</b></dt><dd>
<p>
The paging is done according to your setting of
<code>org-export-headline-levels</code>. Scanning the T.O.C. is a good way to get
around browser detection. An option to hide the T.O.C. exists.
</p></dd>
<dt><b>Startup information</b></dt><dd>
<p>
Show a little message on page load to tell the visitor about the script
usage.
</p></dd>
<dt><b>Wrap text before first headline</b></dt><dd>
<p>
This is a temporary fix for the
missing <code><p></code> element around the text before the first headline,
available since version 0.0.7.3a. If you export with <code>skip:nil</code>, you
may add this to your stylesheet:
</p><pre class="example">
#text-before-first-headline {color:red;font-weight:bold;}
</pre>
</dd>
</dl>
</div>
</div>
</div>
<div id="outline-container-3" class="outline-2">
<h2 id="sec-3">3 <span class="target">Shortcuts</span> </h2>
<div id="text-3">
<p>
The visitor of this file (and every XHTML-exported org file that includes the
script) may use the mouse or the following keys to navigate. '<code>?</code>' should give
you a list of shortcuts too.
</p>
<p>
The script always tries to keep the last selected section visible. This is
somewhat strange when scrolling, but really helpfull for keyboard navigation.
</p>
<p>
If the keyboard shortcuts work for you, drop me a mail and tell me your
browser and its version so we can put it on list of <a href="#sec-7">supported browsers</a>.
</p>
<p>
The TOC is handled specially, when hidden. If you press '<code>i</code>', the TOC is
displayed. Any subsequent key press goes back to where you've been before. The
TOC does not show up the history. Same applies to the keyboard help.
</p>
<table border="0" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<col align="left"></col><col align="left"></col>
<thead>
<tr><th>Key</th><th>Function</th></tr>
</thead>
<tbody>
<tr><td>? / ¿</td><td>show this help screen</td></tr>
</tbody>
<tbody>
<tr><td></td><td><b>Moving around</b></td></tr>
<tr><td>n / p</td><td>goto the next / previous section</td></tr>
<tr><td>N / P</td><td>goto the next / previous sibling</td></tr>
<tr><td>t / E</td><td>goto the first / last section</td></tr>
<tr><td>g</td><td>goto section…</td></tr>
<tr><td>u</td><td>go one level up (parent section)</td></tr>
<tr><td>i / C</td><td>show table of contents / tags index</td></tr>
<tr><td>b / B</td><td>go back to last / forward to next visited section.</td></tr>
<tr><td>h / H</td><td>go to main index in this directory / link HOME page</td></tr>
</tbody>
<tbody>
<tr><td></td><td><b>View</b></td></tr>
<tr><td>m / x</td><td>toggle the view mode between info and plain / presentation</td></tr>
<tr><td>f / F</td><td>fold current section / whole document (plain view only)</td></tr>
</tbody>
<tbody>
<tr><td></td><td><b>Searching</b></td></tr>
<tr><td>s / r</td><td>search forward / backward….</td></tr>
<tr><td>S / R</td><td>search again forward / backward</td></tr>
<tr><td>o</td><td>occur-mode</td></tr>
<tr><td>c</td><td>clear search highlights</td></tr>
</tbody>
<tbody>
<tr><td></td><td><b>Misc</b></td></tr>
<tr><td>l / L</td><td>display HTML link / Org link</td></tr>
<tr><td>v / V</td><td>scroll down / up</td></tr>
</tbody>
</table>
<p>
Thanks Carsten, for this beautifull table!
</p>
</div>
</div>
<div id="outline-container-4" class="outline-2">
<h2 id="sec-4">4 <span class="target">Setup</span> </h2>
<div id="text-4">
<p>
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.
</p>
<p>
A reasonably recent org version is available for download on <a href="http://orgmode.org/#sec-4">orgmode.org</a>
whilst the latest version of the script is in the git repo:
</p>
<pre class="example">
git-clone git://github.com/SebastianRose/org-info-js.git
</pre>
<p>
This script will not work with the XHTML exporter that comes with
Org-mode in Emacs 22.x.
</p>
<p>
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.
</p>
<p>
The new XHTML structure won't break any of your stylesheets.
</p>
</div>
<div id="outline-container-4.1" class="outline-3">
<h3 id="sec-4.1">4.1 <span class="target">Export-Setup - the new Way</span> </h3>
<div id="text-4.1">
<p>
org-info-js now supports the standard Org-mode methods for
exporting XHTML, and including extra data in the head of the
exported file.
</p>
<p>
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 <code>#+INFOJS_OPT:</code> lines in the head of your org
file.
</p>
<p>
As an example, the head of this org file looks like:
<pre class="src src-org"><span style="color: #b22222; font-style: italic;">#+INFOJS_OPT: path:org-info.js</span>
<span style="color: #b22222; font-style: italic;">#+INFOJS_OPT: toc:nil localtoc:t view:info mouse:underline</span>
<span style="color: #b22222; font-style: italic;">#+INFOJS_OPT: up:http://www.legito.net/</span>
<span style="color: #b22222; font-style: italic;">#+INFOJS_OPT: home:http://orgmode.org buttons:nil</span>
</pre>
</p>
</div>
<div id="outline-container-4.1.1" class="outline-4">
<h4 id="sec-4.1.1">4.1.1 Using customize</h4>
<div id="text-4.1.1">
<p>
To use customize type
</p><pre class="example">
M-x customize-group RET org-export-html RET
</pre>
scroll to the bottom and click <code>Org Export HTML INFOJS</code>.
<p>
On this page three main options may be configured. <i>Org Export Html Use Infojs</i> is very good documented and <i>Org Infojs Template</i> should be
perfect by default. So I'll concentrate on <i>Org Infojs Options</i> here.
</p>
<dl>
<dt><code>path</code></dt><dd>
<p>
Absolute or relative URL to the script as used in in XHTML
links. '<code>org-info.js</code>' will find the file in the current
directory. Keep in mind that this will be the directory of the
exported file, eventually a directory on a server.
</p>
</dd>
<dt><code>view</code></dt><dd>
<p>
What kind of view mode should the script enter on startup? Possible
values are
</p><ul>
<li>
<code>info</code> — info view mode,
</li>
<li>
<code>overview</code> — plain view mode, only first level headlines visible,
</li>
<li>
<code>content</code> — plain view mode, all headlines visible,
</li>
<li>
<code>showall</code> — plain view mode showing the entire document.
</li>
</ul>
</dd>
<dt><code>toc</code></dt><dd>
<p>
Show the table of contents? <br/>
Possible values:
</p><ul>
<li>
<code>t</code> — show the toc,
</li>
<li>
<code>nil</code> — hide the toc (only show when '<code>i</code>' is pressed),
</li>
<li>
<code>Publishing/Export property</code> — derivate this setting from another
property like <code>org-export-with-toc</code>.
</li>
</ul>
</dd>
<dt><code>localtoc</code></dt><dd>
<p>
Should the script insert a local table of contents below the headings
of sections containing subsections? <br/>
Possible values:
</p><ul>
<li>
<code>t</code> — show the local toc,
</li>
<li>
<code>nil</code> — hide the toc (only show when '<code>i</code>' is pressed). This is
the default, if this option is omitted.
</li>
</ul>
</dd>
<dt><code>mouse</code></dt><dd>
<p>
Highlight the headline under the mouse in plain view mode?
</p><ul>
<li>
<code>underline</code> — underline the headline under mouse,
</li>
<li>
<code>#dddddd</code> — or any valid XHTML/CSS color value like <code>red</code> to draw a
colored background for the headline under the mouse.
</li>
</ul>
</dd>
<dt><code>runs</code></dt><dd>
<p>
<b>Obsolete</b>.
Number of attempts to scan the document. It's no risk to set this to a
higher value than the default. The <code>org_html_manager</code> will stop as
soon as the entire document is scanned.
</p>
</dd>
<dt><code>buttons</code></dt><dd>
<p>
Affects plain view mode only.
</p>
</dd>
</dl>
</div>
</div>
<div id="outline-container-4.1.2" class="outline-4">
<h4 id="sec-4.1.2">4.1.2 Per File Basis: #+INFOJS_OPT</h4>
<div id="text-4.1.2">
<p>
A single file may overwrite the global options using a line like this:
<pre class="src src-org"><span style="color: #b22222; font-style: italic;">#+INFOJS_OPT: view:info mouse:underline up:index.html home:http://www.mydomain.tpl toc:t</span>
</pre>
Possible options are the same as in the previous section. Additional (?)
options include:
</p>
<dl>
<dt><code>home</code></dt><dd>
<p>
An URL to link to the homepage. The text displayed is <code>HOME</code>.
</p></dd>
<dt><code>up</code></dt><dd>
<p>
An URL pointing to some main page. The text displayed is <code>Up</code>.
</p>
</dd>
</dl>
</div>
</div>
</div>
<div id="outline-container-4.2" class="outline-3">
<h3 id="sec-4.2">4.2 <span class="target">Export-Setup - the old Way</span> </h3>
<div id="text-4.2">
<p>
This section describes the old way to setup the script using the
<code>org-export-html-style</code> configuration. If you own a current version (6.00
++) of Org-mode you should better use <a href="#sec-4.1">Export-Setup - the new Way</a> of setting
up the export for script usage. You might want to read the sections <a href="#sec-9">The XHTML</a>
for more information. <a href="#sec-9.1">Using Set()</a> contains a list of all supported options
recognised by the script.
</p>
</div>
<div id="outline-container-4.2.1" class="outline-4">
<h4 id="sec-4.2.1">4.2.1 Using a special * COMMENT Section</h4>
<div id="text-4.2.1">
<p>
The second possibility to include the script is to add a special section
to the end of your org file (multiple lines possible):
</p>
<pre class="src src-org"><span style="color: #4d4d4d; font-size: 16.0pt; font-weight: bold;">* </span><span style="color: #bc8f8f;">COMMENT</span><span style="color: #4d4d4d; font-size: 16.0pt; font-weight: bold;"> html style specifications</span>
<span style="color: #b22222; font-style: italic;"># Local Variables:</span>
<span style="color: #b22222; font-style: italic;"># org-export-html-style: "<link rel=\"stylesheet\"</span>
<span style="color: #b22222; font-style: italic;"># type=\"text/css\" href=\"styles.css\" /></span>
<span style="color: #b22222; font-style: italic;"># <script type=\"text/javascript\" src=\"org-info.js\"></span>
<span style="color: #b22222; font-style: italic;"># </script></span>
<span style="color: #b22222; font-style: italic;"># <script type=\"text/javascript\"></span>
<span style="color: #b22222; font-style: italic;"># /* <![CDATA[ */</span>
<span style="color: #b22222; font-style: italic;"># org_html_manager.set(\"LOCAL_TOC\", 1);</span>
<span style="color: #b22222; font-style: italic;"># org_html_manager.set(\"VIEW_BUTTONS\", \"true\");</span>
<span style="color: #b22222; font-style: italic;"># org_html_manager.set(\"MOUSE_HINT\", \"underline\");</span>
<span style="color: #b22222; font-style: italic;"># org_html_manager.setup ();</span>
<span style="color: #b22222; font-style: italic;"># /* ]]> */</span>
<span style="color: #b22222; font-style: italic;"># </script>"</span>
<span style="color: #b22222; font-style: italic;"># End:</span>
</pre>
<p>
Ensure to precede all the verbatim double quotes with a backslash and
include the whole value of <code>org-export-html-style</code> into double quotes
itself.
</p>
</div>
</div>
<div id="outline-container-4.2.2" class="outline-4">
<h4 id="sec-4.2.2">4.2.2 Using customize</h4>
<div id="text-4.2.2">
<p>
One could customize the option '<code>org-export-html-style</code>' globaly by
</p><pre class="example">
M-x cuomize-variable RET org-export-html-style RET
</pre>
and set it there.
<pre class="src src-sgml"><<span style="color: #0000ff; font-weight: bold;">script</span> <span style="color: #4d4d4d;">type</span>=<span style="color: #006400;">"text/javascript"</span> <span style="color: #4d4d4d;">src</span>=<span style="color: #006400;">"org-info.js"</span>></<span style="color: #0000ff; font-weight: bold;">script</span>>
<<span style="color: #0000ff; font-weight: bold;">script</span> <span style="color: #4d4d4d;">type</span>=<span style="color: #006400;">"text/javascript"</span>>
/* <![CDATA[ */
org_html_manager.set(<span style="color: #006400;">"LOCAL_TOC"</span>, 1);
org_html_manager.set(<span style="color: #006400;">"VIEW_BUTTONS"</span>, <span style="color: #006400;">"true"</span>);
org_html_manager.set(<span style="color: #006400;">"MOUSE_HINT"</span>, <span style="color: #006400;">"underline"</span>);
org_html_manager.setup ();
/* ]]> */
</<span style="color: #0000ff; font-weight: bold;">script</span>>
</pre>
<p>
This way all your files will be exported using the script in the future.
</p>
</div>
</div>
<div id="outline-container-4.2.3" class="outline-4">
<h4 id="sec-4.2.3">4.2.3 Export-Setup per Project</h4>
<div id="text-4.2.3">
<p>
Last but not least and very handy is the possibility to setup the usage of
the script per project. This is a taylor made passage of the org manual:
</p>
<pre class="src src-lisp">(setq org-publish-project-alist
’((<span style="color: #006400;">"org"</span>
<span style="color: #0000ff;">:base-directory</span> <span style="color: #006400;">"~/org/"</span>
<span style="color: #0000ff;">:publishing-directory</span> <span style="color: #006400;">"~/public_html"</span>
<span style="color: #0000ff;">:section-numbers</span> nil
<span style="color: #0000ff;">:table-of-contents</span> nil
<span style="color: #0000ff;">:style</span> <span style="color: #006400;">"<link rel=stylesheet href=\"../other/mystyle.css\"
type=\"text/css\">
<script type=\"text/javascript\" src=\"org-info.js\"></script>
<script type=\"text/javascript\">
/* <![CDATA[ */
org_html_manager.setup ();
/* ]]> */
</script>"</span>)))
</pre>
<p>
Don't forget to add an export target for the script itself ;-)
</p>
</div>
</div>
</div>
</div>
<div id="outline-container-5" class="outline-2">
<h2 id="sec-5">5 <span class="target">Linking to Files using the Script</span> </h2>
<div id="text-5">
<p>
Just use the ordinary link syntax to link to files that use the script. Append
the section to the URL if neccessary:
</p>
<pre class="example">
http://www.domain.tld/path/to/org.html#sec-3.4
</pre>
<p>
One may overwrite the author's settings using special suffixes appended to the
URL of the script. Here are some examples linking to this section and changing
the intial view mode. Currently only the '<i>internal</i>' options are used (see
<a href="#sec-9.1">Using set()</a> for a list).
</p>
<ul>
<li>
<a href="index.html?TOC=1&VIEW=info#sec-5"><code>index.html?TOC=1&VIEW=info#sec-5</code></a>
</li>
<li>
<a href="index.html?TOC=0&VIEW=overview#sec-5"><code>index.html?TOC=0&VIEW=overview#sec-5</code></a>
</li>
<li>
<a href="index.html?VIEW=content&TOC_DEPTH=1#sec-5"><code>index.html?VIEW=content&TOC_DEPTH=1#sec-5</code></a>
</li>
<li>
<a href="index.html?VIEW=showall&MOUSE_HINT=rgb(255,133,0)#sec-5"><code>index.html?VIEW=showall&MOUSE_HINT=rgb(255,133,0)#sec-5</code></a>
</li>
<li>
<a href="index.html?OCCUR=java"><code><b>index.html?OCCUR=java</b></code></a>
</li>
</ul>
<p>
<b>Note</b> that it is not possible to change the '<i>HOME</i>' and '<i>Up</i>' links.
</p>
<p>
<b>Note</b> also that everything but <code>[0-9a-zA-Z\.-_]</code> should be URL encoded if used
as an options value.
</p>
</div>
</div>
<div id="outline-container-6" class="outline-2">
<h2 id="sec-6">6 <span class="target">CSS</span> </h2>
<div id="text-6">
<p>
There is currently only one CSS class used in the script. More style classes
will follow in the future.
</p>
<dl>
<dt><code>org-info-info-navigation</code></dt><dd>
<p>
Style for the navigation table in info view mode. I needed this one to avoid
border around that table. You may add lines like these to your stylesheet:
<pre class="src src-css"><span style="color: #b22222; font-style: italic;">/* </span><span style="color: #b22222; font-style: italic;">Style for org-info.js </span><span style="color: #b22222; font-style: italic;">*/</span>
<span style="color: #0000ff; font-weight: bold;">.org-info-js_info-navigation</span>
{
<span style="color: #4d4d4d;">border-style</span>:none;
}
<span style="color: #0000ff; font-weight: bold;">#org-info-js_console-label</span>
{
<span style="color: #4d4d4d;">font-size</span>:10px;
<span style="color: #4d4d4d;">font-weight</span>:bold;
<span style="color: #4d4d4d;">white-space</span>:nowrap;
}
<span style="color: #0000ff; font-weight: bold;">.org-info-js_search-highlight</span>
{
<span style="color: #4d4d4d;">background-color</span>:#ffff00;
<span style="color: #4d4d4d;">color</span>:#000000;
<span style="color: #4d4d4d;">font-weight</span>:bold;
}
</pre>
</p></dd>
</dl>
</div>
</div>
<div id="outline-container-7" class="outline-2">
<h2 id="sec-7">7 <span class="target">Supported Browsers</span> </h2>
<div id="text-7">
<p>
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?
</p>
<p>
So what browsers are supported then? Well - I don't know for
sure. JavaScript™ 1.4 plus <code>DOM</code> should make
</p><ul>
<li>
Netscape 6.0 and higher
</li>
<li>
Internet Explorer 5.0 and up
</li>
<li>
Firefox 1.0 ++ - 2.0.0.12 and 3.0 Beta tested
</li>
<li>
Opera 7.0 and higher - v.9.26 tested.
</li>
<li>
Safari 1.0
</li>
</ul>
<p>I have written and tested the script only in current Firefox, Opera and IE 6
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
once in my life I have to admit that Opera is the best here.
</p>
</div>
<div id="outline-container-7.1" class="outline-3">
<h3 id="sec-7.1">7.1 <span class="target">People reported it works in</span> </h3>
<div id="text-7.1">
<p>
So let's gather the tested Browsers here. Problems are only listed, if they
are Browser specific. Let me say it again: we don't wont to support legacy
browsers, do we?
</p>
<table border="0" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<col align="left"></col><col align="right"></col>
<thead>
<tr><th>Browser</th><th>Version</th></tr>
</thead>
<tbody>
<tr><td>Opera</td><td>9.26+</td></tr>
<tr><td>Firefox/Iceweasel</td><td>2.0.0.12</td></tr>
<tr><td>Firefox/Iceweasel</td><td>3.0.2 Beta</td></tr>
<tr><td>IE</td><td>5.5</td></tr>
<tr><td>IE</td><td>6</td></tr>
</tbody>
</table>
<p>
If you manage to get this thingy working in any browser please let us know, so
we can update the above table.
</p>
</div>
</div>
</div>
<div id="outline-container-8" class="outline-2">
<h2 id="sec-8">8 <span class="target">Why Do I Need a T.O.C?</span> </h2>
<div id="text-8">
<p>