aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-05-20 10:50:45 +0200
committermarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-05-20 10:51:13 +0200
commit333109f2a312933e053dd4f6364093e30e2ba682 (patch)
tree99f9e1a88129985be6e7cd98a257ab3f6ac4b3c5
parent60209c881798aa9e649ddedd2879dfdeaeb32004 (diff)
readme re index
-rw-r--r--README.org5
-rw-r--r--mastodon.info82
-rw-r--r--mastodon.texi7
3 files changed, 59 insertions, 35 deletions
diff --git a/README.org b/README.org
index 7bc75db..f5e0237 100644
--- a/README.org
+++ b/README.org
@@ -335,6 +335,10 @@ See =M-x customize-group RET mastodon= to view all customize options.
- Display toot being replied to
- Set default reply visibility
+*** Commands and variables index
+
+An index of all user-facing commands and custom variables is available here: [[file:mastodon-index.org][mastodon-index.org]].
+
*** Alternative timeline layout
The incomparable Nicholas Rougier has written an alternative timeline layout
@@ -379,6 +383,7 @@ to your translator function as its text argument. Here's what
#+end_src
*** bookmarks and =mastodon.el=
+
=mastodon.el= doesn’t currently implement its own bookmark record and handler,
which means that emacs bookmarks will not work as is. Until we implement them,
you can get bookmarks going immediately by using [[https://github.com/emacsmirror/emacswiki.org/blob/master/bookmark%2b.el][bookmark+.el]].
diff --git a/mastodon.info b/mastodon.info
index 12f5da4..6ab20b4 100644
--- a/mastodon.info
+++ b/mastodon.info
@@ -38,6 +38,7 @@ Usage
* Composing toots::
* Other commands and account settings::
* Customization::
+* commands and variables index::
* Alternative timeline layout::
* Live-updating timelines mastodon-async-mode::
* Translating toots::
@@ -161,6 +162,7 @@ File: mastodon.info, Node: Usage, Next: Dependencies, Prev: Installation, Up
* Composing toots::
* Other commands and account settings::
* Customization::
+* commands and variables index::
* Alternative timeline layout::
* Live-updating timelines mastodon-async-mode::
* Translating toots::
@@ -424,7 +426,7 @@ and should work without first loading ‘mastodon.el’:
posts are marked as sensitive (nsfw) by default.

-File: mastodon.info, Node: Customization, Next: Alternative timeline layout, Prev: Other commands and account settings, Up: Usage
+File: mastodon.info, Node: Customization, Next: commands and variables index, Prev: Other commands and account settings, Up: Usage
1.2.5 Customization
-------------------
@@ -449,9 +451,18 @@ See ‘M-x customize-group RET mastodon’ to view all customize options.
• Set default reply visibility

-File: mastodon.info, Node: Alternative timeline layout, Next: Live-updating timelines mastodon-async-mode, Prev: Customization, Up: Usage
+File: mastodon.info, Node: commands and variables index, Next: Alternative timeline layout, Prev: Customization, Up: Usage
-1.2.6 Alternative timeline layout
+1.2.6 commands and variables index
+----------------------------------
+
+An index of all user-facing commands and custom variables is available
+here: mastodon-index.org (mastodon-index.org).
+
+
+File: mastodon.info, Node: Alternative timeline layout, Next: Live-updating timelines mastodon-async-mode, Prev: commands and variables index, Up: Usage
+
+1.2.7 Alternative timeline layout
---------------------------------
The incomparable Nicholas Rougier has written an alternative timeline
@@ -463,7 +474,7 @@ layout for ‘mastodon.el’.

File: mastodon.info, Node: Live-updating timelines mastodon-async-mode, Next: Translating toots, Prev: Alternative timeline layout, Up: Usage
-1.2.7 Live-updating timelines: ‘mastodon-async-mode’
+1.2.8 Live-updating timelines: ‘mastodon-async-mode’
----------------------------------------------------
(code taken from mastodon-future
@@ -482,7 +493,7 @@ Then you can view a timeline with one of the commands that begin with

File: mastodon.info, Node: Translating toots, Next: bookmarks and mastodonel, Prev: Live-updating timelines mastodon-async-mode, Up: Usage
-1.2.8 Translating toots
+1.2.9 Translating toots
-----------------------
You can translate toots with ‘mastodon-toot--translate-toot-text’ (‘a’
@@ -509,8 +520,8 @@ looks like:

File: mastodon.info, Node: bookmarks and mastodonel, Prev: Translating toots, Up: Usage
-1.2.9 bookmarks and ‘mastodon.el’
----------------------------------
+1.2.10 bookmarks and ‘mastodon.el’
+----------------------------------
‘mastodon.el’ doesn’t currently implement its own bookmark record and
handler, which means that emacs bookmarks will not work as is. Until we
@@ -645,34 +656,35 @@ File: mastodon.info, Node: Contributors, Prev: Supporting mastodonel, Up: REA

Tag Table:
Node: Top210
-Node: README911
-Node: Installation1327
-Node: MELPA1863
-Node: Emoji2231
-Node: Discover2563
-Node: Usage3115
-Node: Logging in to your instance3525
-Node: Timelines4522
-Ref: Keybindings4997
-Ref: Toot byline legend9570
-Node: Composing toots9879
-Ref: Keybindings (1)11118
-Ref: autocompletion of mentions and tags11636
-Ref: Draft toots12349
-Node: Other commands and account settings12820
-Node: Customization15978
-Node: Alternative timeline layout16764
-Node: Live-updating timelines mastodon-async-mode17154
-Node: Translating toots18006
-Node: bookmarks and mastodonel19188
-Node: Dependencies19658
-Node: Network compatibility20264
-Node: Contributing20750
-Node: Bug reports21039
-Node: Fixes and features21945
-Node: Coding style22428
-Node: Supporting mastodonel23052
-Node: Contributors23574
+Node: README944
+Node: Installation1360
+Node: MELPA1896
+Node: Emoji2264
+Node: Discover2596
+Node: Usage3148
+Node: Logging in to your instance3591
+Node: Timelines4588
+Ref: Keybindings5063
+Ref: Toot byline legend9636
+Node: Composing toots9945
+Ref: Keybindings (1)11184
+Ref: autocompletion of mentions and tags11702
+Ref: Draft toots12415
+Node: Other commands and account settings12886
+Node: Customization16044
+Node: commands and variables index16831
+Node: Alternative timeline layout17151
+Node: Live-updating timelines mastodon-async-mode17556
+Node: Translating toots18408
+Node: bookmarks and mastodonel19590
+Node: Dependencies20062
+Node: Network compatibility20668
+Node: Contributing21154
+Node: Bug reports21443
+Node: Fixes and features22349
+Node: Coding style22832
+Node: Supporting mastodonel23456
+Node: Contributors23978

End Tag Table
diff --git a/mastodon.texi b/mastodon.texi
index 1850844..f1de236 100644
--- a/mastodon.texi
+++ b/mastodon.texi
@@ -52,6 +52,7 @@ Usage
* Composing toots::
* Other commands and account settings::
* Customization::
+* commands and variables index::
* Alternative timeline layout::
* Live-updating timelines @samp{mastodon-async-mode}::
* Translating toots::
@@ -163,6 +164,7 @@ Or, with @samp{use-package}:
* Composing toots::
* Other commands and account settings::
* Customization::
+* commands and variables index::
* Alternative timeline layout::
* Live-updating timelines @samp{mastodon-async-mode}::
* Translating toots::
@@ -593,6 +595,11 @@ Set default reply visibility
@end itemize
@end itemize
+@node commands and variables index
+@subsection commands and variables index
+
+An index of all user-facing commands and custom variables is available here: @uref{mastodon-index.org, mastodon-index.org}.
+
@node Alternative timeline layout
@subsection Alternative timeline layout