Org version of texinfo manual

Org version of texinfo manual

[Aaron Ecay]

Hello orgers,

Last year, Thomas started a project to translate the org manual to org
format, and use the ox-texinfo exporter to generate the .info and .pdf
manuals.  (email thread: http://mid.gmane.org/m1bob8cffh.fsf@tsdye.com)
It seems like that project showed promise but never was completed.  Is
there any interest in seeing it through?  As an occasional contributor,
I would certainly find it pleasanter and less time-consuming to write
docs in org rather than texinfo.

Thanks,

--
Aaron Ecay

Re: Org version of texinfo manual

[Achim Gratz]

Aaron Ecay writes:
> Last year, Thomas started a project to translate the org manual to org
> format, and use the ox-texinfo exporter to generate the .info and .pdf
> manuals.  (email thread: http://mid.gmane.org/m1bob8cffh.fsf@tsdye.com)
> It seems like that project showed promise but never was completed.  Is
> there any interest in seeing it through?  As an occasional contributor,
> I would certainly find it pleasanter and less time-consuming to write
> docs in org rather than texinfo.

I'm still in favor of doing this, but it will be an uphill battle.  I'll
have to check what the state of my local branch is on this, let me get
back to you when it at least compiles the old version of the manual.


Regards,
Achim.
-- 
+<[Q+ Matrix-12 WAVE#46+305 Neuron microQkb Andromeda XTk Blofeld]>+

SD adaptations for KORG EX-800 and Poly-800MkII V0.9:
http://Synth.Stromeko.net/Downloads.html#KorgSDada

Re: Org version of texinfo manual

[Bastien]

Achim Gratz <Stromeko@nexgo.de> writes:

> I'm still in favor of doing this, but it will be an uphill battle.

Trying to get .texi manuals from .org files is a good way to improve
the Texinfo exporter, and the day we can export org.org to org.texi
with very little headache and ad hoc configuration, yes, we will make
the move.

But that's a project per se and I won't be able to dedicate time to
it: if you, Achim and Thomas manage to get something, I'll be more
than happy!

-- 
 Bastien

Re: Org version of texinfo manual

[Achim Gratz]

Achim Gratz writes:
> I'm still in favor of doing this, but it will be an uphill battle.  I'll
> have to check what the state of my local branch is on this, let me get
> back to you when it at least compiles the old version of the manual.

If you check out the orgmanual branch in Thomas' repository (and follow
the instructions on this list to integrate it into the Org build
system), then only these two patches are missing from my local version:

--8<---------------cut here---------------start------------->8---
    put back macros with "problematic characters"

	Modified   orgmanual.org
diff --git a/orgmanual.org b/orgmanual.org
index 0325614..ebe26ba 100644
--- a/orgmanual.org
+++ b/orgmanual.org
@@ -4254,13 +4254,10 @@ Priorities can be attached to any outline node; they do not need to be TODO
 items.
 
 #+attr_texinfo: :table-type table :indic @asis
-  - {{{kbd(C-c XXX)}}} ::
+  - {{{kbd(C-c \\,)}}} ::
 
-    {{{kindex(C-c ,)}}}
-    #+comment:    {{{kindex(@kbd{C-c ,})}}}
-    #+comment: Preceding line won't export to pdf
-    {{{findex(org-priority)}}}
-    #+comment: Should be C-c ,
+       {{{kindex(C-c \\,)}}}
+       {{{findex(org-priority)}}}
 
     Set the priority of the current headline (~org-priority~). The
     command prompts for a priority character {{{samp(A)}}}, {{{samp(B)}}}
@@ -9226,9 +9223,7 @@ the other commands, the cursor needs to be in the desired line.
 
 - ~\~ ~org-agenda-filter-by-tag-refine~ ::
 
-  #+comment: {{{kindex(XXX)}}}
-  #+comment: Should be \
-  @@info:kindex \\@@
+  {{{kindex(\)}}}
 
   Narrow the current agenda filter by an additional condition. When
   called with prefix arg, remove the entries that /do/ have the tag, or
@@ -9350,11 +9345,9 @@ the other commands, the cursor needs to be in the desired line.
   Set tags for the current headline. If there is an active region in the
   agenda, change a tag for all headings in the region.
 
-- {{{kbd(,)}}} ::
+- {{{kbd(\\,)}}} ::
 
-  #+comment: {{{kindex(XXX)}}}
-  #+comment: Should be a comma
-  @@info:kindex ,@@
+  {{{kindex(\\,)}}}
 
   Set the priority for the current item (~org-agenda-priority~). Org
   mode prompts for the priority character. If you reply with
@@ -10691,12 +10684,9 @@ If you would like to see entities displayed as UTF8 characters, use the
 following command:[fn:108]
 
 #+attr_texinfo: :table-type table :indic @asis
-- @@info:@kbd{C-c C-x XXX}@@ ::
-
-  #+comment: {{{kindex(C-c C-x XXX)}}}
-  #+comment: Should be \
+- {{{kbd(C-c C-x \)}}} ::
   
-  @@info:kindex C-c C-x \\
+  {{{kindex(C-c C-x \)}}}
 
   Toggle display of entities as UTF-8 characters. This does not change
   the buffer content which remains plain ASCII, but it overlays the
@@ -10740,9 +10730,7 @@ subscript, but ~a_{b}~ will.
 #+attr_texinfo: :table-type table :indic @asis
 - @@info:@kbd{C-c C-x \\}@@ ::
 
-  #+comment: {{{kindex(C-c C-x XXX)}}}
-  #+comment: Should be \
-  @@info:@kindex C-c C-x \@@
+  {{{kindex(C-c C-x \)}}}
 
   In addition to showing entities as UTF-8 characters, this command will
   also format sub- and superscripts in a WYSIWYM way.
--8<---------------cut here---------------end--------------->8---

--8<---------------cut here---------------start------------->8---
    Makefile: put HTML manual into subfolder

	Modified   Makefile
diff --git a/Makefile b/Makefile
index 7c45664..fec57d6 100644
--- a/Makefile
+++ b/Makefile
@@ -34,7 +34,7 @@ orgmanual.pdf:	LANG=C          # work around a bug in texi2dvi
 orgmanual.pdf:	orgmanual.texi
 	$(TEXI2PDF) $<
 orgmanual:	orgmanual.texi
-	$(TEXI2HTML) $<
+	$(TEXI2HTML) $< -o $@
 orgmanual.html: orgmanual.org
 	$(BEXP) $(EXHTML) $< $(ORG2HTML)
--8<---------------cut here---------------end--------------->8---
 
My addition to local.mk looks like this:

--8<---------------cut here---------------start------------->8---
.PHONY:	manclean orgmanual
EXTRADIRS=orgmanual
orgmanual:
	$(MAKE) -C $@
manclean:
	$(MAKE) -C orgmanual clean
clean:	manclean
--8<---------------cut here---------------end--------------->8---



Regards,
Achim.
-- 
+<[Q+ Matrix-12 WAVE#46+305 Neuron microQkb Andromeda XTk Blofeld]>+

Samples for the Waldorf Blofeld:
http://Synth.Stromeko.net/Downloads.html#BlofeldSamplesExtra