branch: master commit b72cb7b83287ec9685dadf9cae2c817f830ff47e Author: Ian Dunn <du...@gnu.org> Commit: Ian Dunn <du...@gnu.org>
Cleaned up Changelog some more * org-edna.org (Changelog): Use spaces between each feature description * org-edna.info: Regenerated documentation. --- org-edna.info | 364 +++++++++++++++++++++++++++------------------------------- org-edna.org | 11 ++ 2 files changed, 182 insertions(+), 193 deletions(-) diff --git a/org-edna.info b/org-edna.info index 8745526..184755b 100644 --- a/org-edna.info +++ b/org-edna.info @@ -95,9 +95,9 @@ Conditions Extending Edna * Naming Conventions:: How to name new functions -* Finders: Finders (1). Making a new finder -* Actions: Actions (1). Making a new action -* Conditions: Conditions (1). Making a new condition +* Finders: Finders 1. Making a new finder +* Actions: Actions 1. Making a new action +* Conditions: Conditions 1. Making a new condition Contributing @@ -107,32 +107,11 @@ Contributing Changelog +* 1.0beta5: 10beta5. * 1.0beta4: 10beta4. * 1.0beta3: 10beta3. * 1.0beta2: 10beta2. -1.0beta4 - -* Fixed multiple forms getting incorrect targets:: -* Fixed multiple forms not evaluating:: - - -1.0beta3 - -* Conditional Forms: Conditional Forms (1). -* Overhauled Internal Parsing:: -* Fixed consideration keywords:: -* Added 'any consideration:: - - -1.0beta2 - -* Added interactive keyword editor with completion:: -* New uses of schedule! and deadline!:: -* New ``relatives'' finder:: -* New finders:: - - File: org-edna.info, Node: Copying, Next: Introduction, Prev: Top, Up: Top @@ -953,13 +932,69 @@ Property -------- • Syntax: set-property!(“PROPERTY” “VALUE”) + • Syntax: set-property!(“PROPERTY” inc) + • Syntax: set-property!(“PROPERTY” dec) + • Syntax: set-property!(“PROPERTY” next) + • Syntax: set-property!(“PROPERTY” prev) + • Syntax: set-property!(“PROPERTY” previous) + + The first form sets the property PROPERTY on all targets to VALUE. + + If VALUE is a symbol, it is interpreted as follows: + +inc + Increment a numeric property value by one +dec + Decrement a numeric property value by one + + If either ‘inc’ or ‘dec’ attempt to modify a non-numeric property +value, Edna will fail with an error message. + +next + Cycle the property through to the next allowed property value +previous + Cycle the property through to the previous allowed property value + + The symbol ‘prev’ may be used as an abbreviation for ‘previous’. +Similar to ‘inc’ and ‘dec’, any of these will fail if there are no +defined properties. When reaching the end of the list of allowed +properties, ‘next’ will cycle back to the beginning. - Sets the property PROPERTY on all targets to VALUE. + Example: + + #+PROPERTY: TEST_ALL a b c d + + * TODO Test Heading + :PROPERTIES: + :TEST: d + :TRIGGER: self set-property!("TEST" next) + :END: + + When “Test Heading” is set to DONE, its TEST property will change to +“a”. This also works with ‘previous’, but in the opposite direction. + + Additionally, all special forms will fail if the property is not +already set: + + * TODO Test + :PROPERTIES: + :TRIGGER: self set-property("TEST" inc) + :END: + + In the above example, if “Test” is set to DONE, Edna will fail to +increment the TEST property, since it doesn’t exist. • Syntax: delete-property!(“PROPERTY”) Deletes the property PROPERTY from all targets. + Examples: + + • set-property!(“COUNTER” “1”) -> Sets the property COUNTER to 1 on + all targets + • set-property!(“COUNTER” inc) -> Increments the property COUNTER by + 1. Following the previous example, it would be 2. + File: org-edna.info, Node: Priority, Next: Tag, Prev: Property, Up: Actions @@ -1302,12 +1337,12 @@ org-edna-TYPE/KEYWORD. * Menu: * Naming Conventions:: How to name new functions -* Finders: Finders (1). Making a new finder -* Actions: Actions (1). Making a new action -* Conditions: Conditions (1). Making a new condition +* Finders: Finders 1. Making a new finder +* Actions: Actions 1. Making a new action +* Conditions: Conditions 1. Making a new condition -File: org-edna.info, Node: Naming Conventions, Next: Finders (1), Up: Extending Edna +File: org-edna.info, Node: Naming Conventions, Next: Finders 1, Up: Extending Edna Naming Conventions ================== @@ -1321,7 +1356,7 @@ predicates with ’?’. finds a file. -File: org-edna.info, Node: Finders (1), Next: Actions (1), Prev: Naming Conventions, Up: Extending Edna +File: org-edna.info, Node: Finders 1, Next: Actions 1, Prev: Naming Conventions, Up: Extending Edna Finders ======= @@ -1335,7 +1370,7 @@ Finders have the form org-edna-finder/KEYWORD, like so: or nil if no targets were found. -File: org-edna.info, Node: Actions (1), Next: Conditions (1), Prev: Finders (1), Up: Extending Edna +File: org-edna.info, Node: Actions 1, Next: Conditions 1, Prev: Finders 1, Up: Extending Edna Actions ======= @@ -1352,7 +1387,7 @@ target). The rest of the arguments are the arguments specified in the form. -File: org-edna.info, Node: Conditions (1), Prev: Actions (1), Up: Extending Edna +File: org-edna.info, Node: Conditions 1, Prev: Actions 1, Up: Extending Edna Conditions ========== @@ -1475,34 +1510,37 @@ Changelog * Menu: +* 1.0beta5: 10beta5. * 1.0beta4: 10beta4. * 1.0beta3: 10beta3. * 1.0beta2: 10beta2. -File: org-edna.info, Node: 10beta4, Next: 10beta3, Up: Changelog +File: org-edna.info, Node: 10beta5, Next: 10beta4, Up: Changelog -1.0beta4 +1.0beta5 ======== -Just some bug fixes from the new form parsing. +Some new forms and a new build system. -* Menu: + • Added new forms to set-property! + • Now allows ’inc, ’dec, ’previous, and ’next as values + + • Changed build system to EDE to properly handle dependencies -* Fixed multiple forms getting incorrect targets:: -* Fixed multiple forms not evaluating:: + • Fixed compatibility with new Org effort functions -File: org-edna.info, Node: Fixed multiple forms getting incorrect targets, Next: Fixed multiple forms not evaluating, Up: 10beta4 +File: org-edna.info, Node: 10beta4, Next: 10beta3, Prev: 10beta5, Up: Changelog -Fixed multiple forms getting incorrect targets ----------------------------------------------- +1.0beta4 +======== - -File: org-edna.info, Node: Fixed multiple forms not evaluating, Prev: Fixed multiple forms getting incorrect targets, Up: 10beta4 +Just some bug fixes from the new form parsing. + + • Fixed multiple forms getting incorrect targets -Fixed multiple forms not evaluating ------------------------------------ + • Fixed multiple forms not evaluating File: org-edna.info, Node: 10beta3, Next: 10beta2, Prev: 10beta4, Up: Changelog @@ -1512,42 +1550,17 @@ File: org-edna.info, Node: 10beta3, Next: 10beta2, Prev: 10beta4, Up: Change HUGE addition here -* Menu: - -* Conditional Forms: Conditional Forms (1). -* Overhauled Internal Parsing:: -* Fixed consideration keywords:: -* Added 'any consideration:: - - -File: org-edna.info, Node: Conditional Forms (1), Next: Overhauled Internal Parsing, Up: 10beta3 - -Conditional Forms ------------------ + • Conditional Forms + • See *note Conditional Forms:: for more information - • See *note Conditional Forms:: for more information - - -File: org-edna.info, Node: Overhauled Internal Parsing, Next: Fixed consideration keywords, Prev: Conditional Forms (1), Up: 10beta3 + • Overhauled Internal Parsing -Overhauled Internal Parsing ---------------------------- - - -File: org-edna.info, Node: Fixed consideration keywords, Next: Added 'any consideration, Prev: Overhauled Internal Parsing, Up: 10beta3 - -Fixed consideration keywords ----------------------------- + • Fixed consideration keywords • Both consider and consideration are accepted now - -File: org-edna.info, Node: Added 'any consideration, Prev: Fixed consideration keywords, Up: 10beta3 - -Added ’any consideration ------------------------- - - • Allows passage if just one target is fulfilled + • Added ’any consideration + • Allows passage if just one target is fulfilled File: org-edna.info, Node: 10beta2, Prev: 10beta3, Up: Changelog @@ -1557,130 +1570,95 @@ File: org-edna.info, Node: 10beta2, Prev: 10beta3, Up: Changelog Big release here, with three new features. -* Menu: - -* Added interactive keyword editor with completion:: -* New uses of schedule! and deadline!:: -* New ``relatives'' finder:: -* New finders:: - - -File: org-edna.info, Node: Added interactive keyword editor with completion, Next: New uses of schedule! and deadline!, Up: 10beta2 - -Added interactive keyword editor with completion ------------------------------------------------- - - • See *note Setting the Properties:: for how to do that - - -File: org-edna.info, Node: New uses of schedule! and deadline!, Next: New ``relatives'' finder, Prev: Added interactive keyword editor with completion, Up: 10beta2 - -New uses of schedule! and deadline! ------------------------------------ - - • New “float” form that mimics diary-float - • New “landing” addition to “+1d” and friends to force planning - changes to land on a certain day or type of day (weekend/weekday) - • See *note Scheduled/Deadline:: for details - - -File: org-edna.info, Node: New ``relatives'' finder, Next: New finders, Prev: New uses of schedule! and deadline!, Up: 10beta2 + • Added interactive keyword editor with completion + • See *note Setting the Properties:: for how to do that -New “relatives” finder ----------------------- + • New uses of schedule! and deadline! + • New “float” form that mimics diary-float + • New “landing” addition to “+1d” and friends to force planning + changes to land on a certain day or type of day + (weekend/weekday) + • See *note Scheduled/Deadline:: for details - • Renamed from chain-find with tons of new keywords - • Modified all other relative finders (previous-sibling, first-child, - etc.) to use the same keywords - • See *note relatives:: for details - - -File: org-edna.info, Node: New finders, Prev: New ``relatives'' finder, Up: 10beta2 - -New finders ------------ + • New “relatives” finder + • Renamed from chain-find with tons of new keywords + • Modified all other relative finders (previous-sibling, + first-child, etc.) to use the same keywords + • See *note relatives:: for details - • *note previous-sibling-wrap:: - • *note rest-of-siblings-wrap:: + • New finders + • *note previous-sibling-wrap:: + • *note rest-of-siblings-wrap:: Tag Table: Node: Top225 -Node: Copying4054 -Node: Introduction4876 -Node: Installation and Setup5824 -Node: Basic Operation6617 -Node: Blockers8468 -Node: Triggers8754 -Node: Syntax9016 -Node: Basic Features9706 -Node: Finders10009 -Node: ancestors11774 -Node: children12368 -Node: descendants12778 -Node: file13300 -Node: first-child14049 -Node: ids14309 -Node: match14970 -Node: next-sibling15608 -Node: next-sibling-wrap15865 -Node: olp16179 -Node: org-file16591 -Node: parent17236 -Node: previous-sibling17434 -Node: previous-sibling-wrap17695 -Node: relatives17974 -Node: rest-of-siblings21595 -Node: rest-of-siblings-wrap21880 -Node: self22229 -Node: siblings22390 -Node: siblings-wrap22627 -Node: Actions22931 -Node: Scheduled/Deadline23673 -Node: TODO State27248 -Node: Archive27616 -Node: Chain Property27936 -Node: Clocking28219 -Node: Property28631 -Node: Priority28953 -Node: Tag29522 -Node: Effort29739 -Node: Advanced Features30128 -Node: Conditions30512 -Node: done31127 -Node: headings31291 -Node: todo-state31667 -Node: variable-set31923 -Node: has-property32352 -Node: re-search32621 -Node: Negating Conditions32981 -Node: Consideration33368 -Node: Conditional Forms34937 -Node: Setting the Properties37593 -Node: Extending Edna38677 -Node: Naming Conventions39167 -Node: Finders (1)39630 -Node: Actions (1)39996 -Node: Conditions (1)40461 -Node: Contributing41351 -Node: Bugs41902 -Node: Development42254 -Node: Documentation43407 -Node: Changelog43852 -Node: 10beta444018 -Node: Fixed multiple forms getting incorrect targets44257 -Node: Fixed multiple forms not evaluating44488 -Node: 10beta344697 -Node: Conditional Forms (1)44971 -Node: Overhauled Internal Parsing45170 -Node: Fixed consideration keywords45367 -Node: Added 'any consideration45626 -Node: 10beta245841 -Node: Added interactive keyword editor with completion46123 -Node: New uses of schedule! and deadline!46422 -Node: New ``relatives'' finder46917 -Node: New finders47313 +Node: Copying3672 +Node: Introduction4494 +Node: Installation and Setup5442 +Node: Basic Operation6235 +Node: Blockers8086 +Node: Triggers8372 +Node: Syntax8634 +Node: Basic Features9324 +Node: Finders9627 +Node: ancestors11392 +Node: children11986 +Node: descendants12396 +Node: file12918 +Node: first-child13667 +Node: ids13927 +Node: match14588 +Node: next-sibling15226 +Node: next-sibling-wrap15483 +Node: olp15797 +Node: org-file16209 +Node: parent16854 +Node: previous-sibling17052 +Node: previous-sibling-wrap17313 +Node: relatives17592 +Node: rest-of-siblings21213 +Node: rest-of-siblings-wrap21498 +Node: self21847 +Node: siblings22008 +Node: siblings-wrap22245 +Node: Actions22549 +Node: Scheduled/Deadline23291 +Node: TODO State26866 +Node: Archive27234 +Node: Chain Property27554 +Node: Clocking27837 +Node: Property28249 +Node: Priority30436 +Node: Tag31005 +Node: Effort31222 +Node: Advanced Features31611 +Node: Conditions31995 +Node: done32610 +Node: headings32774 +Node: todo-state33150 +Node: variable-set33406 +Node: has-property33835 +Node: re-search34104 +Node: Negating Conditions34464 +Node: Consideration34851 +Node: Conditional Forms36420 +Node: Setting the Properties39076 +Node: Extending Edna40160 +Node: Naming Conventions40650 +Node: Finders 141111 +Node: Actions 141473 +Node: Conditions 141932 +Node: Contributing42818 +Node: Bugs43369 +Node: Development43721 +Node: Documentation44874 +Node: Changelog45319 +Node: 10beta545506 +Node: 10beta445877 +Node: 10beta346130 +Node: 10beta246569 End Tag Table diff --git a/org-edna.org b/org-edna.org index dd53c6b..936ce84 100644 --- a/org-edna.org +++ b/org-edna.org @@ -1292,21 +1292,32 @@ making any changes: :DESCRIPTION: List of changes by version :END: ** 1.0beta5 +Some new forms and a new build system. + - Added new forms to set-property! - Now allows 'inc, 'dec, 'previous, and 'next as values + - Changed build system to EDE to properly handle dependencies + - Fixed compatibility with new Org effort functions ** 1.0beta4 Just some bug fixes from the new form parsing. + - Fixed multiple forms getting incorrect targets + - Fixed multiple forms not evaluating ** 1.0beta3 HUGE addition here + - Conditional Forms - See [[#conditional_forms][Conditional Forms]] for more information + - Overhauled Internal Parsing + - Fixed consideration keywords + - Both consider and consideration are accepted now + - Added 'any consideration - Allows passage if just one target is fulfilled ** 1.0beta2