emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: 8dcc <8dcc.git@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Underscores in "Function:" items
Date: Tue, 22 Oct 2024 15:09:14 +0200	[thread overview]
Message-ID: <87wmi09tdx.fsf@gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 1166 bytes --]

Hello,

When exporting the following Org file to Texinfo:

    - Function: foo_bar arg ::
      Contents.

The part after the underscore is completely skipped:

    @defun foo
    Contents.
    @end defun

And, if I export it to HTML, the `bar' part is shown as a subscript, and
I don't know if it's intended:

    <dt>Function: foo<sub>bar</sub> arg</dt>
    <dd>Contents.</dd>

Another small detail, which might not be important, is that when
exporting to HTML, the description of the function is only wrapped in
<p> tags if it has more than one paragraph. This kind of makes sense,
but results in inconsistent spacing when multiple functions are close:

    Here's a list of functions:
    - Function: foo arg ::
      This has multiple paragraphs.

      Another paragraph.
    - Function: bar arg ::
      Just one line.
    - Function: baz arg ::
      One line, again.
    Here's some text after the list.

This is not a huge issue, since the user can just add some CSS (which I
personally use in my blog):

    dl.org-dl dd p:nth-child(1) {
        margin-top: 0px;
    }

    dl.org-dl dd p:nth-last-child(1) {
        margin-bottom: 0px;
    }

Thank you.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 255 bytes --]

next             reply	other threads:[~2024-10-22 13:09 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-22 13:09 8dcc [this message]
2024-10-26  8:42 ` Underscores in "Function:" items Ihor Radchenko

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=87wmi09tdx.fsf@gmail.com \
    --to=8dcc.git@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /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 public 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).