denote-autoloads.el (22617B)
1 ;;; denote-autoloads.el --- automatically extracted autoloads (do not edit) -*- lexical-binding: t -*- 2 ;; Generated by the `loaddefs-generate' function. 3 4 ;; This file is part of GNU Emacs. 5 6 ;;; Code: 7 8 (add-to-list 'load-path (or (and load-file-name (file-name-directory load-file-name)) (car load-path))) 9 10 11 12 ;;; Generated autoloads from denote.el 13 14 (put 'denote-directory 'safe-local-variable (lambda (val) (or (eq val 'local) (eq val 'default-directory)))) 15 (autoload 'denote "denote" "\ 16 Create a new note with the appropriate metadata and file name. 17 18 When called interactively, the metadata and file name are prompted 19 according to the value of `denote-prompts'. 20 21 When called from Lisp, all arguments are optional. 22 23 - TITLE is a string or a function returning a string. 24 25 - KEYWORDS is a list of strings. The list can be empty or the 26 value can be set to nil. 27 28 - FILE-TYPE is a symbol among those described in `denote-file-type'. 29 30 - SUBDIRECTORY is a string representing the path to either the 31 value of the variable `denote-directory' or a subdirectory 32 thereof. The subdirectory must exist: Denote will not create 33 it. If SUBDIRECTORY does not resolve to a valid path, the 34 variable `denote-directory' is used instead. 35 36 - DATE is a string representing a date like 2022-06-30 or a date 37 and time like 2022-06-16 14:30. A nil value or an empty string 38 is interpreted as the `current-time'. 39 40 - TEMPLATE is a symbol which represents the key of a cons cell in 41 the user option `denote-templates'. The value of that key is 42 inserted to the newly created buffer after the front matter. 43 44 (fn &optional TITLE KEYWORDS FILE-TYPE SUBDIRECTORY DATE TEMPLATE)" t) 45 (autoload 'denote-type "denote" "\ 46 Create note while prompting for a file type. 47 48 This is the equivalent to calling `denote' when `denote-prompts' 49 is set to \\='(file-type title keywords)." t) 50 (function-put 'denote-type 'interactive-only 't) 51 (autoload 'denote-date "denote" "\ 52 Create note while prompting for a date. 53 54 The date can be in YEAR-MONTH-DAY notation like 2022-06-30 or 55 that plus the time: 2022-06-16 14:30. When the user option 56 `denote-date-prompt-use-org-read-date' is non-nil, the date 57 prompt uses the more powerful Org+calendar system. 58 59 This is the equivalent to calling `denote' when `denote-prompts' 60 is set to \\='(date title keywords)." t) 61 (function-put 'denote-date 'interactive-only 't) 62 (autoload 'denote-subdirectory "denote" "\ 63 Create note while prompting for a subdirectory. 64 65 Available candidates include the value of the variable 66 `denote-directory' and any subdirectory thereof. 67 68 This is equivalent to calling `denote' when `denote-prompts' is 69 set to \\='(subdirectory title keywords)." t) 70 (function-put 'denote-subdirectory 'interactive-only 't) 71 (autoload 'denote-template "denote" "\ 72 Create note while prompting for a template. 73 74 Available candidates include the keys in the `denote-templates' 75 alist. The value of the selected key is inserted in the newly 76 created note after the front matter. 77 78 This is equivalent to calling `denote' when `denote-prompts' is 79 set to \\='(template title keywords)." t) 80 (function-put 'denote-template 'interactive-only 't) 81 (autoload 'denote-open-or-create "denote" "\ 82 Visit TARGET file in variable `denote-directory'. 83 If file does not exist, invoke `denote' to create a file. 84 85 If TARGET file does not exist, add the user input that was used 86 to search for it to the minibuffer history of the 87 `denote-title-prompt'. The user can then retrieve and possibly 88 further edit their last input, using it as the newly created 89 note's actual title. At the `denote-title-prompt' type 90 \\<minibuffer-local-map>\\[previous-history-element]. 91 92 (fn TARGET)" t) 93 (autoload 'denote-keywords-add "denote" "\ 94 Prompt for KEYWORDS to add to the current note's front matter. 95 When called from Lisp, KEYWORDS is a list of strings. 96 97 Rename the file without further prompt so that its name reflects 98 the new front matter, per `denote-rename-file-using-front-matter'. 99 100 (fn KEYWORDS)" t) 101 (autoload 'denote-keywords-remove "denote" "\ 102 Prompt for keywords in current note and remove them. 103 Keywords are retrieved from the file's front matter. 104 105 Rename the file without further prompt so that its name reflects 106 the new front matter, per `denote-rename-file-using-front-matter'." t) 107 (function-put 'denote-keywords-remove 'interactive-only 't) 108 (autoload 'denote-rename-file "denote" "\ 109 Rename file and update existing front matter if appropriate. 110 111 If in Dired, consider FILE to be the one at point, else prompt 112 with minibuffer completion for one. 113 114 If FILE has a Denote-compliant identifier, retain it while 115 updating the TITLE and KEYWORDS fields of the file name. Else 116 create an identifier based on the following conditions: 117 118 - If FILE does not have an identifier and optional DATE is 119 non-nil (such as with a prefix argument), invoke the function 120 `denote-prompt-for-date-return-id'. It prompts for a date and 121 uses it to derive the identifier. 122 123 - If FILE does not have an identifier and optional DATE is 124 nil (this is the case without a prefix argument), use the file 125 attributes to determine the last modified date and format it as 126 an identifier. 127 128 - As a fallback, derive an identifier from the current time. 129 130 The default TITLE is retrieved from a line starting with a title 131 field in the file's contents, depending on the given file 132 type (e.g. #+title for Org). Else, the file name is used as a 133 default value at the minibuffer prompt. 134 135 As a final step after the FILE, TITLE, and KEYWORDS prompts, ask 136 for confirmation, showing the difference between old and new file 137 names. 138 139 The file type extension (like .txt) is read from the underlying 140 file and is preserved through the renaming process. Files that 141 have no extension are simply left without one. 142 143 Renaming only occurs relative to the current directory. Files 144 are not moved between directories. 145 146 If the FILE has Denote-style front matter for the TITLE and 147 KEYWORDS, ask to rewrite their values in order to reflect the new 148 input (this step always requires confirmation and the underlying 149 buffer is not saved, so consider invoking `diff-buffer-with-file' 150 to double-check the effect). The rewrite of the FILE and 151 KEYWORDS in the front matter should not affect the rest of the 152 block. 153 154 If the file doesn't have front matter but is among the supported 155 file types (per `denote-file-type'), add front matter at the top 156 of it and leave the buffer unsaved for further inspection. 157 158 For per-file-type front matter, refer to the variables: 159 160 - `denote-org-front-matter' 161 - `denote-text-front-matter' 162 - `denote-toml-front-matter' 163 - `denote-yaml-front-matter' 164 165 This command is intended to (i) rename existing Denote notes 166 while updating their title and keywords in the front matter, (ii) 167 convert existing supported file types to Denote notes, and (ii) 168 rename non-note files (e.g. PDF) that can benefit from Denote's 169 file-naming scheme. The latter is a convenience we provide, 170 since we already have all the requisite mechanisms in 171 place (though Denote does not---and will not---manage such 172 files). 173 174 (fn FILE TITLE KEYWORDS &optional DATE)" t) 175 (autoload 'denote-dired-rename-marked-files "denote" "\ 176 Rename marked files in Dired to Denote file name. 177 178 The operation does the following: 179 180 - the file's existing file name is retained and becomes the TITLE 181 field, per Denote's file-naming scheme; 182 183 - the TITLE is sluggified and downcased, per our conventions; 184 185 - an identifier is prepended to the TITLE; 186 187 - the file's extension is retained; 188 189 - a prompt is asked once for the KEYWORDS field and the input is 190 applied to all file names; 191 192 - if the file is recognized as a Denote note, add a front matter 193 or rewrite it to include the new keywords. A confirmation to 194 carry out this step is performed once at the outset. Note that 195 the affected buffers are not saved. The user can thus check 196 them to confirm that the new front matter does not cause any 197 problems (e.g. with the command `diff-buffer-with-file'). 198 Multiple buffers can be saved with `save-some-buffers' (read 199 its doc string). The addition of front matter takes place only 200 if the given file has the appropriate file type extension (per 201 the user option `denote-file-type')." '(dired-mode)) 202 (autoload 'denote-rename-file-using-front-matter "denote" "\ 203 Rename FILE using its front matter as input. 204 When called interactively, FILE is the return value of the 205 function `buffer-file-name' which is subsequently inspected for 206 the requisite front matter. It is thus implied that the FILE has 207 a file type that is supported by Denote, per `denote-file-type'. 208 209 Unless AUTO-CONFIRM is non-nil (such as with a prefix argument), 210 ask for confirmation, showing the difference between the old and 211 the new file names. 212 213 Never modify the identifier of the FILE, if any, even if it is 214 edited in the front matter. Denote considers the file name to be 215 the source of truth in this case to avoid potential breakage with 216 typos and the like. 217 218 Refrain from performing the operation if the buffer has unsaved 219 changes. Inform the user about the need to save their changes 220 first. If AUTO-CONFIRM is non-nil, then save the buffer and 221 proceed with the renaming. 222 223 (fn FILE &optional AUTO-CONFIRM)" t) 224 (autoload 'denote-dired-rename-marked-files-using-front-matter "denote" "\ 225 Rename marked files in Dired using their front matter as input. 226 Marked files must count as notes for the purposes of Denote, 227 which means that they at least have an identifier in their file 228 name and use a supported file type, per `denote-file-type'. 229 Files that do not meet this criterion are ignored. 230 231 The operation does the following: 232 233 - the title in the front matter becomes the TITLE component of 234 the file name, with hyphenation per Denote's file-naming 235 scheme; 236 237 - the keywords in the front matter are used for the KEYWORDS 238 component of the file name and are processed accordingly, if 239 needed; 240 241 - the identifier remains unchanged in the file name even if it is 242 modified in the front matter (this is done to avoid breakage 243 caused by typos and the like). 244 245 NOTE that files must be saved, because Denote reads from the 246 underlying file, not a modified buffer (this is done to avoid 247 potential mistakes). The return value of a modified buffer is 248 the one prior to the modification, i.e. the one already written 249 on disk. 250 251 This command is useful for synchronizing multiple file names with 252 their respective front matter." '(dired-mode)) 253 (autoload 'denote-add-front-matter "denote" "\ 254 Insert front matter at the top of FILE. 255 256 When called interactively, FILE is the return value of the 257 function `buffer-file-name'. FILE is checked to determine 258 whether it is a note for Denote's purposes. 259 260 TITLE is a string. Interactively, it is the user input at the 261 minibuffer prompt. 262 263 KEYWORDS is a list of strings. Interactively, it is the user 264 input at the minibuffer prompt. This one supports completion for 265 multiple entries, each separated by the `crm-separator' (normally 266 a comma). 267 268 The purpose of this command is to help the user generate new 269 front matter for an existing note (perhaps because the user 270 deleted the previous one and could not undo the change). 271 272 This command does not rename the file (e.g. to update the 273 keywords). To rename a file by reading its front matter as 274 input, use `denote-rename-file-using-front-matter'. 275 276 Note that this command is useful only for existing Denote notes. 277 If the user needs to convert a generic text file to a Denote 278 note, they can use one of the command which first rename the file 279 to make it comply with our file-naming scheme and then add the 280 relevant front matter. 281 282 (fn FILE TITLE KEYWORDS)" t) 283 (autoload 'denote-dired-mode "denote" "\ 284 Fontify all Denote-style file names. 285 286 Add this or `denote-dired-mode-in-directories' to 287 `dired-mode-hook'. 288 289 This is a minor mode. If called interactively, toggle the 290 `Denote-Dired mode' mode. If the prefix argument is positive, 291 enable the mode, and if it is zero or negative, disable the mode. 292 293 If called from Lisp, toggle the mode if ARG is `toggle'. Enable 294 the mode if ARG is nil, omitted, or is a positive number. 295 Disable the mode if ARG is a negative number. 296 297 To check whether the minor mode is enabled in the current buffer, 298 evaluate `denote-dired-mode'. 299 300 The mode's hook is called both when the mode is enabled and when 301 it is disabled. 302 303 (fn &optional ARG)" t) 304 (autoload 'denote-dired-mode-in-directories "denote" "\ 305 Enable `denote-dired-mode' in `denote-dired-directories'. 306 Add this function to `dired-mode-hook'.") 307 (autoload 'denote-link "denote" "\ 308 Create link to TARGET note in variable `denote-directory'. 309 With optional ID-ONLY, such as a universal prefix 310 argument (\\[universal-argument]), insert links with just the 311 identifier and no further description. In this case, the link 312 format is always [[denote:IDENTIFIER]]. 313 314 Use TARGET's title for the link's description. The title comes 315 either from the front matter or the file name. 316 317 If region is active, use its text as the link's description 318 instead of TARGET's title. If active region is empty (i.e 319 whitespace-only), insert an ID-ONLY link. 320 321 (fn TARGET &optional ID-ONLY)" t) 322 (autoload 'denote-link-find-file "denote" "\ 323 Use minibuffer completion to visit linked file." t) 324 (autoload 'denote-link-find-backlink "denote" "\ 325 Use minibuffer completion to visit backlink to current file. 326 327 Like `denote-link-find-file', but select backlink to follow." t) 328 (autoload 'denote-link-after-creating "denote" "\ 329 Create new note in the background and link to it directly. 330 331 Use `denote' interactively to produce the new note. Its doc 332 string explains which prompts will be used and under what 333 conditions. 334 335 With optional ID-ONLY as a prefix argument create a link that 336 consists of just the identifier. Else try to also include the 337 file's title. This has the same meaning as in `denote-link'. 338 339 IMPORTANT NOTE: Normally, `denote' does not save the buffer it 340 produces for the new note. This is a safety precaution to not 341 write to disk unless the user wants it (e.g. the user may choose 342 to kill the buffer, thus cancelling the creation of the note). 343 However, for this command the creation of the note happens in the 344 background and the user may miss the step of saving their buffer. 345 We thus have to save the buffer in order to (i) establish valid 346 links, and (ii) retrieve whatever front matter from the target 347 file. 348 349 (fn &optional ID-ONLY)" t) 350 (autoload 'denote-link-or-create "denote" "\ 351 Use `denote-link' on TARGET file, creating it if necessary. 352 353 If TARGET file does not exist, call `denote-link-after-creating' 354 which runs the `denote' command interactively to create the file. 355 The established link will then be targeting that new file. 356 357 If TARGET file does not exist, add the user input that was used 358 to search for it to the minibuffer history of the 359 `denote-title-prompt'. The user can then retrieve and possibly 360 further edit their last input, using it as the newly created 361 note's actual title. At the `denote-title-prompt' type 362 \\<minibuffer-local-map>\\[previous-history-element]. 363 364 With optional ID-ONLY as a prefix argument create a link that 365 consists of just the identifier. Else try to also include the 366 file's title. This has the same meaning as in `denote-link'. 367 368 (fn TARGET &optional ID-ONLY)" t) 369 (autoload 'denote-link-buttonize-buffer "denote" "\ 370 Make denote: links actionable buttons in the current buffer. 371 372 Buttonization applies to the plain text and Markdown file types, 373 per the user option `denote-file-types'. It will not do anything 374 in `org-mode' buffers, as buttons already work there. If you do 375 not use Markdown or plain text, then you do not need this. 376 377 Links work when they point to a file inside the variable 378 `denote-directory'. 379 380 To buttonize links automatically add this function to the 381 `find-file-hook'. Or call it interactively for on-demand 382 buttonization. 383 384 When called from Lisp, with optional BEG and END as buffer 385 positions, limit the process to the region in-between. 386 387 (fn &optional BEG END)" t) 388 (autoload 'denote-link-backlinks "denote" "\ 389 Produce a buffer with backlinks to the current note. 390 391 The backlinks' buffer shows the file name of the note linking to 392 the current note, as well as the context of each link. 393 394 File names are fontified by Denote if the user option 395 `denote-link-fontify-backlinks' is non-nil. If this user option 396 is nil, the buffer is fontified by Xref. 397 398 The placement of the backlinks' buffer is controlled by the user 399 option `denote-link-backlinks-display-buffer-action'. By 400 default, it will show up below the current window." t) 401 (autoload 'denote-link-add-links "denote" "\ 402 Insert links to all notes matching REGEXP. 403 Use this command to reference multiple files at once. 404 Particularly useful for the creation of metanotes (read the 405 manual for more on the matter). 406 407 Optional ID-ONLY has the same meaning as in `denote-link': it 408 inserts links with just the identifier. 409 410 (fn REGEXP &optional ID-ONLY)" t) 411 (autoload 'denote-link-add-missing-links "denote" "\ 412 Insert missing links to all notes matching REGEXP. 413 Similar to `denote-link-add-links' but insert only links not yet 414 present in the current buffer. 415 416 Optional ID-ONLY has the same meaning as in `denote-link': it 417 inserts links with just the identifier. 418 419 (fn REGEXP &optional ID-ONLY)" t) 420 (autoload 'denote-link-dired-marked-notes "denote" "\ 421 Insert Dired marked FILES as links in BUFFER. 422 423 FILES are Denote notes, meaning that they have our file-naming 424 scheme, are writable/regular files, and use the appropriate file 425 type extension (per `denote-file-type'). Furthermore, the marked 426 files need to be inside the variable `denote-directory' or one of 427 its subdirectories. No other file is recognised (the list of 428 marked files ignores whatever does not count as a note for our 429 purposes). 430 431 The BUFFER is one which visits a Denote note file. If there are 432 multiple buffers, prompt with completion for one among them. If 433 there isn't one, throw an error. 434 435 With optional ID-ONLY as a prefix argument, insert links with 436 just the identifier (same principle as with `denote-link'). 437 438 This command is meant to be used from a Dired buffer. 439 440 (fn FILES BUFFER &optional ID-ONLY)" '(dired-mode)) 441 (autoload 'denote-link-ol-follow "denote" "\ 442 Find file of type `denote:' matching LINK. 443 LINK is the identifier of the note, optionally followed by a 444 search option akin to that of standard Org `file:' link types. 445 Read Info node `(org) Search Options'. 446 447 Uses the function `denote-directory' to establish the path to the 448 file. 449 450 (fn LINK)") 451 (autoload 'denote-link-ol-complete "denote" "\ 452 Like `denote-link' but for Org integration. 453 This lets the user complete a link through the `org-insert-link' 454 interface by first selecting the `denote:' hyperlink type.") 455 (autoload 'denote-link-ol-store "denote" "\ 456 Handler for `org-store-link' adding support for denote: links.") 457 (autoload 'denote-link-ol-export "denote" "\ 458 Export a `denote:' link from Org files. 459 The LINK, DESCRIPTION, and FORMAT are handled by the export 460 backend. 461 462 (fn LINK DESCRIPTION FORMAT)") 463 (eval-after-load 'org `(funcall ',(lambda nil (with-no-warnings (org-link-set-parameters "denote" :follow #'denote-link-ol-follow :face 'denote-faces-link :complete #'denote-link-ol-complete :store #'denote-link-ol-store :export #'denote-link-ol-export))))) 464 (autoload 'denote-org-capture "denote" "\ 465 Create new note through `org-capture-templates'. 466 Use this as a function that returns the path to the new file. 467 The file is populated with Denote's front matter. It can then be 468 expanded with the usual specifiers or strings that 469 `org-capture-templates' supports. 470 471 Note that this function ignores the `denote-file-type': it always 472 sets the Org file extension for the created note to ensure that 473 the capture process works as intended, especially for the desired 474 output of the `denote-org-capture-specifiers' (which can include 475 arbitrary text). 476 477 Consult the manual for template samples.") 478 (autoload 'denote-modules-mode "denote" "\ 479 Enable Denote integration modules locally. 480 481 Set modules to be enabled in `denote-modules' and activate the 482 minor mode, either globally or locally. The selected modules are 483 enabled only when the minor mode is active. 484 485 This is a minor mode. If called interactively, toggle the 486 `Denote-Modules mode' mode. If the prefix argument is positive, 487 enable the mode, and if it is zero or negative, disable the mode. 488 489 If called from Lisp, toggle the mode if ARG is `toggle'. Enable 490 the mode if ARG is nil, omitted, or is a positive number. 491 Disable the mode if ARG is a negative number. 492 493 To check whether the minor mode is enabled in the current buffer, 494 evaluate `denote-modules-mode'. 495 496 The mode's hook is called both when the mode is enabled and when 497 it is disabled. 498 499 (fn &optional ARG)" t) 500 (defvar denote-modules-global-mode nil "\ 501 Non-nil if Denote-Modules-Global mode is enabled. 502 See the `denote-modules-global-mode' command 503 for a description of this minor mode. 504 Setting this variable directly does not take effect; 505 either customize it (see the info node `Easy Customization') 506 or call the function `denote-modules-global-mode'.") 507 (custom-autoload 'denote-modules-global-mode "denote" nil) 508 (autoload 'denote-modules-global-mode "denote" "\ 509 Enable Denote integration modules globally. 510 511 Set modules to be enabled in `denote-modules' and activate the 512 minor mode, either globally or locally. The selected modules are 513 enabled only when the minor mode is active. 514 515 This is a global minor mode. If called interactively, toggle the 516 `Denote-Modules-Global mode' mode. If the prefix argument is 517 positive, enable the mode, and if it is zero or negative, disable 518 the mode. 519 520 If called from Lisp, toggle the mode if ARG is `toggle'. Enable 521 the mode if ARG is nil, omitted, or is a positive number. 522 Disable the mode if ARG is a negative number. 523 524 To check whether the minor mode is enabled in the current buffer, 525 evaluate `(default-value \\='denote-modules-global-mode)'. 526 527 The mode's hook is called both when the mode is enabled and when 528 it is disabled. 529 530 (fn &optional ARG)" t) 531 (register-definition-prefixes "denote" '("denote-")) 532 533 534 ;;; Generated autoloads from denote-org-dblock.el 535 536 (autoload 'denote-org-dblock-insert-links "denote-org-dblock" "\ 537 Create Org dynamic block to insert Denote links matching REGEXP. 538 539 (fn REGEXP)" t) 540 (autoload 'denote-org-dblock-insert-backlinks "denote-org-dblock" "\ 541 Insert new Org dynamic block to include backlinks." t) 542 (register-definition-prefixes "denote-org-dblock" '("org-dblock-write:denote-")) 543 544 ;;; End of scraped data 545 546 (provide 'denote-autoloads) 547 548 ;; Local Variables: 549 ;; version-control: never 550 ;; no-byte-compile: t 551 ;; no-update-autoloads: t 552 ;; no-native-compile: t 553 ;; coding: utf-8-emacs-unix 554 ;; End: 555 556 ;;; denote-autoloads.el ends here