From mboxrd@z Thu Jan 1 00:00:00 1970 From: Achim Gratz Subject: Re: [RFC] Org version of the Org manual Date: Sun, 10 Mar 2013 13:24:22 +0100 Message-ID: <87txojo32h.fsf@Rainer.invalid> References: <87ehfuonx6.fsf@Rainer.invalid> <87zjyhotvi.fsf@yagnesh.org> <876213cbnu.fsf@Rainer.invalid> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([208.118.235.92]:42710) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UEfJ0-00085r-M0 for emacs-orgmode@gnu.org; Sun, 10 Mar 2013 08:24:51 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UEfIw-0002ZZ-TD for emacs-orgmode@gnu.org; Sun, 10 Mar 2013 08:24:46 -0400 Received: from plane.gmane.org ([80.91.229.3]:55126) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UEfIw-0002ZU-IX for emacs-orgmode@gnu.org; Sun, 10 Mar 2013 08:24:42 -0400 Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1UEfJF-0007D0-H2 for emacs-orgmode@gnu.org; Sun, 10 Mar 2013 13:25:01 +0100 Received: from pd9eb564b.dip.t-dialin.net ([217.235.86.75]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 10 Mar 2013 13:25:01 +0100 Received: from Stromeko by pd9eb564b.dip.t-dialin.net with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 10 Mar 2013 13:25:01 +0100 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: emacs-orgmode@gnu.org --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit 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))… This may actually a bug in the texinfo exporter. > 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 --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-add-Makefile-org-version.inc-symbolic-link-modify-.g.patch Content-Description: orgmanual.patch >From 5511736802ced4e08bd432ebdb12dfeebe282a22 Mon Sep 17 00:00:00 2001 From: Achim Gratz Date: Sun, 10 Mar 2013 12:07:19 +0100 Subject: [PATCH] add Makefile, org-version.inc (symbolic link), modify .gitignore ignore make products --- .gitignore | 7 ++++--- Makefile | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ org-version.inc | 1 + 3 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 Makefile create mode 120000 org-version.inc diff --git a/.gitignore b/.gitignore index 1f940d9..fde636e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,8 @@ *.*~ *.texi *.info -Makefile init.el export-test.org -org-version.inc *.aux *.cp *.fn @@ -17,4 +15,7 @@ org-version.inc *.vr *.cps *.pgs -.DS_Store \ No newline at end of file +.DS_Store +/orgmanual.html +/orgmanual.t2d/ +/orgmanual/ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..7c45664 --- /dev/null +++ b/Makefile @@ -0,0 +1,49 @@ +TEXI2PDF+=--tidy +BEXP=$(BATCH) \ + --eval '(add-to-list '"'"'load-path "../lisp")' \ + --eval '(setq org-footnote-auto-adjust nil)' +EXTEXI= -l ox-texinfo \ + --eval '(add-to-list '"'"'org-export-snippet-translation-alist '"'"'("info" . "texinfo"))' +EXHTML= -l ox-html \ + $(BTEST_POST) \ + --eval '(add-to-list '"'"'org-export-snippet-translation-alist '"'"'("info" . "texinfo"))' +ORG2TEXI=-f org-texinfo-export-to-texinfo +ORG2HTML=-f org-html-export-to-html +ORG2INFO=--eval "(org-texinfo-compile \"./$<\")" + +.SUFFIXES: # we don't need default suffix rules +ifeq ($(MAKELEVEL), 0) + $(error This make needs to be started as a sub-make from the toplevel directory.) +endif +.PHONY: all info html pdf + +all: $(ORG_MAKE_DOC) + +info: orgmanual.info + +html: orgmanual orgmanual.html + +pdf: orgmanual.pdf + +orgmanual.texi: orgmanual.org + $(BEXP) $(EXTEXI) $< $(ORG2TEXI) +orgmanual.info: orgmanual.texi + $(MAKEINFO) --no-split $< -o $@ +orgmanual.pdf: LC_ALL=C # work around a bug in texi2dvi +orgmanual.pdf: LANG=C # work around a bug in texi2dvi +orgmanual.pdf: orgmanual.texi + $(TEXI2PDF) $< +orgmanual: orgmanual.texi + $(TEXI2HTML) $< +orgmanual.html: orgmanual.org + $(BEXP) $(EXHTML) $< $(ORG2HTML) + +clean: + $(RM) org *.pdf *.html \ + *.aux *.cp *.cps *.dvi *.fn *.fns *.ky *.kys *.pg *.pgs \ + *.toc *.tp *.tps *.vr *.vrs *.log *.html *.ps +cleanall: clean + $(RMR) orgmanual.t2d orgmanual + + + diff --git a/org-version.inc b/org-version.inc new file mode 120000 index 0000000..fd0c05b --- /dev/null +++ b/org-version.inc @@ -0,0 +1 @@ +../doc/org-version.inc \ No newline at end of file -- 1.8.1.4 --=-=-= Content-Type: text/plain cd .. git commit -am 'update submodule orgmanual' git am org.patch --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-add-EXTRADIRS-to-targets.mk-for-build-system-integra.patch Content-Description: org.patch >From 488e1aa75d9420a238851217c39f52ecf317e8a0 Mon Sep 17 00:00:00 2001 From: Achim Gratz Date: Sun, 10 Mar 2013 12:11:29 +0100 Subject: [PATCH] add $(EXTRADIRS) to targets.mk for build system integration of orgmanual/ --- mk/targets.mk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mk/targets.mk b/mk/targets.mk index aef11eb..b7fe9cc 100644 --- a/mk/targets.mk +++ b/mk/targets.mk @@ -6,7 +6,7 @@ DISTFILES_extra= Makefile request-assign-future.txt contrib etc LISPDIRS = lisp OTHERDIRS = doc etc CLEANDIRS = contrib testing mk -SUBDIRS = $(OTHERDIRS) $(LISPDIRS) +SUBDIRS = $(OTHERDIRS) $(LISPDIRS) $(EXTRADIRS) INSTSUB = $(SUBDIRS:%=install-%) ORG_MAKE_DOC ?= info html pdf -- 1.8.1.4 --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit 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=orgmanual 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… 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 --=-=-=--