Re: Minimal list of packages for `guix shell` for documentation compilation?
On Wed, May 17, 2023 at 12:38 AM Kyle Meyer wrote: > > Here's the minimum set of packages I needed with --pure: > > $ guix shell --pure \ >coreutils diffutils emacs-minimal glibc git grep make sed tar texinfo > texlive \ >-- make doc > > (Note: texlive is large, so that will take some time if you don't > already have it in your store.) What is the subset of texlive packages used by org-mode's documentation? I see that there's texlive-base, but I've tried that, and it is insufficient.
Minimal list of packages for `guix shell` for documentation compilation?
I would like to run `make doc` under `guix shell` to test my documentation patches. Does anyone know the minimal list of packages and proper `guix shell` incantation for that? Thank you, Yuval Langer.
Re: Suggestion: for each listed keybinding, also name the command
On Fri, May 5, 2023 at 1:51 PM Yuval Langer wrote:> …
> I want to add command names into the org-mode guide. I have attached
> an example of such an addition.
> …
I have:
- Added all the obvious commands to the `- {{{kbd(…)}}} ::` lines.
- Left several of these lines without a command where I've the manual
do the same.
(Thanks, Ihor Radchenko!)
From 6ee788814224436652cc46ae435005d9d8830ed0 Mon Sep 17 00:00:00 2001
From: Yuval Langer
Date: Fri, 5 May 2023 11:57:37 +0300
Subject: [PATCH] doc/org-guide.org: Add command names to listed keybindings
TINYCHANGE
---
doc/org-guide.org | 272 +++---
1 file changed, 138 insertions(+), 134 deletions(-)
diff --git a/doc/org-guide.org b/doc/org-guide.org
index 95828e4c0..8eeae850b 100644
--- a/doc/org-guide.org
+++ b/doc/org-guide.org
@@ -141,10 +141,11 @@ See [[*Miscellaneous]] for a setup to realize this.
Outlines make it possible to hide parts of the text in the buffer.
Org uses just two commands, bound to {{{kbd(TAB)}}} and
-{{{kbd(S-TAB)}}} to change the visibility in the buffer.
+{{{kbd(S-TAB)}}} (~org-cycle~ and ~org-shifttab~) to change the
+visibility in the buffer.
#+attr_texinfo: :sep ,
-- {{{kbd(TAB)}}} ::
+- {{{kbd(TAB)}}} (~org-cycle~) ::
/Subtree cycling/: Rotate current subtree among the states
@@ -154,14 +155,14 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and
When called with a prefix argument ({{{kbd(C-u TAB)}}}), or with the
Shift key, global cycling is invoked.
-- {{{kbd(S-TAB)}}}, {{{kbd(C-u TAB)}}} ::
+- {{{kbd(S-TAB)}}} (~org-global-cycle~), {{{kbd(C-u TAB)}}} ::
/Global cycling/: Rotate the entire buffer among the states
: ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
: '--'
-- {{{kbd(C-u C-u C-u TAB)}}} ::
+- {{{kbd(C-u C-u C-u TAB)}}} (~org-show-all~) ::
Show all, including drawers.
@@ -180,15 +181,18 @@ basis by adding a =STARTUP= keyword to =overview=, =content=,
The following commands jump to other headlines in the buffer.
-- {{{kbd(C-c C-n)}}} :: Next heading.
+- {{{kbd(C-c C-n)}}} (~org-next-visible-heading~) :: Next heading.
+- {{{kbd(C-c C-p)}}} (~org-previous-visible-heading~) :: Previous
+ heading.
-- {{{kbd(C-c C-p)}}} :: Previous heading.
+- {{{kbd(C-c C-f)}}} (~org-backward-heading-same-level~) :: Next
+ heading same level.
-- {{{kbd(C-c C-f)}}} :: Next heading same level.
+- {{{kbd(C-c C-b)}}} (~outline-backward-same-level~) :: Previous
+ heading same level.
-- {{{kbd(C-c C-b)}}} :: Previous heading same level.
-
-- {{{kbd(C-c C-u)}}} :: Backward to higher level heading.
+- {{{kbd(C-c C-u)}}} (~outline-up-heading~) :: Backward to higher
+ level heading.
** Structure Editing
:PROPERTIES:
@@ -196,37 +200,37 @@ The following commands jump to other headlines in the buffer.
:END:
#+attr_texinfo: :sep ,
-- {{{kbd(M-RET)}}} ::
+- {{{kbd(M-RET)}}} (~org-meta-return~) ::
Insert new heading with same level as current. If point is in
a plain list item, a new item is created (see [[Plain Lists]]). When
this command is used in the middle of a line, the line is split and
the rest of the line becomes the new headline[fn:2].
-- {{{kbd(M-S-RET)}}} ::
+- {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) ::
Insert new TODO entry with same level as current heading.
-- {{{kbd(TAB)}}} in new, empty entry ::
+- {{{kbd(TAB)}}} (~org-cycle~) in new, empty entry ::
In a new entry with no text yet, {{{kbd(TAB)}}} cycles through
reasonable levels.
-- {{{kbd(M-LEFT)}}}, {{{kbd(M-RIGHT)}}} ::
+- {{{kbd(M-LEFT)}}} (~org-metaleft~), {{{kbd(M-RIGHT)}}} (~org-metaright~) ::
Promote or demote current heading by one level.
-- {{{kbd(M-UP)}}}, {{{kbd(M-DOWN)}}} ::
+- {{{kbd(M-UP)}}} (~org-move-subtree-up~), {{{kbd(M-DOWN)}}} (~org-move-subtree-down~) ::
Move subtree up or down, i.e., swap with previous or next subtree of
same level.
-- {{{kbd(C-c C-w)}}} ::
+- {{{kbd(C-c C-w)}}} (~org-refile~) ::
Refile entry or region to a different location. See [[*Refile and
Copy]].
-- {{{kbd(C-x n s)}}}, {{{kbd(C-x n w)}}} ::
+- {{{kbd(C-x n s)}}} (~org-narrow-to-subtree~), {{{kbd(C-x n w)}}} (~widen~) ::
Narrow buffer to current subtree and widen it again.
@@ -247,12 +251,12 @@ Just try it out and you will see immediately how it works.
Org mode contains several commands creating such trees, all these
commands can be accessed through a dispatcher:
-- {{{kbd(C-c /)}}} ::
+- {{{kbd(C-c /)}}} (~org-sparse-tree~) ::
This prompts for an extra key to select a sparse-tree creating
command.
-- {{{kbd(C-c / r)}}} ::
+- {{{kbd(C-c / r)}}} (~org-occur~) ::
Occur. Prompts for a regexp and shows a sparse tree with all
matches. Each match is also highlighted; the highlights disappear
@@ -303,41 +307,41 @@ The following commands act on items when point is in the first line of
an item (the line with the bullet or number).
Suggestion: for each listed keybinding, also name the command
For many commands, I find it helpful to first learn their names before
learning their keybindings. The org-mode guide does not include
command names.
I want to add command names into the org-mode guide. I have attached
an example of such an addition.
The changes in the first commit might be later dropped as it
might be better to add command names only in the command lists.
This addition might not be appropriate for the org-mode guide, as it
is already covered by the org-mode manual, but I would have found it
very useful if the names of the commands were included.
From c03d821a9726e203113d622d1581a02d32b75302 Mon Sep 17 00:00:00 2001
From: Yuval Langer
Date: Fri, 5 May 2023 11:57:37 +0300
Subject: [PATCH 1/2] Add first function names.
---
doc/org-guide.org | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/doc/org-guide.org b/doc/org-guide.org
index 95828e4c0..3581e0a5e 100644
--- a/doc/org-guide.org
+++ b/doc/org-guide.org
@@ -141,7 +141,8 @@ See [[*Miscellaneous]] for a setup to realize this.
Outlines make it possible to hide parts of the text in the buffer.
Org uses just two commands, bound to {{{kbd(TAB)}}} and
-{{{kbd(S-TAB)}}} to change the visibility in the buffer.
+{{{kbd(S-TAB)}}} (~org-cycle~ and ~org-shifttab~) to change the
+visibility in the buffer.
#+attr_texinfo: :sep ,
- {{{kbd(TAB)}}} ::
--
2.30.2
From 08cadefe808c00e186991feec0f66e141a720986 Mon Sep 17 00:00:00 2001
From: Yuval Langer
Date: Fri, 5 May 2023 12:38:07 +0300
Subject: [PATCH 2/2] Add names to a few list entries.
---
doc/org-guide.org | 22 --
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/doc/org-guide.org b/doc/org-guide.org
index 3581e0a5e..3747e2d68 100644
--- a/doc/org-guide.org
+++ b/doc/org-guide.org
@@ -145,7 +145,7 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and
visibility in the buffer.
#+attr_texinfo: :sep ,
-- {{{kbd(TAB)}}} ::
+- {{{kbd(TAB)}}} (~org-cycle~) ::
/Subtree cycling/: Rotate current subtree among the states
@@ -155,7 +155,7 @@ visibility in the buffer.
When called with a prefix argument ({{{kbd(C-u TAB)}}}), or with the
Shift key, global cycling is invoked.
-- {{{kbd(S-TAB)}}}, {{{kbd(C-u TAB)}}} ::
+- {{{kbd(S-TAB)}}} (~org-shifttab~), {{{kbd(C-u TAB)}}} ::
/Global cycling/: Rotate the entire buffer among the states
@@ -181,15 +181,17 @@ basis by adding a =STARTUP= keyword to =overview=, =content=,
The following commands jump to other headlines in the buffer.
-- {{{kbd(C-c C-n)}}} :: Next heading.
-
-- {{{kbd(C-c C-p)}}} :: Previous heading.
+- {{{kbd(C-c C-n)}}} (~org-next-visible-heading~) :: Next heading.
+- {{{kbd(C-c C-p)}}} (~org-previous-visible-heading~) :: Previous
+ heading.
-- {{{kbd(C-c C-f)}}} :: Next heading same level.
+- {{{kbd(C-c C-f)}}} (~org-backward-heading-same-level~):: Next
+ heading same level.
-- {{{kbd(C-c C-b)}}} :: Previous heading same level.
+- {{{kbd(C-c C-b)}}} (~outline-backward-same-level~) :: Previous
+ heading same level.
-- {{{kbd(C-c C-u)}}} :: Backward to higher level heading.
+- {{{kbd(C-c C-u)}}} (~outline-up-heading~) :: Backward to higher level heading.
** Structure Editing
:PROPERTIES:
@@ -197,14 +199,14 @@ The following commands jump to other headlines in the buffer.
:END:
#+attr_texinfo: :sep ,
-- {{{kbd(M-RET)}}} ::
+- {{{kbd(M-RET)}}} (~org-meta-return~) ::
Insert new heading with same level as current. If point is in
a plain list item, a new item is created (see [[Plain Lists]]). When
this command is used in the middle of a line, the line is split and
the rest of the line becomes the new headline[fn:2].
-- {{{kbd(M-S-RET)}}} ::
+- {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) ::
Insert new TODO entry with same level as current heading.
--
2.30.2
[O] [patch] Small bug fix to the python babel documentation
Fixing a very small bug in which a source block ends with `#+end_src
python` instead of `#+end_src`, prohibiting it from being recognized
as a source block.
The branch:
https://gitlab.com/yuvallanger/worg-mirror-unofficial/tree/fix-end-src-python
The commit:
https://gitlab.com/yuvallanger/worg-mirror-unofficial/commit/8f6214fe35199186f256c17cccecbd5a9a8063c7
Attached is the `git format-patch master` patch file while HEAD is
pointing at fix-end-src-python.
Many thanks,
Yuval Langer.
From 8f6214fe35199186f256c17cccecbd5a9a8063c7 Mon Sep 17 00:00:00 2001
From: Yuval Langer <yuval.lan...@gmail.com>
Date: Thu, 24 Nov 2016 00:47:18 +0200
Subject: [PATCH] Fix bad end_src
---
org-contrib/babel/languages/ob-doc-python.org | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/org-contrib/babel/languages/ob-doc-python.org b/org-contrib/babel/languages/ob-doc-python.org
index 8acfbff..3ca20e1 100644
--- a/org-contrib/babel/languages/ob-doc-python.org
+++ b/org-contrib/babel/languages/ob-doc-python.org
@@ -191,7 +191,7 @@ plt.savefig('images/myfig.pdf')
#+begin_example
#+begin_src python :results output
print "Hello, world!"
-#+end_src python
+#+end_src
#+RESULTS:
: Hello, world!
--
2.9.3
