From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jonathan Leech-Pepin Subject: Re: [RFC] Org version of the Org manual Date: Sun, 10 Mar 2013 15:01:22 -0400 Message-ID: References: <87ehfuonx6.fsf@Rainer.invalid> <87zjyhotvi.fsf@yagnesh.org> <876213cbnu.fsf@Rainer.invalid> <87txojo32h.fsf@Rainer.invalid> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=047d7b6d7dfeb654bc04d796ae7f Return-path: Received: from eggs.gnu.org ([208.118.235.92]:37634) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UElUs-0005qP-2S for emacs-orgmode@gnu.org; Sun, 10 Mar 2013 15:01:28 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UElUp-0002cv-VU for emacs-orgmode@gnu.org; Sun, 10 Mar 2013 15:01:26 -0400 Received: from mail-ve0-f182.google.com ([209.85.128.182]:43652) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UElUp-0002cm-QD for emacs-orgmode@gnu.org; Sun, 10 Mar 2013 15:01:23 -0400 Received: by mail-ve0-f182.google.com with SMTP id ox1so2254895veb.13 for ; Sun, 10 Mar 2013 12:01:23 -0700 (PDT) In-Reply-To: <87txojo32h.fsf@Rainer.invalid> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Achim Gratz Cc: Nicolas Goaziou , emacs-orgmode@gnu.org --047d7b6d7dfeb654bc04d796ae7f Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Hello Achim, On 10 March 2013 08:24, Achim Gratz wrote: > Thomas S. Dye writes: > > That works nicely. I found the error and orgmanual.pdf is now produced > > without errors. > > Progress! :-) > > With the current version from git I cannot export to texinfo > successfully, though, I get this error near the end of the export: > > Debugger entered--Lisp error: (wrong-type-argument stringp nil) > string-match("\\`[ \n.]+" nil) (if (string-match "\\`[ \n.]+" s) > (setq s (replace-match "" t t s))) org-trim(nil) (concat "\n@item " > (if tag desc) "\n" (org-trim contents) "\n") (let* ((tag > (org-element-property :tag item)) (desc (org-export-data tag info))) > (concat "\n@item " (if tag desc) "\n" (org-trim contents) "\n")) > org-texinfo-item((item (:bullet "- " :begin 41929 :end 42016 > :contents-begin 42016 :contents-end 42016 :checkbox nil :counter nil > :hiddenp outline :structure ((40825 2 "- " nil nil "@@info:@kbd{@@C-c > /@@info:}@@, ~org-sparse-tree~" 41031) (41031 2 "- " nil nil > "@@info:@kbd{@@C-c / r@@info:}@@, ~org-occur~" 41929) (41929 2 "- " > nil nil "@@info:@kbd{@@M-g n@@info:}@@ or @@info:@kbd{@@M-g > M-n@@info:}@@, ~next-error~" 42016))=E2=80=A6 > > This may actually a bug in the texinfo exporter. > > The error is actually on line 6069 of the manual. The {{{vindex[...]}}} line and subsequent paragraph. As far as the list is concerned there is no associated content for that list entry. Indenting them appropriately to be recognized as part of the list allows for successful export. This may also be partly a bug, should the exporter allow for a list item without any contents? Regards, Jon > > Is the html version of the Org manual generated from the .texi source? > > If so, could you show me how to augment Makefile so the html > > document is generated by `make orgmanual'? I want to check if the html > > document looks reasonable. > > I've extended the Makefile to approximate the one in doc/, HTML is > produced both via makeinfo and as an export via ox-html. To proceed in > an orderly manner and prepare for an eventual integration into Org, can > you please do the following in your Org clone: > > git checkout master > git checkout -b orgmanual master > git submodule add https://github.com/tsdye/orgmanual.git > git commit -am 'make orgmanual/ a submodule' > > cd orgmanual > git checkout -b orgmanual master > git am orgmanual.patch > > > > cd .. > git commit -am 'update submodule orgmanual' > git am org.patch > > > > If you are unsure about any of this, please ask. You can now edit/add > these lines > > --8<---------------cut here---------------start------------->8--- > .PHONY: orgmanual > EXTRADIRS=3Dorgmanual > orgmanual: > $(MAKE) -C $@ > --8<---------------cut here---------------end--------------->8--- > > to the top of your local.mk and should now be able to do a "make > orgmanual". Which types of documentation are produced can be controlled > with ORG_MAKE_DOC (default is "info pdf html"), just like for the > official manuals. Also, "make cleanall" will now clean up in orgmanual > also. BTEST_POST should be configured to have a load-path pointing to a > sufficiently advanced htmlize version for the HTML export. > > > My next step will be to bring orgmanual up-to-date with the changes > > that have been made to org.texi since I started the translation several > > months ago. > > I'm not envious=E2=80=A6 > > > Regards, > Achim. > -- > +<[Q+ Matrix-12 WAVE#46+305 Neuron microQkb Andromeda XTk Blofeld]>+ > > SD adaptations for Waldorf Q V3.00R3 and Q+ V3.54R2: > http://Synth.Stromeko.net/Downloads.html#WaldorfSDada > > --047d7b6d7dfeb654bc04d796ae7f Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Hello Achim,

On 10 March 2013 08:24, Achi= m Gratz <Stromeko@nexgo.de> wrote:
Thomas S. Dye writes:
> That works nicely. =C2=A0I found the error and orgmanual.pdf is now pr= oduced
> without errors.

Progress! :-)

With the current version from git I cannot export to texinfo
successfully, though, I get this error near the end of the export:

Debugger entered--Lisp error: (wrong-type-argument stringp nil)
=C2=A0 string-match("\\`[ \n.]+" nil) (if (string-match "\\`= [ \n.]+" s)
=C2=A0 (setq s (replace-match "" t t s))) org-trim(nil) (concat &= quot;\n@item "
=C2=A0 (if tag desc) "\n" (org-trim contents) "\n") (le= t* ((tag
=C2=A0 (org-element-property :tag item)) (desc (org-export-data tag info)))=
=C2=A0 (concat "\n@item " (if tag desc) "\n" (org-trim = contents) "\n"))
=C2=A0 org-texinfo-item((item (:bullet "- " :begin 41929 :end 420= 16
=C2=A0 :contents-begin 42016 :contents-end 42016 :checkbox nil :counter nil=
=C2=A0 :hiddenp outline :structure ((40825 2 "- " nil nil "@= @info:@kbd{@@C-c
=C2=A0 /@@info:}@@, ~org-sparse-tree~" 41031) (41031 2 "- " = nil nil
=C2=A0 "@@info:@kbd{@@C-c / r@@info:}@@, ~org-occur~" 41929) (419= 29 2 "- "
=C2=A0 nil nil "@@info:@kbd{@@M-g n@@info:}@@ or @@info:@kbd{@@M-g
=C2=A0 M-n@@info:}@@, ~next-error~" 42016))=E2=80=A6

This may actually a bug in the texinfo exporter.


The error is actually on = line 6069 of the manual.=C2=A0 The {{{vindex[...]}}} line and
subsequent= paragraph.=C2=A0 As far as the list is concerned there is no associatedcontent for that list entry.=C2=A0 Indenting them appropriately to be reco= gnized as part
of the list allows for successful export.

This may also be partly a = bug, should the exporter allow for a list item
without any contents?
=
Regards,

Jon
> Is the html version of the Org manual generated from the .texi source?=
> If so, could you show me how to augment Makefile so the html
> document is generated by `make orgmanual'? =C2=A0I want to check i= f the html
> document looks reasonable.

I've extended the Makefile to approximate the one in doc/, HTML i= s
produced both via makeinfo and as an export via ox-html. =C2=A0To proceed i= n
an orderly manner and prepare for an eventual integration into Org, can
you please do the following in your Org clone:

git checkout master
git checkout -b orgmanual master
git submodule add https://github.com/tsdye/orgmanual.git
git commit -am 'make orgmanual/ a submodule'

cd orgmanual
git checkout -b orgmanual master
git am orgmanual.patch



cd ..
git commit -am 'update submodule orgmanual'
git am org.patch



If you are unsure about any of this, please ask. =C2=A0You can now edit/add=
these lines

--8<---------------cut here---------------start------------->8---
.PHONY: orgmanual
EXTRADIRS=3Dorgmanual
orgmanual:
=C2=A0 =C2=A0 =C2=A0 =C2=A0 $(MAKE) -C $@
--8<---------------cut here---------------end--------------->8---

to the top of your local.mk and should now be able to do a "make
orgmanual". =C2=A0Which types of documentation are produced can be con= trolled
with ORG_MAKE_DOC (default is "info pdf html"), just like for the=
official manuals. =C2=A0Also, "make cleanall" will now clean up i= n orgmanual
also. =C2=A0BTEST_POST should be configured to have a load-path pointing to= a
sufficiently advanced htmlize version for the HTML export.

> My next step will be to bring orgmanual up-to-date with the changes > that have been made to org.texi since I started the translation severa= l
> months ago.

I'm not envious=E2=80=A6


Regards,
Achim.
--
+<[Q+ Matrix-12 WAVE#46+305 Neuron microQkb Andromeda XTk Blofeld]>+<= br>
SD adaptations for Waldorf Q V3.00R3 and Q+ V3.54R2:
http://Synth.Stromeko.net/Downloads.html#WaldorfSDada


--047d7b6d7dfeb654bc04d796ae7f--