';
@@ -1141,10 +1463,10 @@ sub PostMe_widget($) {
FW_pO '';
@@ -1171,19 +1493,38 @@ sub PostMe_widget($) {
Defines the PostMe system, <postit> is an arbitrary name for the system.
Usage
- See http://www.fhemwiki.de/wiki/Modul_PostMe
-
- An arbitrary number of lists may be added to the system with the create command as
- set <postit> create <name>
+ See Wiki documentation
+
+ An arbitrary number of lists may be added to the system with the create command.
List items may consist of one or more words, and are added/removed by the add and
- remove command.
- Attention: A comma "," is the separator for list items.
- set <postit> add <name> <some text, but careful with commas>
-
- Special meta data for items may be included in the items by using "[" and "]"; characters, e.g.
- set <postit> add <name> <item> [<attribute1>="<data1>" ...
- These attribute-value pairs may be added, modified and removed with the modify command
-
+ remove command, but no separator characters are allowed in one item
+ Attention: A comma "," is the default separator for list items, see attributes below.
+
+ Meta data for items (=annotations)may be included in the items by using "[" and "]"; characters, e.g.
+ set <postit> add <name> <item> [<attribute1>="<data1>" ...
+ These attribute-value pairs may be added, modified and removed with the modify command.
+
+ Special annotations will be evaluated further, either on creation or manually by executing the commands
+ get <postit> special <name> resp. get <postit> allspecial
+
+
The attribute at="<timespec/datespec>", when given a timespec/datespec value, will result in a single or multiple
+ reminding messages for this item. The syntax for this timespec/datespec value is
+ (<HH:MM>|<HH:MM:SS>|<YYYY-MM-DD>T<HH:MM:SS>)[-<HH:MM>[P<number>]]
+
+ The first part is the time/date specification when the item is due.
+ The second optional part beginning with a "-"-sign
+ denotes how much time befor this date you want to be alerted.
+ The third optional part beginning with a "P" character
+ allows to specify a <number> of periodic reminders, the period given by the second part.
+ Processing this attribute means, that several at devices will be set up in the room hidden
+ that are triggered when at the specified times.
+ See documentation in Wiki for examples.
+
+
The attribute notify="<eventspec>", when given an eventspec value, will result in a single or multiple
+ reminding messages for this item.
+ Processing this attribute means, that a notify device will be set up in the room hidden
+ that is triggered when the event is detected.
+
The sticky notes may be integrated into any Web page by simply embedding the following tags
<embed src="/fhem/PostMe_widget?type=pins&postit=<postit>"/>
@@ -1191,7 +1532,9 @@ sub PostMe_widget($) {
<embed src="/fhem/PostMe_widget?type=pin&postit=<postit>&name=<name>"/>
to produce an interactive entry for PostMe <name>from system <postit>
-
+
+ The module provides interface routines that may be called from your own Perl programs, see documentation in the Wiki.
+
Set
@@ -1206,8 +1549,9 @@ sub PostMe_widget($) {
set <postit> modify <name> <item> <attribute> <data> adds/modifies/removes and attribute-value-pair <attribute>="<data>" to the item <item> on the sticky note named <name>
adding, if this attribute is not yet present; modification, if it is present - <data> will then be overwritten; removal, if no <data> is given
-
set <postit> remove <name> <item>
- removes from the sticky note named <name> an item <item>
+
set <postit> remove <name> <item>
+ set <postit> remove <name> item<number>
+ removes from the sticky note named <name> an item <item> or the one numbered <number> (starting at 0)
set <postit> clear <name> clears the sticky note named <name> from all items
@@ -1217,12 +1561,16 @@ sub PostMe_widget($) {
get <postit> list <name> Show the sticky note named <name> and its content
+
get <postit> special <name>
+ Process the special annotations (see above) of the sticky note named <name>
get <postit> mail <name> Send the sticky note named <name> and its content via eMail to a predefined
- recipient (e.g. sticky note is sent to ).
+ recipient (e.g. sticky note <postme01Name> is sent to <postme01MailRec>). The mailing
+ subroutine is called with three parameters for recipient, subject
+ and text.
get <postit> message <name> Send the sticky note named <name> and its content via instant messenger to a predefined
- recipient (e.g. sticky note is sent to ). The messenger
+ recipient (e.g. sticky note <postme01Name> is sent to <postme01MsgRec>). The messenger
subroutine is called with three parameters for recipient, subject
and text.
get <postit> TTS <name>
@@ -1232,6 +1580,8 @@ sub PostMe_widget($) {
Return the sticky note named <name> in JSON format
get <postit> all Show all sticky notes and their content
+
get <postit> allspecial
+ Process the special annotations (see above) of all sticky notes
get <postit> version Display the version of the module
@@ -1249,6 +1599,8 @@ sub PostMe_widget($) {
If jQuery, embedded sticky notes will produce jQuery code (default)
If HTML, embedded sticky notes will produce HTML code
If SVG, embedded sticky notes will produce SVG code
+
attr <postit> listseparator <character>
+ Character used to separate list items (default ',')
Note, that in the parameters sent to the following functions, ":" serves as separator between list name and items,
and "," serves as separator between items. They may be exchanged with simple regular expression operations.