branch: externals/denote
commit ccdee2e549fb0b3bc538987e05a5abae097cd8ed
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Document all SIGNATURE symbols in section for developers
---
README.org | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
index 8985e8f225..a71bc466eb 100644
--- a/README.org
+++ b/README.org
@@ -2937,13 +2937,17 @@ might change them without further notice.
+ Variable ~denote-id-regexp~ :: Regular expression to match
~denote-id-format~.
+#+vindex: denote-signature-regexp
++ Variable ~denote-signature-regexp~ :: Regular expression to match
+ the =SIGNATURE= field in a file name.
+
#+vindex: denote-title-regexp
+ Variable ~denote-title-regexp~ :: Regular expression to match the
- TITLE field in a file name ([[#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d][The
file-naming scheme]]).
+ =TITLE= field in a file name ([[#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d][The
file-naming scheme]]).
#+vindex: denote-keywords-regexp
+ Variable ~denote-keywords-regexp~ :: Regular expression to match the
- KEYWORDS field in a file name
([[#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d][The file-naming scheme]]).
+ =KEYWORDS= field in a file name
([[#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d][The file-naming scheme]]).
#+vindex: denote-excluded-punctuation-regexp
+ Variable ~denote-excluded-punctuation-regexp~ :: Punctionation that
@@ -2969,6 +2973,10 @@ might change them without further notice.
+ Function ~denote-file-has-identifier-p~ :: Return non-nil if =FILE=
has a Denote identifier.
+#+findex: denote-file-has-signature-p
++ Function ~denote-file-has-signature-p~ :: Return non-nil if =FILE=
+ has a signature. [Part of {{{development-version}}}.]
+
#+findex: denote-file-has-supported-extension-p
+ Function ~denote-file-has-supported-extension-p~ :: Return non-nil
if =FILE= has supported extension. Also account for the possibility
@@ -3088,6 +3096,11 @@ might change them without further notice.
one, refer to the ~denote-retrieve-or-create-file-identifier~
function.
+#+findex: denote-retrieve-filename-signature
++ Function ~denote-retrieve-filename-signature~ :: Extract signature
+ from =FILE= name, if present, else return nil. [Part of
+ {{{development-version}}}.]
+
#+findex: denote-retrieve-or-create-file-identifier
+ Function ~denote-retrieve-or-create-file-identifier~ :: Return
=FILE= identifier, generating one if appropriate. The conditions
@@ -3128,6 +3141,10 @@ might change them without further notice.
+ Function ~denote-retrieve-keywords-line~ :: Return keywords line
from =FILE= front matter per =FILE-TYPE=.
+#+findex: denote-signature-prompt
++ Function ~denote-signature-prompt~ :: Prompt for signature
+ string. [Part of {{{development-version}}}.]
+
#+findex: denote-file-prompt
+ Function ~denote-file-prompt~ :: Prompt for file with identifier in
variable ~denote-directory~. With optional =INITIAL-TEXT=, use it
