mirrors/org-babel
mirrors/org-babel
1
0
Fork 0
mirror of https://github.com/emacs-twist/org-babel.git synced 2025-03-05 08:17:05 +00:00
Code Activity

docs: Update on the API changes

Browse source
This commit is contained in:
Akira Komamura 2022-01-02 21:36:40 +09:00
parent 629afa4408
commit 5d4fc523d5
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.org
View file

@ -54,8 +54,6 @@ Arguments:
3. An attribute set of options.
*** Options
**** Languages
This option is required.
Example:
#+begin_src nix
@ -63,23 +61,24 @@ Example:
languages = [ "emacs-lisp" "elisp" ];
}
#+end_src
Default: =[ "emacs-lisp" "lisp" ]=
**** Filtering subtrees
You can transform the input by specifying =processLines= option.
It must be a function that takes a list of strings and returns a list of strings.
This library also contains =excludeOrgSubtreesOnHeadlines= function which can be used to exclude subtrees according to a predicate on the headline text, so you can use it in the option.
This library also contains =excludeHeadlines= function which can be used to exclude subtrees according to a predicate on the headline text, so you can use it in the option.
Example:
#+begin_src nix
{
# Exclude archived subtrees
processLines = excludeOrgSubtreesOnHeadlines (matchOrgTag "ARCHIVE");
processLines = excludeHeadlines (matchOrgTag "ARCHIVE");
}
#+end_src
You can use the following predicates from this library:
- matchOrgTag :: Returns true if the headline matches a tag given as the argument. The argument must be a string.
- matchOrgHeadline :: Returns true if the headline matches the text given as the argument. The argument must be a string.
- matchOrgHeadlines :: Returns true if the headline matches any of the texts given as the argument. The argument must be a list of strings.
- tag :: Returns true if the headline matches a tag given as the argument. The argument must be a string.
- headlineText :: Returns true if the headline matches the text given as the argument. The argument must be a string.