twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-08-01 12:41:52 -07:00
Code Issues Packages Projects Releases Wiki Activity

X.P.OrgMode: Update documentation

Browse Source 
Fix spelling mistakes, as well as make the existing documentation a
little bit more accurate in places.
This commit is contained in:
slotThe
2021-08-15 16:34:41 +02:00
parent b4a13e6b1b
commit 5417969522
1 changed files with 20 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
XMonad/Prompt/OrgMode.hs
View File

@@ -81,28 +81,29 @@ above you can write
> , ("M-C-o", orgPrompt def "TODO" "org/todos.org") > , ("M-C-o", orgPrompt def "TODO" "org/todos.org")
There is also some scheduling and deadline functionality present. They There is also some scheduling and deadline functionality present. This
are initiated by entering @+s@ or @+d@—separated by at least one may be initiated by entering @+s@ or @+d@—separated by at least one
whitespace character on either side—into the prompt respectively, whitespace character on either side—into the prompt, respectively.
followed a date and (optionally) a time of day. Any of the following Then, one may enter a date and (optionally) a time of day. Any of the
are valid dates: following are valid dates, where brackets indicate optionality:
- tod[ay] - tod[ay]
- tom[orrow] - tom[orrow]
- /any weekday/ - /any weekday/
- /any date of the form DD MM YYYY/ - /any date of the form DD [MM] [YYYY]/
In the last case, the month and the year are optional and will be, if In the last case, the missing month and year will be filled out with the
missing, filled out with the current month and year. For weekdays, we current month and year.
also disambiguate as early as possible, so a simple @w@ will suffice to
mean Wednesday, while @s@ will not be enough to say Sunday. You can, For weekdays, we also disambiguate as early as possible; a simple @w@
however, still write the full word without any troubles. Weekdays also will suffice to mean Wednesday, but @s@ will not be enough to say
always schedule into the future, e.g. if today is Monday and you Sunday. You can, however, also write the full word without any
schedule something for Monday, you will actually schedule it for the troubles. Weekdays always schedule into the future; e.g., if today is
/next/ Monday (the one in seven days). Monday and you schedule something for Monday, you will actually schedule
it for the /next/ Monday (the one in seven days).
The time is specified in the @HH:MM@ format. The minutes may be The time is specified in the @HH:MM@ format. The minutes may be
omitted, in which case @00@ will be substituted. omitted, in which case we assume a full hour is specified.
A few examples are probably in order. Suppose we have bound the key A few examples are probably in order. Suppose we have bound the key
above, pressed it, and are now confronted with a prompt: above, pressed it, and are now confronted with a prompt:
@@ -125,10 +126,10 @@ above, pressed it, and are now confronted with a prompt:
- @hello +s 11 jan 2013@ would schedule the note for the 11th of - @hello +s 11 jan 2013@ would schedule the note for the 11th of
January 2013. January 2013.
Note that, due to ambiguity issues, years below @25@ result in undefined Note that, due to ambiguity concerns, years below @25@ result in
parsing behaviour. Otherwise, what should @message +s 11 jan 13@ undefined parsing behaviour. Otherwise, what should @message +s 11 jan
resolve to—the 11th of january at 13:00 or the 11th of january in the 13@ resolve to—the 11th of january at 13:00 or the 11th of january in
year 13? the year 13?
There's also the possibility to take what's currently in the primary There's also the possibility to take what's currently in the primary
selection and paste that as the content of the created note. This is selection and paste that as the content of the created note. This is