Re: [PATCH] Improve formatting and documentation inline source block [9.3 (release_9.3 @ /usr/local/share/emacs/28.0.50/lisp/org/)]
Ihor Radchenko writes: > * doc/org-manual.org (Exporting Code Blocks): Clarify that results are > exported by default for inline source blocks. Applied onto main via 2d5274108. Best, Ihor
[PATCH] Improve formatting and documentation inline source block [9.3 (release_9.3 @ /usr/local/share/emacs/28.0.50/lisp/org/)]
dalanicolai writes: > This bug report contains two requests/bugs about inline source blocks > namely: > > 1. Inline source blocks don't get formatted/propertized within > org buffers. There is now patch under review to fix this: https://list.orgmode.org/87h7dy7f68.fsf@localhost/T/#t > 2. Different from ordinary source blocks, the inline source blocks > require the [:exports code] argument to get exported. I think it would > be useful to mention it explicitly in [section 15.2 of the > documentation](https://orgmode.org/manual/Structure-of-Code-Blocks.html), > because it is somewhat unexpected behavior (compared to ordinary source > blocks). I agree that current manual is confusing. The attached patch. Dear all, Maybe we also want to mention org-babel-default-inline-header-args in the manual? In addition to org-babel-default-header-args. Best, Ihor >From 4f04548dc94549b9e50f6598636632e67715d9b8 Mon Sep 17 00:00:00 2001 Message-Id: <4f04548dc94549b9e50f6598636632e67715d9b8.1633245750.git.yanta...@gmail.com> From: Ihor Radchenko Date: Sun, 3 Oct 2021 15:20:18 +0800 Subject: [PATCH] orgmanual-org: Mention results export as default for inline src blocks * doc/org-manual.org (Exporting Code Blocks): Clarify that results are exported by default for inline source blocks. The issue has been reported in https://orgmode.org/list/CACJP=3n_8tqzbz7ghmd+f44npptlby31htxhxrhselxtemo...@mail.gmail.com --- doc/org-manual.org | 9 + 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index b25da7889..6403b5e69 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -18002,10 +18002,11 @@ ** Exporting Code Blocks It is possible to export the /code/ of code blocks, the /results/ of code block evaluation, /both/ the code and the results of code block evaluation, or /none/. Org defaults to exporting /code/ for most -languages. For some languages, such as ditaa, Org defaults to -/results/. To export just the body of code blocks, see [[*Literal -Examples]]. To selectively export sub-trees of an Org document, see -[[*Exporting]]. +languages and /results/ for inline code blocks. For some languages, +such as ditaa, Org defaults to /results/ both in ordinary source +blocks and in inline source blocks. To export just the body of code +blocks, see [[*Literal Examples]]. To selectively export sub-trees of an +Org document, see [[*Exporting]]. #+cindex: @samp{exports}, header argument The =exports= header argument is to specify if that part of the Org -- 2.32.0
Improve formatting and documentation inline source block [9.3 (release_9.3 @ /usr/local/share/emacs/28.0.50/lisp/org/)]
Sorry, sending this from the browser because none of Emacs sending options currently work From: dalanicolai To: emacs-orgmode@gnu.org Subject: Bug: Improve formatting and documentation inline source block [9.3 (release_9.3 @ /usr/local/share/emacs/28.0.50/lisp/org/)] Date: Thu, 18 Feb 2021 18:13:07 +0100 Message-ID: <87o8ghwb8c.fsf@daniel-fedora.i-did-not-set--mail-host-address--so-tickle-me > --text follows this line-- This bug report contains two requests/bugs about inline source blocks namely: 1. Inline source blocks don't get formatted/propertized within org buffers. 2. Different from ordinary source blocks, the inline source blocks require the [:exports code] argument to get exported. I think it would be useful to mention it explicitly in [section 15.2 of the documentation](https://orgmode.org/manual/Structure-of-Code-Blocks.html), because it is somewhat unexpected behavior (compared to ordinary source blocks). To test it just open an org buffer and enter e.g. the following line `test src_emacs-lisp{(server-start)} test` then run `M-x org-html-export-as-html`. Compare output to that of `test src_emacs-lisp[:exports code]{(server-start)} test` Emacs : GNU Emacs 28.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.25, cairo version 1.16.0) of 2021-02-18 Package: Org mode version 9.3 (release_9.3 @ /usr/local/share/emacs/28.0.50/lisp/org/) current state: == (setq org-src-mode-hook '(org-src-babel-configure-edit-buffer org-src-mode-configure-edit-buffer) org-link-shell-confirm-function 'yes-or-no-p org-metadown-hook '(org-babel-pop-to-session-maybe) org-clock-out-hook '(org-clock-remove-empty-clock-drawer) outline-isearch-open-invisible-function #[128 "\300\301!\207" [org-show-context isearch] 3 "\n\n(fn _)"] org-mode-hook '(#[0 "\300\301\302\303\304$\207" [add-hook change-major-mode-hook org-show-all append local] 5] #[0 "\300\301\302\303\304$\207" [add-hook change-major-mode-hook org-babel-show-result-all append local] 5] org-babel-result-hide-spec org-babel-hide-all-hashes) org-archive-hook '(org-attach-archive-delete-maybe) org-confirm-elisp-link-function 'yes-or-no-p org-agenda-before-write-hook '(org-agenda-add-entry-text) org-metaup-hook '(org-babel-load-in-session-maybe) org-bibtex-headline-format-function #[257 "\300\236A\207" [:title] 3 "\n\n(fn ENTRY)"] org-babel-pre-tangle-hook '(save-buffer) org-tab-first-hook '(org-babel-hide-result-toggle-maybe org-babel-header-arg-expand) org-occur-hook '(org-first-headline-recenter) org-cycle-hook '(org-cycle-hide-archived-subtrees org-cycle-show-empty-lines org-optimize-window-after-visibility-change) org-speed-command-hook '(org-speed-command-activate org-babel-speed-command-activate) org-confirm-shell-link-function 'yes-or-no-p org-link-parameters '(("attachment" :follow org-attach-open-link :export org-attach-export-link :complete org-attach-complete-link) ("id" :follow org-id-open) ("eww" :follow eww :store org-eww-store-link) ("rmail" :follow org-rmail-open :store org-rmail-store-link) ("mhe" :follow org-mhe-open :store org-mhe-store-link) ("irc" :follow org-irc-visit :store org-irc-store-link :export org-irc-export) ("info" :follow org-info-open :export org-info-export :store org-info-store-link) ("gnus" :follow org-gnus-open :store org-gnus-store-link) ("docview" :follow org-docview-open :export org-docview-export :store org-docview-store-link) ("bibtex" :follow org-bibtex-open :store org-bibtex-store-link) ("bbdb" :follow org-bbdb-open :export org-bbdb-export :complete org-bbdb-complete-link :store org-bbdb-store-link) ("w3m" :store org-w3m-store-link) ("file+sys") ("file+emacs") ("shell" :follow org-link--open-shell) ("news" :follow #[257 "\301\300\302Q!\207" ["news" browse-url ":"] 5 "\n\n(fn URL)"]) ("mailto" :follow #[257 "\301\300\302Q!\207" ["mailto" browse-url ":"] 5 "\n\n(fn URL)"]) ("https" :follow #[257 "\301\300\302Q!\207" ["https" browse-url ":"] 5 "\n\n(fn URL)"]) ("http" :follow #[257 "\301\300\302Q!\207" ["http" browse-url ":"] 5 "\n\n(fn URL)"]) ("ftp" :follow #[257 "\301\300\302Q!\207" ["ftp" browse-url ":"] 5 "\n\n(fn URL)"]) ("help" :follow org-link--open-help) ("file" :complete org-link-complete-file) ("elisp" :follow org-link--open-elisp) ("doi" :follow org-link--open-doi)) org-link-elisp-confirm-function 'yes-or-no-p )