`org-emphasize' missing in the manual

`org-emphasize' missing in the manual

[Arash Esbati]

Hi all,

I wonder why the function `org-emphasize' is missing in the manual.  I'm
not an versed Org user, but it seems that this command is the entry
point for users to mark up text.  So I suggest to add it to

  12.2 Emphasis and Monospace[1],[2]

incl. the keybinding "C-c C-x C-f".

Best, Arash

Footnotes:
[1]  https://orgmode.org/manual/Emphasis-and-Monospace.html
[2]  https://git.savannah.gnu.org/cgit/emacs/org-mode.git/tree/doc/org-manual.org#n11222

Re: `org-emphasize' missing in the manual

[Ihor Radchenko]

Arash Esbati <arash@gnu.org> writes:

> I wonder why the function `org-emphasize' is missing in the manual.  I'm
> not an versed Org user, but it seems that this command is the entry
> point for users to mark up text.  So I suggest to add it to
>
>   12.2 Emphasis and Monospace[1],[2]
>
> incl. the keybinding "C-c C-x C-f".

Makes sense.
Would you be interested to submit a patch?
You will need to modify doc/org-manual.org file in Org repository.
See https://orgmode.org/worg/org-contribute.html

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: `org-emphasize' missing in the manual

[Arash Esbati]

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

Ihor Radchenko <yantar92@posteo.net> writes:

> Makes sense.
> Would you be interested to submit a patch?
> You will need to modify doc/org-manual.org file in Org repository.
> See https://orgmode.org/worg/org-contribute.html

Thanks for your response.  I'm not really familiar with Org development,
but I hope the attached change fits the bill.  Please feel free to
adjust when necessary.

Best, Arash

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-org-manual.org-Document-org-emphasize.patch --]
[-- Type: text/x-patch, Size: 1434 bytes --]

From 91704900ff6b0a299b9cba71124b984366489dac Mon Sep 17 00:00:00 2001
From: Arash Esbati <arash@gnu.org>
Date: Tue, 23 Apr 2024 07:36:18 +0200
Subject: [PATCH] doc/org-manual.org: Document `org-emphasize'

* doc/org-manual.org (Emphasis and Monospace): Document the
command `org-emphasize'.

Link: https://lists.gnu.org/archive/html/emacs-orgmode/2024-04/msg00381.html
---
 doc/org-manual.org | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index ca1c9b482..aa18f7514 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -11233,7 +11233,17 @@ but not any simpler
 You can make words =*bold*=, =/italic/=, =_underlined_=, ==verbatim==
 and =~code~=, and, if you must, =+strike-through+=.  Text in the code
 and verbatim string is not processed for Org specific syntax; it is
-exported verbatim.
+exported verbatim.  Org provides a single command as entry point for
+inserting the marker character.
+
+- {{{kbd(C-c C-x C-f)}}} (~org-emphasize~) ::
+
+  #+kindex: C-c C-x C-f
+  #+findex: org-emphasize
+  Prompt for a marker character and insert or change an emphasis.  If
+  there is an active region, change that region to a new emphasis.  If
+  there is no region, just insert the marker characters and position
+  the cursor between them.
 
 #+vindex: org-fontify-emphasized-text
 To turn off fontification for marked up text, you can set
-- 
2.44.0

Re: `org-emphasize' missing in the manual

[Ihor Radchenko]

Arash Esbati <arash@gnu.org> writes:

> Thanks for your response.  I'm not really familiar with Org development,
> but I hope the attached change fits the bill.  Please feel free to
> adjust when necessary.

Thanks!
Applied, onto main.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=ff9d00c9c

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: `org-emphasize' missing in the manual

[Arash Esbati]

Ihor Radchenko <yantar92@posteo.net> writes:

> Thanks!
> Applied, onto main.
> https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=ff9d00c9c

Thanks for considering this.

Best, Arash