From: Bastien Guerry <bzg@gnu.org>
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: Achim Gratz <Stromeko@nexgo.de>, Org Mode List <emacs-orgmode@gnu.org>
Subject: Re: [RFC] Moving "manual.org" into core
Date: Mon, 22 Jan 2018 11:51:49 +0100 [thread overview]
Message-ID: <87tvveqi7u.fsf@bzg.fr> (raw)
In-Reply-To: <87bmhooaj9.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Sat, 20 Jan 2018 15:43:54 +0100")
Hi Nicolas,
> "manual.org" was updated a month ago, and, so far, nobody complained
> about it. So, I think it's a good time to discuss about what could be
> done next.
Having the manual in .org is a great achievement, congrats to anyone
who worked on this titanic task!
I'm all for editing manual.org instead of org.texi in the long run.
Before moving manual.org into doc/, I'd suggest we agree on editing
variables like `fill-column' and the like:
fill-column: 70
org-list-description-max-indent: 5
org-edit-src-content-indentation: ?
org-src-preserve-indentation: ?
This is necessary so that contributors don't mess up accidentally with
the desired format.
Can we grow a list here:
https://bimestriel.framapad.org/p/22KTn231su
Also, why are :PROPERTIES: drawers at the beginning of the line? I
have them aligned with the headline in my configuration, which I find
much more readable. Can we fix this?
IMO the above questions should be resolved before exposing manual.org
to collaboration.
Some other micro-reports/requests, not blocking anything:
- Line 1013: Why an orphan dash? Because of #+vindex entries?
- Line 1077: Why indenting this list ?
- It would be nice to have #+[kvc]index with multiple entries per line.
- Line 1303 : Why "- =[fn:NAME]= ::" lives on a single line here?
- Line 21228 ("possible, including the version"): a macro spanning
over multiple lines is not fontified.
- Footnotes: it would be nice to get an overview of a footnote when
the pointer is hovering on some [fn:x] reference.
> The first obvious step is to move the file into "doc/" directory. Then
> I assume we could delete "org.texi" and "org.info" there and generate
> new ones from the Org file. For example, the following command, called
> from the "manual.org" file,
>
> (let ((org-texinfo-logfiles-extensions
> (cons "texi" org-texinfo-logfiles-extensions)))
> (org-texinfo-export-to-info))
>
> produces an "org.info" file without an "org.texi". It thus prevents
> direct editing of "org.texi". I assume this could be called by "make
> info" target.
We still need to create org.texi for inclusion into Emacs repository.
> So basically, the idea would be to not provide anymore an "org.texi"
> file. Only "manual.org" and "org.info". Emacs developers already apply
> fixes to ORG-NEWS, which is a plain Org file, so I guess it would not
> make their life harder if "manual.org" replaces "org.texi".
>
> WDYT?
I think it's a great step forward but a big one, so let's move
carefully here.
Thanks!
--
Bastien
next prev parent reply other threads:[~2018-01-22 10:51 UTC|newest]
Thread overview: 77+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-01-20 14:43 [RFC] Moving "manual.org" into core Nicolas Goaziou
2018-01-20 17:41 ` Achim Gratz
2018-01-20 18:15 ` Nicolas Goaziou
2018-01-20 18:36 ` Achim Gratz
2018-01-20 18:51 ` Nicolas Goaziou
2018-01-20 17:41 ` Thomas S. Dye
2018-01-22 10:51 ` Bastien Guerry [this message]
2018-01-22 13:48 ` Nicolas Goaziou
2018-01-22 15:30 ` Kaushal Modi
2018-01-22 16:02 ` Nicolas Goaziou
2018-01-22 17:00 ` Kaushal Modi
2018-01-22 17:20 ` Nicolas Goaziou
2018-01-22 17:31 ` Kaushal Modi
2018-01-22 19:52 ` Nicolas Goaziou
2018-01-23 15:19 ` Kaushal Modi
2018-01-23 16:30 ` Julius Dittmar
2018-01-23 16:33 ` Nicolas Goaziou
2018-01-23 16:37 ` Kaushal Modi
2018-01-22 16:35 ` Bastien Guerry
2018-01-22 16:53 ` Kaushal Modi
2018-01-22 16:35 ` Bastien Guerry
2018-01-22 16:31 ` Bastien Guerry
2018-01-22 17:03 ` Nicolas Goaziou
2018-01-23 8:07 ` org-adapt-indentation 'content (was Re: [RFC] Moving "manual.org" into core) Christian Moe
2018-03-06 19:01 ` Bastien Guerry
2018-01-22 19:04 ` [RFC] Moving "manual.org" into core Achim Gratz
2018-03-03 9:17 ` Nicolas Goaziou
2018-03-03 10:18 ` Bastien Guerry
2018-03-03 11:29 ` Nicolas Goaziou
2018-03-03 15:57 ` Bastien Guerry
2018-03-03 16:15 ` Joseph Vidal-Rosset
2018-03-03 19:48 ` Glenn Morris
2018-03-04 9:30 ` Bastien Guerry
2018-01-23 20:06 ` Thomas S. Dye
2018-01-22 13:54 ` Rasmus
2018-01-22 15:23 ` Kaushal Modi
2018-01-24 8:39 ` Yasushi SHOJI
2018-01-24 11:28 ` Nicolas Goaziou
2018-01-26 8:52 ` Yasushi SHOJI
2018-01-26 10:32 ` Nicolas Goaziou
2018-01-27 8:40 ` Yasushi SHOJI
2018-01-28 15:17 ` Nicolas Goaziou
2018-01-29 2:40 ` Yasushi SHOJI
2018-01-29 14:41 ` Nicolas Goaziou
2018-02-01 11:43 ` Yasushi SHOJI
2018-02-01 12:11 ` Yasushi SHOJI
2018-02-04 9:05 ` Nicolas Goaziou
2018-02-01 14:55 ` Nicolas Goaziou
2018-02-02 2:07 ` Yasushi SHOJI
2018-02-04 9:40 ` Nicolas Goaziou
2018-02-06 14:11 ` Yasushi SHOJI
2018-01-22 16:41 ` Thomas S. Dye
2018-01-23 8:08 ` Christian Moe
2018-01-23 21:00 ` Samuel Wales
2018-03-04 9:32 ` Bastien Guerry
2018-03-04 10:06 ` Nicolas Goaziou
2018-03-04 10:29 ` Bastien
2018-03-05 14:20 ` Nicolas Goaziou
2018-03-05 16:23 ` Kaushal Modi
2018-03-06 17:41 ` Bastien Guerry
2018-03-06 21:39 ` Achim Gratz
2018-03-05 18:08 ` Thomas S. Dye
2018-03-06 1:08 ` Bastien Guerry
2018-03-06 9:57 ` Thomas S. Dye
2018-03-06 11:55 ` Eric S Fraga
2018-03-06 17:39 ` Bastien
2018-03-06 18:45 ` Thomas S. Dye
2018-03-06 19:19 ` Bastien
2018-03-07 2:53 ` Thomas S. Dye
2018-03-05 19:01 ` Achim Gratz
2018-03-06 19:02 ` Bastien
2018-03-06 18:59 ` Bastien Guerry
[not found] ` <WM!6f8274ba0065f984ff76586f7cf117703ccda15adbb5042672b0d2695ee5ac6b367ee58f70aacbbc9c2b10eecb9672ea!@mailhub-mx3.ncl.ac.uk>
2018-03-05 16:22 ` Phillip Lord
2018-03-06 17:47 ` Bastien Guerry
2018-03-04 10:54 ` Bastien Guerry
2018-03-05 14:26 ` Nicolas Goaziou
2018-03-06 17:43 ` Bastien Guerry
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=87tvveqi7u.fsf@bzg.fr \
--to=bzg@gnu.org \
--cc=Stromeko@nexgo.de \
--cc=emacs-orgmode@gnu.org \
--cc=mail@nicolasgoaziou.fr \
/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).