emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Max Nikulin <manikulin@gmail.com>
To: Perry Smith <pedz@easesoftware.com>, emacs-orgmode@gnu.org
Subject: Re: Org mode "style sheet" for software documentation
Date: Fri, 9 Sep 2022 22:00:16 +0700	[thread overview]
Message-ID: <1926d9ab-2862-5fff-7a46-2b863ca574b8@gmail.com> (raw)
In-Reply-To: <1EFEFC5A-24EE-43FC-9C4A-14F02CB8B0FD@easesoftware.com>

On 08/09/2022 23:20, Perry Smith wrote:

> I’d like to be able to separate out things like file 
> paths, code samples (both in line and block), keywords, environment 
> variables, code variables, etc.
...
> It would also help me to be more 
> consistent while I write because I’m (currently) having to remember “Ok… 
> how did I format variables?  Was that ‘code' or ‘italics'? … Hmm…”

Depending on export backend and desired output quality you may use
info "(org) Macro Replacement" 
https://orgmode.org/manual/Macro-Replacement.html or you may define 
custom link type with :export property and type e.g. 
[[style:file-path][/dev/null]]. The latter is a kind of hack, but it 
might be more convenient in some cases.

E.g. macros are used in the doc/org-manual.org file
      {{{kbd(M-x list-packages)}}}
see doc/doc-setup.org for its definition.


      parent reply	other threads:[~2022-09-09 15:01 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-08 16:20 Org mode "style sheet" for software documentation Perry Smith
2022-09-08 20:38 ` Perry Smith
2022-09-09  5:09   ` Ihor Radchenko
2022-09-09 12:42     ` Perry Smith
2022-09-10  4:44       ` Ihor Radchenko
2022-09-09 15:00 ` Max Nikulin [this message]

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=1926d9ab-2862-5fff-7a46-2b863ca574b8@gmail.com \
    --to=manikulin@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=pedz@easesoftware.com \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).