From: Jonas Bernoulli <jonas@bernoul.li> To: Nicolas Goaziou <mail@nicolasgoaziou.fr> Cc: kyle@kyleam.com, emacs-orgmode@gnu.org Subject: Re: [PATCH 1/2] ox-texinfo: Turn a description list item with "+" bullet into @itemx Date: Mon, 27 Dec 2021 19:05:00 +0100 [thread overview] Message-ID: <87zgol7wkz.fsf@bernoul.li> (raw) In-Reply-To: <87wnjr9he9.fsf@nicolasgoaziou.fr> Nicolas Goaziou <mail@nicolasgoaziou.fr> writes: > Hello, > > Thanks. Some comments follow. Thanks for the review! > Jonas Bernoulli <jonas@bernoul.li> writes: > >> +In description lists the used bullet is significant when exporting to >> +Texinfo; when in doubt, then use =-=. An item that uses =+= instead >> +becomes a new entry in the first column of the table. The above >> +output can also be produced with: >> >> #+begin_example >> -#+ATTR_TEXINFO: :enum A >> -1. Alpha >> -2. Bravo >> -3. Charlie >> +,#+attr_texinfo: :table-type vtable :indic asis >> +- foo :: >> ++ bar :: >> + This is the common text for foo and bar. >> #+end_example > > The above is fragile, because pressing <C-c C-c> on an item will > "repair" the bullets. Therefore, you cannot support mixed bullets in the > same list. The alternative also isn't great (see below). I vaguely remember having run into this feature before when using Org to record a pros and cons list. As a maintainer I don't like this question but; could this feature be made optional? (Of course one could use tags to indicate whether an item is a pro or cons, but for such a simple use- case that seems more work than necessary and less immediately obvious.) >> *** Tables in Texinfo export >> diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el >> index b0125894a..35862357d 100644 >> --- a/lisp/ox-texinfo.el >> +++ b/lisp/ox-texinfo.el >> @@ -418,6 +418,11 @@ (defun org-texinfo--filter-section-blank-lines (headline _backend _info) >> "Filter controlling number of blank lines after a section." >> (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" "\n\n" headline)) >> >> +(defun org-texinfo--filter-parse-tree (tree backend info) >> + "Normalize headlines and items." >> + (org-texinfo--normalize-headlines tree backend info) >> + (org-texinfo--normalize-items tree info)) > > Could you expound the docstring? Arguments are missing, and "normalize" > is vague. This bothered me a bit too when writing it but at the same time it seemed like overkill to replicate the docstrings of the called functions. How do you feel about using a hook instead? (defvar org-texinfo--filter-parse-tree-functions '(org-texinfo--normalize-headlines org-texinfo--normalize-items) "List of functions the `texinfo' back-end applies to the parsed tree. Each filter is called with three arguments: the parse tree, as returned by `org-element-parse-buffer', the back-end, as a symbol, and the communication channel, as a plist. It must return the modified parse tree to transcode.") Do you prefer to add the hook functions as done above or should each one be added individually using add-hook? >> + (org-element-map tree 'plain-list >> + (lambda (plain-list) >> + (when (eq (org-element-property :type plain-list) 'descriptive) >> + (let ((contents (org-element-contents plain-list))) >> + (while (setq item (pop contents)) >> + (let ((next-item (car contents))) >> + (when (and next-item >> + (equal (org-element-property :bullet next-item) "+ ")) > > The above will fail if `org-list-two-spaces-after-bullet-regexp' is > non-nil. You should compare the trimmed bullet with "+". Done. Is this okay?: (when (and next-item (string-prefix-p "+" (org-element-property :bullet next-item))) Or should the line-breaks go elsewhere? > Anyhow, relying on mixed bullets is not great… The alternative isn't great either. For example: - Key: C-c C-w (forge-browse-TYPE) :: + Key: C-c C-w (forge-browse-dwim) :: + Key: N b I (forge-browse-issues) :: + Key: N b P (forge-browse-pullreqs) :: + Key: N b t (forge-browse-topic) :: + Key: N b i (forge-browse-issue) :: + Key: N b p (forge-browse-pullreq) :: These commands visit the topic, issue(s), pull-request(s), post, branch, commit, or remote at point in a browser. ... vs. - Key: C-c C-w (forge-browse-TYPE), C-c C-w (forge-browse-dwim), N b I (forge-browse-issues), N b P (forge-browse-pullreqs), N b t (forge-browse-topic), N b i (forge-browse-issue), N b p (forge-browse-pullreq) :: These commands visit the topic, issue(s), pull-request(s), post, branch, commit, or remote at point in a browser. ... I am sure I am gonna make mistakes when using the latter approach. Cheers, Jonas
next prev parent reply other threads:[~2021-12-27 18:08 UTC|newest] Thread overview: 47+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-11-09 18:01 Merging ox-texinfo+ into ox-texinfo Jonas Bernoulli 2021-11-19 12:46 ` Nicolas Goaziou 2021-11-20 21:06 ` Jonas Bernoulli 2021-11-21 12:41 ` Nicolas Goaziou 2021-11-30 16:58 ` Jonas Bernoulli 2021-12-18 21:40 ` [PATCH 0/2] ox-texinfo: Define definition commands using description lists Jonas Bernoulli 2021-12-18 21:40 ` [PATCH 1/2] ox-texinfo: Turn a description list item with "+" bullet into @itemx Jonas Bernoulli 2021-12-26 21:37 ` Nicolas Goaziou 2021-12-27 18:05 ` Jonas Bernoulli [this message] 2021-12-30 9:40 ` Nicolas Goaziou 2022-01-05 13:12 ` Jonas Bernoulli 2022-01-23 15:01 ` Jonas Bernoulli 2021-12-18 21:40 ` [PATCH 2/2] ox-texinfo: Define definition commands using description lists Jonas Bernoulli 2021-12-26 21:46 ` Nicolas Goaziou 2021-12-27 18:05 ` Jonas Bernoulli 2021-12-30 0:57 ` Nicolas Goaziou 2022-01-05 13:16 ` Jonas Bernoulli 2022-01-05 13:30 ` [PATCH v2 0/3] " Jonas Bernoulli 2022-01-05 13:30 ` [PATCH v2 1/3] ox-texinfo: Add function for use by kbd macro Jonas Bernoulli 2022-01-05 13:30 ` [PATCH v2 2/3] ox-texinfo: Optionally use @itemx for certain description list items Jonas Bernoulli 2022-01-05 13:30 ` [PATCH v2 3/3] ox-texinfo: Define definition commands using description lists Jonas Bernoulli 2022-01-14 23:01 ` [PATCH v2 0/3] " Jonas Bernoulli 2022-01-18 15:11 ` [PATCH v3 " Jonas Bernoulli 2022-01-18 15:11 ` [PATCH v3 1/3] ox-texinfo: Add function for use by kbd macro Jonas Bernoulli 2022-01-22 15:19 ` Nicolas Goaziou 2022-01-18 15:11 ` [PATCH v3 2/3] ox-texinfo: Optionally use @itemx for certain description list items Jonas Bernoulli 2022-01-22 15:33 ` Nicolas Goaziou 2022-01-23 1:26 ` Jonas Bernoulli 2022-01-23 20:43 ` Jonas Bernoulli 2022-01-18 15:11 ` [PATCH v3 3/3] ox-texinfo: Define definition commands using description lists Jonas Bernoulli 2022-01-23 0:02 ` Nicolas Goaziou 2022-01-23 1:14 ` Jonas Bernoulli 2022-01-23 14:45 ` Jonas Bernoulli 2022-01-23 20:27 ` [PATCH v4 0/3] " Jonas Bernoulli 2022-01-23 20:27 ` [PATCH v4 1/3] ox-texinfo: Add function for use by kbd macro Jonas Bernoulli 2022-01-23 20:27 ` [PATCH v4 2/3] ox-texinfo: Optionally use @itemx for certain description list items Jonas Bernoulli 2022-01-23 21:17 ` Jonas Bernoulli 2022-01-23 20:27 ` [PATCH v4 3/3] ox-texinfo: Define definition commands using description lists Jonas Bernoulli 2022-01-31 23:45 ` [PATCH v5 0/4] " Jonas Bernoulli 2022-01-31 23:45 ` [PATCH v5 1/4] ox-texinfo: Add function for use by kbd macro Jonas Bernoulli 2022-01-31 23:45 ` [PATCH v5 2/4] ox-texinfo: Optionally use @itemx for certain description list items Jonas Bernoulli 2022-01-31 23:45 ` [PATCH v5 3/4] ox-texinfo: Define definition commands using description lists Jonas Bernoulli 2022-01-31 23:45 ` [PATCH v5 4/4] ox-texinfo: Allow enabling compact syntax for @itemx per file Jonas Bernoulli 2022-02-08 23:46 ` [PATCH v5 0/4] ox-texinfo: Define definition commands using description lists Nicolas Goaziou 2022-02-11 20:01 ` Jonas Bernoulli 2022-02-15 21:01 ` [PATCH] etc/ORG-NEWS: Add news items about new features in texinfo exporter Jonas Bernoulli 2022-02-22 19:14 ` Nicolas Goaziou
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: https://www.orgmode.org/ * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=87zgol7wkz.fsf@bernoul.li \ --to=jonas@bernoul.li \ --cc=emacs-orgmode@gnu.org \ --cc=kyle@kyleam.com \ --cc=mail@nicolasgoaziou.fr \ --subject='Re: [PATCH 1/2] ox-texinfo: Turn a description list item with "+" bullet into @itemx' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://git.savannah.gnu.org/cgit/emacs/org-mode.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).