New compact Org-mode guide
This commit is contained in:
Carsten Dominik
parent
7d6013dc41
commit
c38d101fff
23
Makefile
23
Makefile
|
|
@ -45,6 +45,7 @@ MAKEINFO = makeinfo
|
|||
|
||||
# How to create the HTML file
|
||||
TEXI2HTML = makeinfo --html --number-sections
|
||||
TEXI2HTMLNOPSLIT = makeinfo --html --no-split --number-sections
|
||||
|
||||
# How to copy the lisp files and elc files to their distination.
|
||||
CP = cp -p
|
||||
|
|
@ -116,7 +117,8 @@ LISPFILES0 = $(LISPF:%=lisp/%)
|
|||
LISPFILES = $(LISPFILES0) lisp/org-install.el
|
||||
ELCFILES0 = $(LISPFILES0:.el=.elc)
|
||||
ELCFILES = $(LISPFILES:.el=.elc)
|
||||
DOCFILES = doc/org.texi doc/org.pdf doc/org doc/dir doc/.nosearch
|
||||
DOCFILES = doc/org.texi doc/org.pdf doc/org doc/dir doc/.nosearch \
|
||||
doc/orgguide.texi doc/orgguide.pdf
|
||||
CARDFILES = doc/orgcard.tex doc/orgcard.pdf doc/orgcard_letter.pdf
|
||||
TEXIFILES = doc/org.texi
|
||||
INFOFILES = doc/org
|
||||
|
|
@ -145,11 +147,14 @@ compile: $(ELCFILES0)
|
|||
|
||||
install: install-lisp
|
||||
|
||||
doc: doc/org.html doc/org.pdf doc/orgcard.pdf doc/orgcard_letter.pdf
|
||||
doc: doc/org.html doc/org.pdf doc/orgcard.pdf doc/orgcard_letter.pdf doc/orgguide.pdf
|
||||
|
||||
p:
|
||||
${MAKE} pdf && open doc/org.pdf
|
||||
|
||||
g:
|
||||
${MAKE} pdf && open doc/orgguide.pdf
|
||||
|
||||
install-lisp: $(LISPFILES) $(ELCFILES)
|
||||
if [ ! -d $(lispdir) ]; then $(MKDIR) $(lispdir); else true; fi ;
|
||||
$(CP) $(LISPFILES) $(lispdir)
|
||||
|
|
@ -186,6 +191,9 @@ doc/org: doc/org.texi
|
|||
doc/org.pdf: doc/org.texi
|
||||
(cd doc; $(TEXI2PDF) org.texi)
|
||||
|
||||
doc/orgguide.pdf: doc/orgguide.texi
|
||||
(cd doc; $(TEXI2PDF) orgguide.texi)
|
||||
|
||||
doc/org.html: doc/org.texi
|
||||
(cd doc; $(TEXI2HTML) --no-split -o org.html org.texi)
|
||||
UTILITIES/manfull.pl doc/org.html
|
||||
|
|
@ -213,9 +221,15 @@ html_manual: doc/org.texi
|
|||
$(TEXI2HTML) -o doc/manual doc/org.texi
|
||||
UTILITIES/mansplit.pl doc/manual/*.html
|
||||
|
||||
html_guide: doc/orgguide.texi
|
||||
rm -rf doc/guide
|
||||
mkdir doc/guide
|
||||
$(TEXI2HTML) -o doc/guide doc/orgguide.texi
|
||||
UTILITIES/guidesplit.pl doc/guide/*.html
|
||||
|
||||
info: doc/org
|
||||
|
||||
pdf: doc/org.pdf
|
||||
pdf: doc/org.pdf doc/orgguide.pdf
|
||||
|
||||
card: doc/orgcard.pdf doc/orgcard_letter.pdf
|
||||
|
||||
|
|
@ -246,10 +260,12 @@ release:
|
|||
${MAKE} doc
|
||||
UTILITIES/gplmanual.pl
|
||||
${MAKE} html_manual
|
||||
${MAKE} html_guide
|
||||
rm -rf RELEASEDIR
|
||||
$(MKDIR) RELEASEDIR
|
||||
cp org-$(TAG).zip org-$(TAG).tar.gz RELEASEDIR
|
||||
cp doc/org.pdf doc/orgcard.pdf doc/org.texi doc/org.html RELEASEDIR
|
||||
cp doc/orgguide.pdf RELEASEDIR
|
||||
cp RELEASEDIR/org-$(TAG).zip RELEASEDIR/org.zip
|
||||
cp RELEASEDIR/org-$(TAG).tar.gz RELEASEDIR/org.tar.gz
|
||||
|
||||
|
|
@ -258,6 +274,7 @@ upload_release:
|
|||
|
||||
upload_manual:
|
||||
rsync -avuz --delete doc/manual/ cdominik@orgmode.org:orgmode.org/manual/
|
||||
rsync -avuz --delete doc/guide/ cdominik@orgmode.org:orgmode.org/guide/
|
||||
|
||||
relup0:
|
||||
${MAKE} release
|
||||
|
|
|
|||
|
|
@ -168,11 +168,13 @@ and corresponding to the latest git version.
|
|||
|
||||
* Documentation
|
||||
** The Org manual
|
||||
- Read the [[file:manual/index.html][documentation online]].
|
||||
- Read the [[file:manual/index.html][manual online]].
|
||||
- You can also have the entire manual in a [[file:org.html][single monolithic file]].
|
||||
- Download the documentation as a [[file:org.pdf][PDF document]].
|
||||
- Download the manual as a [[file:org.pdf][PDF document]].
|
||||
- A [[http://hpcgi1.nifty.com/spen/index.cgi?OrgMode%2fManual][Japanese translation]] of the manual (version 4.60), by Takeshi
|
||||
Okano.
|
||||
- The Org-mode Guide is a compact version of the manual, with all
|
||||
basic information. Read the [[file:guide/index.html][guide online]] or as a [[file:orgguide.pdf][PDF document]]
|
||||
|
||||
** Reference card
|
||||
- Download the [[file:orgcard.pdf][Refcard]] for org-mode
|
||||
|
|
|
|||
|
|
@ -0,0 +1,62 @@
|
|||
#!/usr/bin/perl
|
||||
# Work on the files that are created by makeinfo for html output
|
||||
# split into many small files.
|
||||
|
||||
# This will walk though the files listed on the command line, install
|
||||
# Sebastian Rose's key reader and add a small top-level-only table
|
||||
# of contents that will be placed into a special region and visible
|
||||
# in all subfiles. The small contents is a constant and has to be updated
|
||||
# by hand, currently.
|
||||
|
||||
$contents = <<EOF;
|
||||
<div id="table-of-contents">
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a name="toc_Top" href="index.html#Top">Org Mode Compact Guide</a>
|
||||
<li><a name="toc_Introduction" href="Introduction.html#Introduction">1 Introduction</a>
|
||||
<li><a name="toc_Document-Structure" href="Document-Structure.html#Document-Structure">2 Document Structure</a>
|
||||
<li><a name="toc_Tables" href="Tables.html#Tables">3 Tables</a>
|
||||
<li><a name="toc_Hyperlinks" href="Hyperlinks.html#Hyperlinks">4 Hyperlinks</a>
|
||||
<li><a name="toc_TODO-Items" href="TODO-Items.html#TODO-Items">5 TODO Items</a>
|
||||
<li><a name="toc_Tags" href="Tags.html#Tags">6 Tags</a>
|
||||
<li><a name="toc_Properties" href="Properties.html#Properties">7 Properties</a>
|
||||
<li><a name="toc_Dates-and-Times" href="Dates-and-Times.html#Dates-and-Times">8 Dates and Times</a>
|
||||
<li><a name="toc_Capture" href="Capture-_002d-Refile-_002d-Archive.html#Capture-_002d-Refile-_002d-Archive">9 Capture-Refile-Archive</a>
|
||||
<li><a name="toc_Agenda-Views" href="Agenda-Views.html#Agenda-Views">10 Agenda Views</a>
|
||||
<li><a name="toc_Markup" href="Markup.html#Markup">11 Markup</a>
|
||||
<li><a name="toc_Exporting" href="Exporting.html#Exporting">12 Exporting</a>
|
||||
<li><a name="toc_Publishing" href="Publishing.html#Publishing">13 Publishing</a>
|
||||
<li><a name="toc_Miscellaneous" href="Miscellaneous.html#Miscellaneous">14 Miscellaneous</a>
|
||||
</li></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
EOF
|
||||
|
||||
$script = <<'EOF';
|
||||
</style><link rel="stylesheet" href="http://orgmode.org/org.css" type="text/css" />
|
||||
<script type="text/javascript" src="http://orgmode.org/org-keys.js"></script>
|
||||
<script type="text/javascript">
|
||||
<!--/*--><![CDATA[/*><!--*/
|
||||
OrgKeyReader.registerHref('h', 'index.html');
|
||||
OrgKeyReader.registerHref('t', 'index.html');
|
||||
/*]]>*/-->
|
||||
</script>
|
||||
EOF
|
||||
|
||||
while ($page = shift) {
|
||||
system "mv $page $page.orig";
|
||||
open IN,"<$page.orig" or die "Cannot read from $page.orig\n";
|
||||
undef $/;
|
||||
$all = <IN>;
|
||||
close IN;
|
||||
|
||||
$all =~ s/<meta http-equiv="Content-Style-Type" content="text\/css">/$&\n$script/;
|
||||
$all =~ s/^<body>/<body onload="OrgKeyReader.init();">\n$contents/m;
|
||||
|
||||
open OUT,">$page" or die "Cannot write to $page\n";
|
||||
print OUT $all;
|
||||
close OUT;
|
||||
system "rm $page.orig";
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue