denote-autoloads.el (41608B)
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 (directory-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 (stringp val) (eq val 'local) (eq val 'default-directory)))) 15 (put 'denote-known-keywords 'safe-local-variable #'listp) 16 (put 'denote-infer-keywords 'safe-local-variable (lambda (val) (or val (null val)))) 17 (autoload 'denote "denote" "\ 18 Create a new note with the appropriate metadata and file name. 19 20 Run the `denote-after-new-note-hook' after creating the new note. 21 22 When called interactively, the metadata and file name are prompted 23 according to the value of `denote-prompts'. 24 25 When called from Lisp, all arguments are optional. 26 27 - TITLE is a string or a function returning a string. 28 29 - KEYWORDS is a list of strings. The list can be empty or the 30 value can be set to nil. 31 32 - FILE-TYPE is a symbol among those described in `denote-file-type'. 33 34 - SUBDIRECTORY is a string representing the path to either the 35 value of the variable `denote-directory' or a subdirectory 36 thereof. The subdirectory must exist: Denote will not create 37 it. If SUBDIRECTORY does not resolve to a valid path, the 38 variable `denote-directory' is used instead. 39 40 - DATE is a string representing a date like 2022-06-30 or a date 41 and time like 2022-06-16 14:30. A nil value or an empty string 42 is interpreted as the `current-time'. 43 44 - TEMPLATE is a symbol which represents the key of a cons cell in 45 the user option `denote-templates'. The value of that key is 46 inserted to the newly created buffer after the front matter. 47 48 - SIGNATURE is a string or a function returning a string. 49 50 (fn &optional TITLE KEYWORDS FILE-TYPE SUBDIRECTORY DATE TEMPLATE SIGNATURE)" t) 51 (autoload 'denote-type "denote" "\ 52 Create note while prompting for a file type. 53 54 This is the equivalent of calling `denote' when `denote-prompts' 55 has the `file-type' prompt appended to its existing prompts." t) 56 (function-put 'denote-type 'interactive-only 't) 57 (autoload 'denote-date "denote" "\ 58 Create note while prompting for a date. 59 60 The date can be in YEAR-MONTH-DAY notation like 2022-06-30 or 61 that plus the time: 2022-06-16 14:30. When the user option 62 `denote-date-prompt-use-org-read-date' is non-nil, the date 63 prompt uses the more powerful Org+calendar system. 64 65 This is the equivalent of calling `denote' when `denote-prompts' 66 has the `date' prompt appended to its existing prompts." t) 67 (function-put 'denote-date 'interactive-only 't) 68 (autoload 'denote-subdirectory "denote" "\ 69 Create note while prompting for a subdirectory. 70 71 Available candidates include the value of the variable 72 `denote-directory' and any subdirectory thereof. 73 74 This is the equivalent of calling `denote' when `denote-prompts' 75 has the `subdirectory' prompt appended to its existing prompts." t) 76 (function-put 'denote-subdirectory 'interactive-only 't) 77 (autoload 'denote-template "denote" "\ 78 Create note while prompting for a template. 79 80 Available candidates include the keys in the `denote-templates' 81 alist. The value of the selected key is inserted in the newly 82 created note after the front matter. 83 84 This is the equivalent of calling `denote' when `denote-prompts' 85 has the `template' prompt appended to its existing prompts." t) 86 (function-put 'denote-template 'interactive-only 't) 87 (autoload 'denote-signature "denote" "\ 88 Create note while prompting for a file signature. 89 90 This is the equivalent of calling `denote' when `denote-prompts' 91 has the `signature' prompt appended to its existing prompts." t) 92 (function-put 'denote-signature 'interactive-only 't) 93 (autoload 'denote-region "denote" "\ 94 Call `denote' and insert therein the text of the active region." t) 95 (function-put 'denote-region 'interactive-only 't) 96 (autoload 'denote-open-or-create "denote" "\ 97 Visit TARGET file in variable `denote-directory'. 98 If file does not exist, invoke `denote' to create a file. 99 100 If TARGET file does not exist, add the user input that was used 101 to search for it to the minibuffer history of the 102 `denote-file-prompt'. The user can then retrieve and possibly 103 further edit their last input, using it as the newly created 104 note's actual title. At the `denote-file-prompt' type 105 \\<minibuffer-local-map>\\[previous-history-element]. 106 107 (fn TARGET)" t) 108 (autoload 'denote-open-or-create-with-command "denote" "\ 109 Visit TARGET file in variable `denote-directory'. 110 If file does not exist, invoke `denote' to create a file. 111 112 If TARGET file does not exist, add the user input that was used 113 to search for it to the minibuffer history of the 114 `denote-file-prompt'. The user can then retrieve and possibly 115 further edit their last input, using it as the newly created 116 note's actual title. At the `denote-file-prompt' type 117 \\<minibuffer-local-map>\\[previous-history-element]." t) 118 (function-put 'denote-open-or-create-with-command 'interactive-only 't) 119 (autoload 'denote-rename-file "denote" "\ 120 Rename file and update existing front matter if appropriate. 121 122 Always rename the file where it is located in the file system: 123 never move it to another directory. 124 125 If in Dired, consider FILE to be the one at point, else prompt 126 with minibuffer completion for one. When called from Lisp, FILE 127 is a file system path represented as a string. 128 129 If FILE has a Denote-compliant identifier, retain it while 130 updating components of the file name referenced by the user 131 option `denote-prompts'. By default, these are the TITLE and 132 KEYWORDS. The SIGNATURE is another one. When called from Lisp, 133 TITLE and SIGNATURE are strings, while KEYWORDS is a list of 134 strings. 135 136 If there is no identifier, create an identifier based on the 137 following conditions: 138 139 1. If the `denote-prompts' includes an entry for date prompts, 140 then prompt for DATE and take its input to produce a new 141 identifier. For use in Lisp, DATE must conform with 142 `denote-valid-date-p'. 143 144 2. If DATE is nil (e.g. when `denote-prompts' does not include a 145 date entry), use the file attributes to determine the last 146 modified date of FILE and format it as an identifier. 147 148 3. As a fallback, derive an identifier from the current date and 149 time. 150 151 4. At any rate, if the resulting identifier is not unique among 152 the files in the variable `denote-directory', increment it 153 such that it becomes unique. 154 155 In interactive use, and assuming `denote-prompts' includes a 156 title entry, make the TITLE prompt have prefilled text in the 157 minibuffer that consists of the current title of FILE. The 158 current title is either retrieved from the front matter (such as 159 the #+title in Org) or from the file name. 160 161 Do the same for the SIGNATURE prompt, subject to `denote-prompts', 162 by prefilling the minibuffer with the current signature of FILE, 163 if any. 164 165 Same principle for the KEYWORDS prompt: convert the keywords in 166 the file name into a comma-separated string and prefill the 167 minibuffer with it (the KEYWORDS prompt accepts more than one 168 keywords, each separated by a comma, else the `crm-separator'). 169 170 For all prompts, interpret an empty input as an instruction to 171 remove that file name component. For example, if a TITLE prompt 172 is available and FILE is 20240211T093531--some-title__keyword1.org 173 then rename FILE to 20240211T093531__keyword1.org. 174 175 If a file name component is present, but there is no entry for it in 176 `denote-prompts', keep it as-is. 177 178 [ NOTE: Please check with your minibuffer user interface how to 179 provide an empty input. The Emacs default setup accepts the 180 empty minibuffer contents as they are, though popular packages 181 like `vertico' use the first available completion candidate 182 instead. For `vertico', the user must either move one up to 183 select the prompt and then type RET there with empty contents, 184 or use the command `vertico-exit-input' with empty contents. 185 That Vertico command is bound to M-RET as of this writing on 186 2024-02-13 08:08 +0200. ] 187 188 When renaming FILE, read its file type extension (like .org) and 189 preserve it through the renaming process. Files that have no 190 extension are left without one. 191 192 As a final step, ask for confirmation, showing the difference 193 between old and new file names. Do not ask for confirmation if 194 the user option `denote-rename-no-confirm' is set to a non-nil 195 value. 196 197 If FILE has front matter for TITLE and KEYWORDS, ask to rewrite 198 their values in order to reflect the new input, unless 199 `denote-rename-no-confirm' is non-nil. When the 200 `denote-rename-no-confirm' is nil (the default), do not save the 201 underlying buffer, thus giving the user the option to 202 double-check the result, such as by invokling the command 203 `diff-buffer-with-file'. The rewrite of the TITLE and KEYWORDS 204 in the front matter should not affect the rest of the front 205 matter. 206 207 If the file does not have front matter but is among the supported 208 file types (per `denote-file-type'), add front matter to the top 209 of it and leave the buffer unsaved for further inspection. Save 210 the buffer if `denote-rename-no-confirm' is non-nil. 211 212 For the front matter of each file type, refer to the variables: 213 214 - `denote-org-front-matter' 215 - `denote-text-front-matter' 216 - `denote-toml-front-matter' 217 - `denote-yaml-front-matter' 218 219 Run the `denote-after-rename-file-hook' after renaming FILE. 220 221 This command is intended to (i) rename Denote files, (ii) convert 222 existing supported file types to Denote notes, and (ii) rename 223 non-note files (e.g. PDF) that can benefit from Denote's 224 file-naming scheme. 225 226 For a version of this command that works with multiple files 227 one-by-one, use `denote-dired-rename-files'. 228 229 (fn FILE &optional TITLE KEYWORDS SIGNATURE DATE)" t) 230 (autoload 'denote-dired-rename-files "denote" "\ 231 Rename Dired marked files same way as `denote-rename-file'. 232 Rename each file in sequence, making all the relevant prompts. 233 Unlike `denote-rename-file', do not prompt for confirmation of 234 the changes made to the file: perform them outright (same as 235 setting `denote-rename-no-confirm' to a non-nil value)." '(dired-mode)) 236 (function-put 'denote-dired-rename-files 'interactive-only 't) 237 (autoload 'denote-dired-rename-marked-files-with-keywords "denote" "\ 238 Rename marked files in Dired to a Denote file name by writing keywords. 239 240 Specifically, do the following: 241 242 - retain the file's existing name and make it the TITLE field, 243 per Denote's file-naming scheme; 244 245 - sluggify the TITLE, according to our conventions (check the 246 user option `denote-file-name-slug-functions'); 247 248 - prepend an identifier to the TITLE; 249 250 - preserve the file's extension, if any; 251 252 - prompt once for KEYWORDS and apply the user's input to the 253 corresponding field in the file name, rewriting any keywords 254 that may exist while removing keywords that do exist if 255 KEYWORDS is empty; 256 257 - add or rewrite existing front matter to the underlying file, if 258 it is recognized as a Denote note (per `denote-file-type'), 259 such that it includes the new keywords. 260 261 Run the `denote-after-rename-file-hook' after renaming is done. 262 263 [ Note that the affected buffers are not saved, unless the user 264 option `denote-rename-no-confirm' is non-nil. Users can thus 265 check them to confirm that the new front matter does not cause 266 any problems (e.g. with the `diff-buffer-with-file' command). 267 Multiple buffers can be saved in one go with the command 268 `save-some-buffers' (read its doc string). ]" '(dired-mode)) 269 (function-put 'denote-dired-rename-marked-files-with-keywords 'interactive-only 't) 270 (autoload 'denote-rename-file-using-front-matter "denote" "\ 271 Rename FILE using its front matter as input. 272 When called interactively, FILE is the return value of the 273 function `buffer-file-name' which is subsequently inspected for 274 the requisite front matter. It is thus implied that the FILE has 275 a file type that is supported by Denote, per `denote-file-type'. 276 277 Unless NO-CONFIRM is non-nil (such as with a prefix argument), 278 ask for confirmation, showing the difference between the old and 279 the new file names. 280 281 Never modify the identifier of the FILE, if any, even if it is 282 edited in the front matter. Denote considers the file name to be 283 the source of truth in this case to avoid potential breakage with 284 typos and the like. 285 286 If NO-CONFIRM is non-nil (such as with a prefix argument) do not 287 prompt for confirmation while renaming the file. Do it outright. 288 289 If optional SAVE-BUFFER is non-nil (such as with a double prefix 290 argument), save the corresponding buffer. 291 292 If the user option `denote-rename-no-confirm' is non-nil, 293 interpret it the same way as a combination of NO-CONFIRM and 294 SAVE-BUFFER. 295 296 The identifier of the file, if any, is never modified even if it 297 is edited in the front matter: Denote considers the file name to 298 be the source of truth in this case, to avoid potential breakage 299 with typos and the like. 300 301 (fn FILE &optional NO-CONFIRM SAVE-BUFFER)" t) 302 (autoload 'denote-dired-rename-marked-files-using-front-matter "denote" "\ 303 Call `denote-rename-file-using-front-matter' over the Dired marked files. 304 Refer to the documentation of that command for the technicalities. 305 306 Marked files must count as notes for the purposes of Denote, 307 which means that they at least have an identifier in their file 308 name and use a supported file type, per `denote-file-type'. 309 Files that do not meet this criterion are ignored because Denote 310 cannot know if they have front matter and what that may be." '(dired-mode)) 311 (autoload 'denote-keywords-add "denote" "\ 312 Prompt for KEYWORDS to add to the current note's front matter. 313 When called from Lisp, KEYWORDS is a list of strings. 314 315 Rename the file without further prompt so that its name reflects 316 the new front matter, per `denote-rename-file-using-front-matter'. 317 318 With an optional SAVE-BUFFER (such as a prefix argument when 319 called interactively), save the buffer outright. Otherwise leave 320 the buffer unsaved for further review. 321 322 If the user option `denote-rename-no-confirm' is non-nil, 323 interpret it the same way as SAVE-BUFFER, making SAVE-BUFFER 324 reduntant. 325 326 Run `denote-after-rename-file-hook' as a final step. 327 328 (fn KEYWORDS &optional SAVE-BUFFER)" t) 329 (autoload 'denote-keywords-remove "denote" "\ 330 Prompt for keywords in current note and remove them. 331 Keywords are retrieved from the file's front matter. 332 333 Rename the file without further prompt so that its name reflects 334 the new front matter, per `denote-rename-file-using-front-matter'. 335 336 With an optional SAVE-BUFFER as a prefix argument, save the 337 buffer outright. Otherwise leave the buffer unsaved for further 338 review. 339 340 If the user option `denote-rename-no-confirm' is non-nil, 341 interpret it the same way as SAVE-BUFFER, making SAVE-BUFFER 342 reduntant. 343 344 Run `denote-after-rename-file-hook' as a final step. 345 346 (fn &optional SAVE-BUFFER)" t) 347 (function-put 'denote-keywords-remove 'interactive-only 't) 348 (autoload 'denote-rename-add-signature "denote" "\ 349 Add to FILE name the SIGNATURE. 350 In interactive use, prompt for FILE, defaulting either to the current 351 buffer's file or the one at point in a Dired buffer. Also prompt for 352 SIGNATURE, using the existing one, if any, as the initial value. 353 354 When called from Lisp, FILE is a string pointing to a file system path 355 and SIGNATURE is a string. 356 357 Ask for confirmation before renaming the file to include the new 358 signature. Do it unless the user option `denote-rename-no-confirm' is 359 set to a non-nil value. 360 361 Once the operation is done, reload any Dired buffers and run the 362 `denote-after-rename-file-hook'. 363 364 Also see `denote-rename-remove-signature'. 365 366 (fn FILE SIGNATURE)" t) 367 (autoload 'denote-rename-remove-signature "denote" "\ 368 Remove the signature of FILE. 369 In interactive use, prompt for FILE, defaulting either to the current 370 buffer's file or the one at point in a Dired buffer. When called from 371 Lisp, FILE is a string pointing to a file system path. 372 373 Ask for confirmation before renaming the file to remove its signature. 374 Do it unless the user option `denote-rename-no-confirm' is set to a 375 non-nil value. 376 377 Once the operation is done, reload any Dired buffers and run the 378 `denote-after-rename-file-hook'. 379 380 Also see `denote-rename-add-signature'. 381 382 (fn FILE)" t) 383 (autoload 'denote-add-front-matter "denote" "\ 384 Insert front matter at the top of FILE. 385 386 When called interactively, FILE is the return value of the 387 function `buffer-file-name'. FILE is checked to determine 388 whether it is a note for Denote's purposes. 389 390 TITLE is a string. Interactively, it is the user input at the 391 minibuffer prompt. 392 393 KEYWORDS is a list of strings. Interactively, it is the user 394 input at the minibuffer prompt. This one supports completion for 395 multiple entries, each separated by the `crm-separator' (normally 396 a comma). 397 398 The purpose of this command is to help the user generate new 399 front matter for an existing note (perhaps because the user 400 deleted the previous one and could not undo the change). 401 402 This command does not rename the file (e.g. to update the 403 keywords). To rename a file by reading its front matter as 404 input, use `denote-rename-file-using-front-matter'. 405 406 Note that this command is useful only for existing Denote notes. 407 If the user needs to convert a generic text file to a Denote 408 note, they can use one of the command which first rename the file 409 to make it comply with our file-naming scheme and then add the 410 relevant front matter. 411 412 [ NOTE: Please check with your minibuffer user interface how to 413 provide an empty input. The Emacs default setup accepts the 414 empty minibuffer contents as they are, though popular packages 415 like `vertico' use the first available completion candidate 416 instead. For `vertico', the user must either move one up to 417 select the prompt and then type RET there with empty contents, 418 or use the command `vertico-exit-input' with empty contents. 419 That Vertico command is bound to M-RET as of this writing on 420 2024-02-29 09:24 +0200. ] 421 422 (fn FILE TITLE KEYWORDS)" t) 423 (autoload 'denote-change-file-type-and-front-matter "denote" "\ 424 Change file type of FILE and add an appropriate front matter. 425 426 If in Dired, consider FILE to be the one at point, else prompt 427 with minibuffer completion for one. 428 429 Add a front matter in the format of the NEW-FILE-TYPE at the 430 beginning of the file. 431 432 Retrieve the title of FILE from a line starting with a title 433 field in its front matter, depending on the previous file 434 type (e.g. #+title for Org). The same process applies for 435 keywords. 436 437 As a final step, ask for confirmation, showing the difference 438 between old and new file names. 439 440 Important note: No attempt is made to modify any other elements 441 of the file. This needs to be done manually. 442 443 (fn FILE NEW-FILE-TYPE)" t) 444 (autoload 'denote-dired-mode "denote" "\ 445 Fontify all Denote-style file names. 446 447 Add this or `denote-dired-mode-in-directories' to 448 `dired-mode-hook'. 449 450 This is a minor mode. If called interactively, toggle the 451 `Denote-Dired mode' mode. If the prefix argument is positive, 452 enable the mode, and if it is zero or negative, disable the mode. 453 454 If called from Lisp, toggle the mode if ARG is `toggle'. Enable 455 the mode if ARG is nil, omitted, or is a positive number. 456 Disable the mode if ARG is a negative number. 457 458 To check whether the minor mode is enabled in the current buffer, 459 evaluate `denote-dired-mode'. 460 461 The mode's hook is called both when the mode is enabled and when 462 it is disabled. 463 464 (fn &optional ARG)" t) 465 (autoload 'denote-dired-mode-in-directories "denote" "\ 466 Enable `denote-dired-mode' in `denote-dired-directories'. 467 Add this function to `dired-mode-hook'. 468 469 If `denote-dired-directories-include-subdirectories' is non-nil, 470 also enable it in all subdirectories.") 471 (autoload 'denote-link "denote" "\ 472 Create link to FILE note in variable `denote-directory' with DESCRIPTION. 473 474 When called interactively, prompt for FILE using completion. In 475 this case, derive FILE-TYPE from the current buffer. 476 477 The DESCRIPTION is returned by the function specified in variable 478 `denote-link-description-function'. If the region is active, its 479 content is deleted and can be used as the description of the 480 link. The default value of `denote-link-description-function' 481 returns the content of the active region, if any, else the title 482 of the linked file is used as the description. The title comes 483 either from the front matter or the file name. Note that if you 484 change the default value of `denote-link-description-function', 485 make sure to use the `region-text' parameter. Regardless of the 486 value of this user option, `denote-link' will always replace the 487 content of the active region. 488 489 With optional ID-ONLY as a non-nil argument, such as with a 490 universal prefix (\\[universal-argument]), insert links with just 491 the identifier and no further description. In this case, the 492 link format is always [[denote:IDENTIFIER]]. If the DESCRIPTION 493 is empty, the link is also as if ID-ONLY were non-nil. The 494 default value of `denote-link-description-function' returns an 495 empty string when the region is empty. Thus, the link will have 496 no description in this case. 497 498 When called from Lisp, FILE is a string representing a full file 499 system path. FILE-TYPE is a symbol as described in 500 `denote-file-type'. DESCRIPTION is a string. Whether the caller 501 treats the active region specially, is up to it. 502 503 (fn FILE FILE-TYPE DESCRIPTION &optional ID-ONLY)" t) 504 (autoload 'denote-link-with-signature "denote" "\ 505 Insert link to file with signature. 506 Prompt for file using minibuffer completion, limiting the list of 507 candidates to files with a signature in their file name. 508 509 By default, the description of the link includes the signature, 510 if present, followed by the file's title, if any. 511 512 For more advanced uses with Lisp, refer to the `denote-link' 513 function." t) 514 (function-put 'denote-link-with-signature 'interactive-only 't) 515 (autoload 'denote-find-link "denote" "\ 516 Use minibuffer completion to visit linked file." t) 517 (function-put 'denote-find-link 'interactive-only 't) 518 (autoload 'denote-find-backlink "denote" "\ 519 Use minibuffer completion to visit backlink to current file. 520 521 Like `denote-find-link', but select backlink to follow." t) 522 (function-put 'denote-find-backlink 'interactive-only 't) 523 (autoload 'denote-link-after-creating "denote" "\ 524 Create new note in the background and link to it directly. 525 526 Use `denote' interactively to produce the new note. Its doc 527 string explains which prompts will be used and under what 528 conditions. 529 530 With optional ID-ONLY as a prefix argument create a link that 531 consists of just the identifier. Else try to also include the 532 file's title. This has the same meaning as in `denote-link'. 533 534 For a variant of this, see `denote-link-after-creating-with-command'. 535 536 IMPORTANT NOTE: Normally, `denote' does not save the buffer it 537 produces for the new note. This is a safety precaution to not 538 write to disk unless the user wants it (e.g. the user may choose 539 to kill the buffer, thus cancelling the creation of the note). 540 However, for this command the creation of the note happens in the 541 background and the user may miss the step of saving their buffer. 542 We thus have to save the buffer in order to (i) establish valid 543 links, and (ii) retrieve whatever front matter from the target 544 file. Though see `denote-save-buffer-after-creation'. 545 546 (fn &optional ID-ONLY)" t) 547 (autoload 'denote-link-after-creating-with-command "denote" "\ 548 Like `denote-link-after-creating' but prompt for note-making COMMAND. 549 Use this to, for example, call `denote-signature' so that the 550 newly created note has a signature as part of its file name. 551 552 Optional ID-ONLY has the same meaning as in the command 553 `denote-link-after-creating'. 554 555 (fn COMMAND &optional ID-ONLY)" t) 556 (autoload 'denote-link-or-create "denote" "\ 557 Use `denote-link' on TARGET file, creating it if necessary. 558 559 If TARGET file does not exist, call `denote-link-after-creating' 560 which runs the `denote' command interactively to create the file. 561 The established link will then be targeting that new file. 562 563 If TARGET file does not exist, add the user input that was used 564 to search for it to the minibuffer history of the 565 `denote-file-prompt'. The user can then retrieve and possibly 566 further edit their last input, using it as the newly created 567 note's actual title. At the `denote-file-prompt' type 568 \\<minibuffer-local-map>\\[previous-history-element]. 569 570 With optional ID-ONLY as a prefix argument create a link that 571 consists of just the identifier. Else try to also include the 572 file's title. This has the same meaning as in `denote-link'. 573 574 (fn TARGET &optional ID-ONLY)" t) 575 (autoload 'denote-link-buttonize-buffer "denote" "\ 576 Make denote: links actionable buttons in the current buffer. 577 578 Buttonization applies to the plain text and Markdown file types, 579 per the user option `denote-file-types'. It will not do anything 580 in `org-mode' buffers, as buttons already work there. If you do 581 not use Markdown or plain text, then you do not need this. 582 583 Links work when they point to a file inside the variable 584 `denote-directory'. 585 586 To buttonize links automatically add this function to the 587 `find-file-hook'. Or call it interactively for on-demand 588 buttonization. 589 590 When called from Lisp, with optional BEG and END as buffer 591 positions, limit the process to the region in-between. 592 593 (fn &optional BEG END)" t) 594 (autoload 'denote-backlinks "denote" "\ 595 Produce a buffer with backlinks to the current note. 596 597 The backlinks' buffer shows the file name of the note linking to 598 the current note, as well as the context of each link. 599 600 File names are fontified by Denote if the user option 601 `denote-link-fontify-backlinks' is non-nil. If this user option 602 is nil, the buffer is fontified by Xref. 603 604 The placement of the backlinks' buffer is controlled by the user 605 option `denote-link-backlinks-display-buffer-action'. By 606 default, it will show up below the current window." t) 607 (autoload 'denote-add-links "denote" "\ 608 Insert links to all notes matching REGEXP. 609 Use this command to reference multiple files at once. 610 Particularly useful for the creation of metanotes (read the 611 manual for more on the matter). 612 613 Optional ID-ONLY has the same meaning as in `denote-link': it 614 inserts links with just the identifier. 615 616 (fn REGEXP &optional ID-ONLY)" t) 617 (autoload 'denote-link-dired-marked-notes "denote" "\ 618 Insert Dired marked FILES as links in BUFFER. 619 620 FILES are Denote notes, meaning that they have our file-naming 621 scheme, are writable/regular files, and use the appropriate file 622 type extension (per `denote-file-type'). Furthermore, the marked 623 files need to be inside the variable `denote-directory' or one of 624 its subdirectories. No other file is recognised (the list of 625 marked files ignores whatever does not count as a note for our 626 purposes). 627 628 The BUFFER is one which visits a Denote note file. If there are 629 multiple buffers, prompt with completion for one among them. If 630 there isn't one, throw an error. 631 632 With optional ID-ONLY as a prefix argument, insert links with 633 just the identifier (same principle as with `denote-link'). 634 635 This command is meant to be used from a Dired buffer. 636 637 (fn FILES BUFFER &optional ID-ONLY)" '(dired-mode)) 638 (defvar denote-menu-bar-mode t "\ 639 Non-nil if Denote-Menu-Bar mode is enabled. 640 See the `denote-menu-bar-mode' command 641 for a description of this minor mode. 642 Setting this variable directly does not take effect; 643 either customize it (see the info node `Easy Customization') 644 or call the function `denote-menu-bar-mode'.") 645 (custom-autoload 'denote-menu-bar-mode "denote" nil) 646 (autoload 'denote-menu-bar-mode "denote" "\ 647 Show Denote menu bar. 648 649 This is a global minor mode. If called interactively, toggle the 650 `Denote-Menu-Bar mode' mode. If the prefix argument is positive, 651 enable the mode, and if it is zero or negative, disable the mode. 652 653 If called from Lisp, toggle the mode if ARG is `toggle'. Enable 654 the mode if ARG is nil, omitted, or is a positive number. 655 Disable the mode if ARG is a negative number. 656 657 To check whether the minor mode is enabled in the current buffer, 658 evaluate `(default-value \\='denote-menu-bar-mode)'. 659 660 The mode's hook is called both when the mode is enabled and when 661 it is disabled. 662 663 (fn &optional ARG)" t) 664 (autoload 'denote-link-ol-follow "denote" "\ 665 Find file of type `denote:' matching LINK. 666 LINK is the identifier of the note, optionally followed by a 667 search option akin to that of standard Org `file:' link types. 668 Read Info node `(org) Search Options'. 669 670 Uses the function `denote-directory' to establish the path to the 671 file. 672 673 (fn LINK)") 674 (autoload 'denote-link-ol-complete "denote" "\ 675 Like `denote-link' but for Org integration. 676 This lets the user complete a link through the `org-insert-link' 677 interface by first selecting the `denote:' hyperlink type.") 678 (autoload 'denote-link-ol-store "denote" "\ 679 Handler for `org-store-link' adding support for denote: links. 680 Also see the user option `denote-org-store-link-to-heading'.") 681 (autoload 'denote-link-ol-export "denote" "\ 682 Export a `denote:' link from Org files. 683 The LINK, DESCRIPTION, and FORMAT are handled by the export 684 backend. 685 686 (fn LINK DESCRIPTION FORMAT)") 687 (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))))) 688 (autoload 'denote-org-capture "denote" "\ 689 Create new note through `org-capture-templates'. 690 Use this as a function that returns the path to the new file. 691 The file is populated with Denote's front matter. It can then be 692 expanded with the usual specifiers or strings that 693 `org-capture-templates' supports. 694 695 This function obeys `denote-prompts', but it ignores `file-type', 696 if present: it always sets the Org file extension for the created 697 note to ensure that the capture process works as intended, 698 especially for the desired output of the 699 `denote-org-capture-specifiers' (which can include arbitrary 700 text). 701 702 Consult the manual for template samples.") 703 (autoload 'denote-org-capture-with-prompts "denote" "\ 704 Like `denote-org-capture' but with optional prompt parameters. 705 706 When called without arguments, do not prompt for anything. Just 707 return the front matter with title and keyword fields empty and 708 the date and identifier fields specified. Also make the file 709 name consist of only the identifier plus the Org file name 710 extension. 711 712 Otherwise produce a minibuffer prompt for every non-nil value 713 that corresponds to the TITLE, KEYWORDS, SUBDIRECTORY, DATE, and 714 TEMPLATE arguments. The prompts are those used by the standard 715 `denote' command and all of its utility commands. 716 717 When returning the contents that fill in the Org capture 718 template, the sequence is as follows: front matter, TEMPLATE, and 719 then the value of the user option `denote-org-capture-specifiers'. 720 721 Important note: in the case of SUBDIRECTORY actual subdirectories 722 must exist---Denote does not create them. Same principle for 723 TEMPLATE as templates must exist and are specified in the user 724 option `denote-templates'. 725 726 (fn &optional TITLE KEYWORDS SUBDIRECTORY DATE TEMPLATE)") 727 (register-definition-prefixes "denote" '("denote-")) 728 729 730 ;;; Generated autoloads from denote-journal-extras.el 731 732 (autoload 'denote-journal-extras-new-entry "denote-journal-extras" "\ 733 Create a new journal entry in variable `denote-journal-extras-directory'. 734 Use `denote-journal-extras-keyword' as a keyword for the newly 735 created file. Set the title of the new entry according to the 736 value of the user option `denote-journal-extras-title-format'. 737 738 With optional DATE as a prefix argument, prompt for a date. If 739 `denote-date-prompt-use-org-read-date' is non-nil, use the Org 740 date selection module. 741 742 When called from Lisp DATE is a string and has the same format as 743 that covered in the documentation of the `denote' function. It 744 is internally processed by `denote-parse-date'. 745 746 (fn &optional DATE)" t) 747 (autoload 'denote-journal-extras-new-or-existing-entry "denote-journal-extras" "\ 748 Locate an existing journal entry or create a new one. 749 A journal entry is one that has `denote-journal-extras-keyword' as 750 part of its file name. 751 752 If there are multiple journal entries for the current date, 753 prompt for one using minibuffer completion. If there is only 754 one, visit it outright. If there is no journal entry, create one 755 by calling `denote-journal-extra-new-entry'. 756 757 With optional DATE as a prefix argument, prompt for a date. If 758 `denote-date-prompt-use-org-read-date' is non-nil, use the Org 759 date selection module. 760 761 When called from Lisp, DATE is a string and has the same format 762 as that covered in the documentation of the `denote' function. 763 It is internally processed by `denote-parse-date'. 764 765 (fn &optional DATE)" t) 766 (autoload 'denote-journal-extras-link-or-create-entry "denote-journal-extras" "\ 767 Use `denote-link' on journal entry, creating it if necessary. 768 A journal entry is one that has `denote-journal-extras-keyword' as 769 part of its file name. 770 771 If there are multiple journal entries for the current date, 772 prompt for one using minibuffer completion. If there is only 773 one, link to it outright. If there is no journal entry, create one 774 by calling `denote-journal-extra-new-entry' and link to it. 775 776 With optional DATE as a prefix argument, prompt for a date. If 777 `denote-date-prompt-use-org-read-date' is non-nil, use the Org 778 date selection module. 779 780 When called from Lisp, DATE is a string and has the same format 781 as that covered in the documentation of the `denote' function. 782 It is internally processed by `denote-parse-date'. 783 784 With optional ID-ONLY as a prefix argument create a link that 785 consists of just the identifier. Else try to also include the 786 file's title. This has the same meaning as in `denote-link'. 787 788 (fn &optional DATE ID-ONLY)" t) 789 (register-definition-prefixes "denote-journal-extras" '("denote-journal-extras-")) 790 791 792 ;;; Generated autoloads from denote-org-extras.el 793 794 (autoload 'denote-org-extras-link-to-heading "denote-org-extras" "\ 795 Link to file and then specify a heading to extend the link to. 796 797 The resulting link has the following pattern: 798 799 [[denote:IDENTIFIER::#ORG-HEADING-CUSTOM-ID]][Description::Heading text]]. 800 801 Because only Org files can have links to individual headings, 802 limit the list of possible files to those which include the .org 803 file extension (remember that Denote works with many file types, 804 per the user option `denote-file-type'). 805 806 The user option `denote-org-extras-store-link-to-heading' 807 determined whether the `org-store-link' function can save a link 808 to the current heading. Such links look the same as those of 809 this command, though the functionality defined herein is 810 independent of it. 811 812 To only link to a file, use the `denote-link' command." '(org-mode)) 813 (function-put 'denote-org-extras-link-to-heading 'interactive-only 't) 814 (autoload 'denote-org-extras-extract-org-subtree "denote-org-extras" "\ 815 Create new Denote note using the current Org subtree as input. 816 Remove the subtree from its current file and move its contents 817 into a new Denote file (a subtree is a heading with all of its 818 contents, including subheadings). 819 820 Take the text of the subtree's top level heading and use it as 821 the title of the new note. 822 823 If the heading has any tags, use them as the keywords of the new 824 note. If the Org file has any #+filetags use them as well (Org's 825 filetags are inherited by the headings). If none of these are 826 true and the user option `denote-prompts' includes an entry for 827 keywords, then prompt for keywords. Else do not include any 828 keywords. 829 830 If the heading has a PROPERTIES drawer, retain it for further 831 review. 832 833 If the heading's PROPERTIES drawer includes a DATE or CREATED 834 property, or there exists a CLOSED statement with a timestamp 835 value, use that to derive the date (or date and time) of the new 836 note (if there is only a date, the time is taken as 00:00). If 837 more than one of these is present, the order of preference is 838 DATE, then CREATED, then CLOSED. If none of these is present, 839 use the current time. If the `denote-prompts' includes an entry 840 for a date, then prompt for a date at this stage (also see 841 `denote-date-prompt-use-org-read-date'). 842 843 For the rest, consult the value of the user option 844 `denote-prompts' in the following scenaria: 845 846 - Optionally prompt for a subdirectory, otherwise produce the new 847 note in the variable `denote-directory'. 848 849 - Optionally prompt for a file signature, otherwise do not use 850 one. 851 852 Make the new note an Org file regardless of the value of 853 `denote-file-type'." '(org-mode)) 854 (autoload 'denote-org-extras-convert-links-to-file-type "denote-org-extras" "\ 855 Convert denote: links to file: links in the current Org buffer. 856 Ignore all other link types. Also ignore links that do not 857 resolve to a file in the variable `denote-directory'." '(org-mode)) 858 (autoload 'denote-org-extras-convert-links-to-denote-type "denote-org-extras" "\ 859 Convert file: links to denote: links in the current Org buffer. 860 Ignore all other link types. Also ignore file: links that do not 861 point to a file with a Denote file name." '(org-mode)) 862 (autoload 'denote-org-extras-dblock-insert-links "denote-org-extras" "\ 863 Create Org dynamic block to insert Denote links matching REGEXP. 864 865 (fn REGEXP)" '(org-mode)) 866 (autoload 'denote-org-extras-dblock-insert-missing-links "denote-org-extras" "\ 867 Create Org dynamic block to insert Denote links matching REGEXP. 868 869 (fn REGEXP)" '(org-mode)) 870 (autoload 'denote-org-extras-dblock-insert-backlinks "denote-org-extras" "\ 871 Create Org dynamic block to insert Denote backlinks to current file." '(org-mode)) 872 (autoload 'denote-org-extras-dblock-insert-files "denote-org-extras" "\ 873 Create Org dynamic block to insert Denote files matching REGEXP. 874 Sort the files according to SORT-BY-COMPONENT, which is a symbol 875 among `denote-sort-components'. 876 877 (fn REGEXP SORT-BY-COMPONENT)" '(org-mode)) 878 (register-definition-prefixes "denote-org-extras" '("denote-org-extras-" "org-dblock-write:denote-")) 879 880 881 ;;; Generated autoloads from denote-rename-buffer.el 882 883 (defvar denote-rename-buffer-mode nil "\ 884 Non-nil if Denote-Rename-Buffer mode is enabled. 885 See the `denote-rename-buffer-mode' command 886 for a description of this minor mode. 887 Setting this variable directly does not take effect; 888 either customize it (see the info node `Easy Customization') 889 or call the function `denote-rename-buffer-mode'.") 890 (custom-autoload 'denote-rename-buffer-mode "denote-rename-buffer" nil) 891 (autoload 'denote-rename-buffer-mode "denote-rename-buffer" "\ 892 Automatically rename Denote buffers to be easier to read. 893 894 A buffer is renamed upon visiting the underlying file. This 895 means that existing buffers are not renamed until they are 896 visited again in a new buffer (files are visited with the command 897 `find-file' or related). 898 899 This is a global minor mode. If called interactively, toggle the 900 `Denote-Rename-Buffer mode' mode. If the prefix argument is 901 positive, enable the mode, and if it is zero or negative, disable 902 the mode. 903 904 If called from Lisp, toggle the mode if ARG is `toggle'. Enable 905 the mode if ARG is nil, omitted, or is a positive number. 906 Disable the mode if ARG is a negative number. 907 908 To check whether the minor mode is enabled in the current buffer, 909 evaluate `(default-value \\='denote-rename-buffer-mode)'. 910 911 The mode's hook is called both when the mode is enabled and when 912 it is disabled. 913 914 (fn &optional ARG)" t) 915 (register-definition-prefixes "denote-rename-buffer" '("denote-rename-buffer")) 916 917 918 ;;; Generated autoloads from denote-silo-extras.el 919 920 (autoload 'denote-silo-extras-create-note "denote-silo-extras" "\ 921 Select SILO and run `denote' in it. 922 SILO is a file path from `denote-silo-extras-directories'. 923 924 When called from Lisp, SILO is a file system path to a directory. 925 926 (fn SILO)" t) 927 (autoload 'denote-silo-extras-open-or-create "denote-silo-extras" "\ 928 Select SILO and run `denote-open-or-create' in it. 929 SILO is a file path from `denote-silo-extras-directories'. 930 931 When called from Lisp, SILO is a file system path to a directory. 932 933 (fn SILO)" t) 934 (autoload 'denote-silo-extras-select-silo-then-command "denote-silo-extras" "\ 935 Select SILO and run Denote COMMAND in it. 936 SILO is a file path from `denote-silo-extras-directories', while 937 COMMAND is one among `denote-silo-extras-commands'. 938 939 When called from Lisp, SILO is a file system path to a directory. 940 941 (fn SILO COMMAND)" t) 942 (register-definition-prefixes "denote-silo-extras" '("denote-silo-extras-")) 943 944 945 ;;; Generated autoloads from denote-sort.el 946 947 (autoload 'denote-sort-files "denote-sort" "\ 948 Returned sorted list of Denote FILES. 949 950 With COMPONENT as a symbol among `denote-sort-components', 951 sort files based on the corresponding file name component. 952 953 With COMPONENT as a nil value keep the original date-based 954 sorting which relies on the identifier of each file name. 955 956 With optional REVERSE as a non-nil value, reverse the sort order. 957 958 (fn FILES COMPONENT &optional REVERSE)") 959 (autoload 'denote-sort-dired "denote-sort" "\ 960 Produce Dired dired-buffer with sorted files from variable `denote-directory'. 961 When called interactively, prompt for FILES-MATCHING-REGEXP, 962 SORT-BY-COMPONENT, and REVERSE. 963 964 1. FILES-MATCHING-REGEXP limits the list of Denote files to 965 those matching the provided regular expression. 966 967 2. SORT-BY-COMPONENT sorts the files by their file name 968 component (one among `denote-sort-components'). 969 970 3. REVERSE is a boolean to reverse the order when it is a non-nil value. 971 972 When called from Lisp, the arguments are a string, a keyword, and 973 a non-nil value, respectively. 974 975 (fn FILES-MATCHING-REGEXP SORT-BY-COMPONENT REVERSE)" t) 976 (register-definition-prefixes "denote-sort" '("denote-sort-")) 977 978 ;;; End of scraped data 979 980 (provide 'denote-autoloads) 981 982 ;; Local Variables: 983 ;; version-control: never 984 ;; no-byte-compile: t 985 ;; no-update-autoloads: t 986 ;; no-native-compile: t 987 ;; coding: utf-8-emacs-unix 988 ;; End: 989 990 ;;; denote-autoloads.el ends here