Skip to content
This repository
Browse code

Merge remote-tracking branch 'origin/master' into devel

Conflicts:
	doc/man/taskopen.1
  • Loading branch information...
commit ff14c17ed4c74a4eda2765fae3838da56ef58f95 2 parents 4742b09 + fa202c3
Johannes S. authored February 21, 2013
2  README.markdown
Source Rendered
@@ -9,7 +9,7 @@ It also depends on the JSON module, i.e.
9 9
  * to be continued...
10 10
 
11 11
 #What does it do?
12  
-It allows you to link almost any file, webpage or command to a taskwarrior task, simply by adding a filepath, web-link or uri as an annotation. Text notes, images, PDF files, web addresses, spreadsheets and many other sorts of links can then be filtered, listed and opened by using taskopen. Some actions are sane defaults, others can be custom-configured, and everything else will use your systems mime-types to open the link. 
  12
+It allows you to link almost any file, webpage or command to a taskwarrior task by adding a filepath, web-link or uri as an annotation. Text notes, images, PDF files, web addresses, spreadsheets and many other types of links can then be filtered, listed and opened by using taskopen. Some actions are sane defaults, others can be custom-configured, and everything else will use your systems mime-types to open the link. 
13 13
 
14 14
 Arbitrary commands can be used with taskopen at the CLI, acting on the link targets, enhancing listings and even executing annotations as commands.
15 15
 
80  doc/html/taskopen(1).html
... ...
@@ -1,5 +1,5 @@
1  
-<!-- Creator     : groff version 1.21 -->
2  
-<!-- CreationDate: Thu Feb 14 01:13:23 2013 -->
  1
+<!-- Creator     : groff version 1.22.2 -->
  2
+<!-- CreationDate: Thu Feb 21 07:52:51 2013 -->
3 3
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4 4
 "http://www.w3.org/TR/html4/loose.dtd">
5 5
 <html>
@@ -71,7 +71,7 @@
71 71
 other output. A default can be set in the file.</p>
72 72
 
73 73
 <p style="margin-top: 1em">Any argument that is not
74  
-considered as an option or label will be passed to
  74
+recognized as an option or label will be passed to
75 75
 taskwarrior as an additional filter, i.e. any combination of
76 76
 taskwarrior filters can be used with taskopen. The default
77 77
 filter can be specified in the file, see</p>
@@ -120,60 +120,66 @@
120 120
 with &rsquo;Notes&rsquo;: $ task 1 annotate Notes</p>
121 121
 
122 122
 <p style="margin-top: 1em">you can open and edit this file
123  
-by: $ taskopen 1</p>
  123
+by: $ taskopen 1 -n</p>
124 124
 
125  
-<p style="margin-top: 1em">which, by default, opens a file
126  
-like -I
127  
-&quot;~/tasknotes/5727f1c7-2efe-fb6b-2bac-6ce073ba95ee.txt&quot;
128  
-with your favourite EDITOR.</p>
  125
+<p style="margin-top: 1em">which will use your default
  126
+EDITOR to open a file like</p>
129 127
 
130  
-<table width="100%" border="0" rules="none" frame="void"
131  
-       cellspacing="0" cellpadding="0">
132  
-<tr valign="top" align="left">
133  
-<td width="8%">
  128
+<p style="margin-top: 1em">You can also add weblinks to a
  129
+task and even mix all kinds of annotations: $ task 1
  130
+annotate web: www.taskwarrior.org
  131
+&lt;&lt;&lt;&lt;&lt;&lt;&lt; HEAD $ task 1 annotate I want
  132
+to consider this $ task 1 annotate -- man:
  133
+~/Documents/manual.pdf =======</p>
134 134
 
  135
+<p style="margin-top: 1em">$ task 1 annot I want to
  136
+consider this</p>
135 137
 
136  
-<p>You can also add weblinks to a task and even mix all
137  
-kinds of annotations:</p></td>
138  
-<td width="7%">
  138
+<p style="margin-top: 1em">$ task 1 ann man:
  139
+~/Documents/manual.pdf &gt;&gt;&gt;&gt;&gt;&gt;&gt;
  140
+origin/master</p>
139 141
 
140  
-
141  
-<p>$ task 1 annotate web: www.taskwarrior.org $ task 1
142  
-annotate I want to consider this $ task 1 annotate -- man:
143  
-~/Documents/manual.pdf</p> </td>
144  
-<td width="85%">
145  
-</td></tr>
146  
-</table>
147  
-
148  
-<p style="margin-top: 1em">There are various ways to open
149  
-either the URI or the pdf file. If taskopen finds more than
150  
-one suitable annotation, it will output a list and ask for
151  
-user interaction:</p>
  142
+<p style="margin-top: 1em">(note: taskopen currently works
  143
+only with &quot;link-type&quot; annotations, so the second
  144
+annot above will not be listed) There are various ways to
  145
+open either the URI or the pdf file. If taskopen finds more
  146
+than one annotation matching the filter, it will output a
  147
+list and ask for user interaction:</p>
152 148
 
153 149
 <p style="margin-top: 1em">$ taskopen 1</p>
154 150
 
155 151
 <p style="margin-top: 1em">Please select an annotation:
156 152
 <br>
157  
-1) web: www.taskwarrior.org <br>
158  
-2) man: ~/Documents/manual.pdf Type number(s):</p>
  153
+1) man: ~/Documents/manual.pdf <br>
  154
+2) web: www.taskwarrior.org <br>
  155
+3) ~/checklist.txt <br>
  156
+4) Notes</p>
  157
+
  158
+<p style="margin-top: 1em">Type number(s):</p>
159 159
 
160  
-<p style="margin-top: 1em">However, you can directly
161  
-address the desired annotation...</p>
  160
+<p style="margin-top: 1em">Enter the number(s) of the
  161
+annotation to open it, or any other character to abort.
  162
+Multiple selections can be opened in sequence, by entering a
  163
+comma-separated list and/or range (as in 1,3,4 or 2-4)</p>
162 164
 
163  
-<p style="margin-top: 1em">by providing taskopen with the
164  
-corresponding label:</p>
  165
+<p style="margin-top: 1em">You can use filters to directly
  166
+address the desired annotation(s)...</p>
  167
+
  168
+<p style="margin-top: 1em">by label:</p>
165 169
 
166 170
 <p style="margin-top: 1em">$ taskopen 1 \\web</p>
167 171
 
168  
-<p style="margin-top: 1em">by adding a regular
169  
-expression:</p>
  172
+<p style="margin-top: 1em">by regular expression:</p>
170 173
 
171  
-<p style="margin-top: 1em">$ taskopen 1 -m Documents</p>
  174
+<p style="margin-top: 1em">$ taskopen 1 -m Doc</p>
172 175
 
173  
-<p style="margin-top: 1em">or by adding a file type:</p>
  176
+<p style="margin-top: 1em">or by file type:</p>
174 177
 
175 178
 <p style="margin-top: 1em">$ taskopen 1 -t PDF</p>
176 179
 
  180
+<p style="margin-top: 1em">Filter options and taskwarrior
  181
+attributes can be used in any combination.</p>
  182
+
177 183
 <p style="margin-top: 1em">The -x option can be used to
178 184
 execute arbitrary commands. The decoded annotation, which
179 185
 will be a file path in most cases, will be passed as a
43  doc/man/taskopen.1
@@ -102,7 +102,7 @@ for each file and shows its output interleaved with the other output. A default
102 102
 file.
103 103
 
104 104
 .SH FILTERS
105  
-Any argument that is not considered as an option or label will be passed to taskwarrior as an
  105
+Any argument that is not recognized as an option or label will be passed to taskwarrior as an
106 106
 additional filter, i.e. any combination of taskwarrior filters can be used with taskopen. The
107 107
 default filter can be specified in the
108 108
 .I taskopenrc
@@ -162,54 +162,67 @@ $ task 1 annotate Notes
162 162
 
163 163
 you can open and edit this file by:
164 164
 .RS
165  
-$ taskopen 1
  165
+$ taskopen 1 -n
166 166
 .RE
167 167
 
168  
-which, by default, opens a file like
169  
--I "~/tasknotes/5727f1c7-2efe-fb6b-2bac-6ce073ba95ee.txt" 
170  
-with your favourite EDITOR.
  168
+which will use your default EDITOR to open a file like
  169
+.I "~/tasknotes/5727f1c7-2efe-fb6b-2bac-6ce073ba95ee.txt"
171 170
 
172 171
 .SS Multiple annotations
173 172
 You can also add weblinks to a task and even mix all kinds of annotations:
174  
-	
175 173
 .RS
176 174
 $ task 1 annotate web: www.taskwarrior.org
  175
+<<<<<<< HEAD
177 176
 $ task 1 annotate I want to consider this
178 177
 $ task 1 annotate -- man: ~/Documents/manual.pdf
  178
+=======
  179
+
  180
+$ task 1 annot I want to consider this
  181
+
  182
+$ task 1 ann man: ~/Documents/manual.pdf
  183
+>>>>>>> origin/master
179 184
 .RE
180 185
 
  186
+(note: taskopen currently works only with "link-type" annotations, so the second annot above will not be listed)
181 187
 There are various ways to open either the URI or the pdf file. If taskopen finds more than one
182  
-suitable annotation, it will output a list and ask for user interaction:
  188
+annotation matching the filter, it will output a list and ask for user interaction:
183 189
 
184 190
 .RS
185 191
 $ taskopen 1
186 192
 
187 193
 Please select an annotation:
188  
-   1) web: www.taskwarrior.org
189  
-   2) man: ~/Documents/manual.pdf
190  
-Type number(s): 
  194
+   1) man: ~/Documents/manual.pdf
  195
+   2) web: www.taskwarrior.org
  196
+   3) ~/checklist.txt
  197
+   4) Notes
  198
+
  199
+Type number(s):
191 200
 .RE
192 201
 
193  
-However, you can directly address the desired annotation...
  202
+Enter the number(s) of the annotation to open it, or any other character to abort. Multiple selections can be opened in sequence, by entering a comma-separated list and/or range (as in 1,3,4 or 2-4)
  203
+
  204
+You can use filters to directly address the desired annotation(s)...
194 205
 
195  
-by providing taskopen with the corresponding label:
  206
+by label:
196 207
 
197 208
 .RS
198 209
 $ taskopen 1 \\\\web
199 210
 .RE
200 211
 
201  
-by adding a regular expression:
  212
+by regular expression:
202 213
 
203 214
 .RS
204  
-$ taskopen 1 -m Documents
  215
+$ taskopen 1 -m Doc
205 216
 .RE
206 217
 
207  
-or by adding a file type:
  218
+or by file type:
208 219
 
209 220
 .RS
210 221
 $ taskopen 1 -t PDF
211 222
 .RE
212 223
 
  224
+Filter options and taskwarrior attributes can be used in any combination.
  225
+
213 226
 .SS Clean up annotations
214 227
 The -x option can be used to execute arbitrary commands. The decoded annotation, which will be a
215 228
 file path in most cases, will be passed as a command line argument. This enables the user to do

0 notes on commit ff14c17

Please sign in to comment.
Something went wrong with that request. Please try again.