emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ryan Tate <ryantate@ryantate.com>
To: emacs-orgmode@gnu.org
Subject: Headlines require both space and star
Date: Wed, 06 May 2020 18:17:26 -0400	[thread overview]
Message-ID: <87ftcc3dzd.fsf@disp2634> (raw)

Hello, I am writing to suggest that the documents reflect that 
both a star and space are required to create a headline, not just 
a star.

Today I learned org mode through the manual, compact guide, "Org 
mode beginning at the basics" at orgmode.org and David O'Toole 
tutorial at orgmode.org.

I spent about 15 minutes trying to figure out why folding wasn't 
"working" in the very first org doc I then created.

It turns out I was not including a space after the star in my 
headlines. My doc looked like this:

*Intro
**First Part
**Second Part
***Sub part
**Third Part

etc.

When I did add spaces after the stars, suddenly the headlines were 
recognized (color changes) and folding worked as described in the 
manual at last. (I am on GNU Emacs 26.3 (build 1, 
x86_64-redhat-linux-gnu, GTK+ Version 3.24.11) of 2019-12-10)

I went to see if I missed something when I read the docs. Here are 
various ways headlines are described, none seem to mention the 
space after the star being required:

Manual, compact guide: " The headlines in Org start with one or 
more stars, on the left margin3. For example..." 
https://orgmode.org/manual/Headlines.html#Headlines
https://orgmode.org/guide/Headlines.html#Headlines

Org mode beginning at the basics: "This is a headline, it starts 
with one or more stars.  A heading has one star, a sub-heading 
two, etc."
https://orgmode.org/worg/org-tutorials/org4beginners.html

David O'Toole Org Tutorial: "First-level headlines begin with one 
star; second-level headlines begin with two stars, and so on. "
https://orgmode.org/worg/org-tutorials/orgtutorial_dto.html

I am presuming that the requirement of a space after a star has 
been omitted from the docs and is not an implementation error. If 
the latter I could probably put together a bug report for the code 
itself. If the former, I would simply suggest that the docs be 
amended to fully describe the actual requirements of headlines so 
others who do read the friendly manual as I did do not waste their 
own 15 minutes :-) If people are open to this, and a more proper 
patch is required, I would be happy to submit one in a more 
elaborate and correct format.

If this has been brought up before, or I am misunderstanding, I 
apologize in advance; the gmane gateway seems to be down so I 
cannot search the archives at the moment.

Cheers and thanks for org mode.

       Ryan


             reply	other threads:[~2020-05-16 15:23 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-06 22:17 Ryan Tate [this message]
2020-05-16 17:38 ` Nicolas Goaziou
2020-05-22 14:29 ` Bastien

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=87ftcc3dzd.fsf@disp2634 \
    --to=ryantate@ryantate.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
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).