]> git.wincent.com - docvim.git/blob - tests/fixtures/parser/integration-ferret-plugin.golden
Add parser tests to integration tests
[docvim.git] / tests / fixtures / parser / integration-ferret-plugin.golden
1 Project
2   [ DocBlock
3       [ PluginAnnotation "ferret" "Ferret plug-in for Vim"
4       , TOC
5           [ "Intro"
6           , "Installation"
7           , "Commands"
8           , "Mappings"
9           , "Options"
10           , "Custom autocommands"
11           , "Overrides"
12           , "Troubleshooting"
13           , "FAQ"
14           , "Related"
15           , "Website"
16           , "License"
17           , "Development"
18           , "Authors"
19           , "History"
20           ]
21       ]
22   , HeadingAnnotation "Intro"
23   , Blockquote
24       [ Paragraph
25           [ Plaintext "\"ferret"
26           , Whitespace
27           , Plaintext "(verb)"
28           , BreakTag
29           , Plaintext "(ferret"
30           , Whitespace
31           , Plaintext "something"
32           , Whitespace
33           , Plaintext "out)"
34           , Whitespace
35           , Plaintext "search"
36           , Whitespace
37           , Plaintext "tenaciously"
38           , Whitespace
39           , Plaintext "for"
40           , Whitespace
41           , Plaintext "and"
42           , Whitespace
43           , Plaintext "find"
44           , Whitespace
45           , Plaintext "something:"
46           , Whitespace
47           , Plaintext "she"
48           , Whitespace
49           , Plaintext "had"
50           , Whitespace
51           , Plaintext "the"
52           , Whitespace
53           , Plaintext "ability"
54           , Whitespace
55           , Plaintext "to"
56           , Whitespace
57           , Plaintext "ferret"
58           , Whitespace
59           , Plaintext "out"
60           , Whitespace
61           , Plaintext "the"
62           , Whitespace
63           , Plaintext "facts.\""
64           ]
65       ]
66   , LinkTargets [ "ferret-features" ]
67   , Paragraph
68       [ Plaintext "Ferret"
69       , Whitespace
70       , Plaintext "improves"
71       , Whitespace
72       , Plaintext "Vim's"
73       , Whitespace
74       , Plaintext "multi-file"
75       , Whitespace
76       , Plaintext "search"
77       , Whitespace
78       , Plaintext "in"
79       , Whitespace
80       , Plaintext "four"
81       , Whitespace
82       , Plaintext "ways:"
83       ]
84   , SubheadingAnnotation "1. Powerful multi-file search"
85   , Paragraph
86       [ Plaintext "Ferret"
87       , Whitespace
88       , Plaintext "provides"
89       , Whitespace
90       , Plaintext "an"
91       , Whitespace
92       , Link ":Ack"
93       , Whitespace
94       , Plaintext "command"
95       , Whitespace
96       , Plaintext "for"
97       , Whitespace
98       , Plaintext "searching"
99       , Whitespace
100       , Plaintext "across"
101       , Whitespace
102       , Plaintext "multiple"
103       , Whitespace
104       , Plaintext "files"
105       , Whitespace
106       , Plaintext "using"
107       , Whitespace
108       , Plaintext "The"
109       , Whitespace
110       , Plaintext "Silver"
111       , Whitespace
112       , Plaintext "Searcher"
113       , Whitespace
114       , Plaintext "(https://github.com/ggreer/the_silver_searcher),"
115       , Whitespace
116       , Plaintext "Ack"
117       , Whitespace
118       , Plaintext "(http://beyondgrep.com/),"
119       , Whitespace
120       , Plaintext "or"
121       , Whitespace
122       , Plaintext "Grep"
123       , Whitespace
124       , Plaintext "(http://www.gnu.org/software/grep/)."
125       , Whitespace
126       , Plaintext "Support"
127       , Whitespace
128       , Plaintext "for"
129       , Whitespace
130       , Plaintext "passing"
131       , Whitespace
132       , Plaintext "options"
133       , Whitespace
134       , Plaintext "through"
135       , Whitespace
136       , Plaintext "to"
137       , Whitespace
138       , Plaintext "the"
139       , Whitespace
140       , Plaintext "underlying"
141       , Whitespace
142       , Plaintext "search"
143       , Whitespace
144       , Plaintext "command"
145       , Whitespace
146       , Plaintext "exists,"
147       , Whitespace
148       , Plaintext "along"
149       , Whitespace
150       , Plaintext "with"
151       , Whitespace
152       , Plaintext "the"
153       , Whitespace
154       , Plaintext "ability"
155       , Whitespace
156       , Plaintext "to"
157       , Whitespace
158       , Plaintext "use"
159       , Whitespace
160       , Plaintext "full"
161       , Whitespace
162       , Plaintext "regular"
163       , Whitespace
164       , Plaintext "expression"
165       , Whitespace
166       , Plaintext "syntax"
167       , Whitespace
168       , Plaintext "without"
169       , Whitespace
170       , Plaintext "doing"
171       , Whitespace
172       , Plaintext "special"
173       , Whitespace
174       , Plaintext "escaping."
175       ]
176   , Paragraph
177       [ Plaintext "Shortcut"
178       , Whitespace
179       , Plaintext "mappings"
180       , Whitespace
181       , Plaintext "are"
182       , Whitespace
183       , Plaintext "provided"
184       , Whitespace
185       , Plaintext "to"
186       , Whitespace
187       , Plaintext "start"
188       , Whitespace
189       , Plaintext "an"
190       , Whitespace
191       , Link ":Ack"
192       , Whitespace
193       , Plaintext "search"
194       , Whitespace
195       , Plaintext "(<leader>a)"
196       , Whitespace
197       , Plaintext "or"
198       , Whitespace
199       , Plaintext "to"
200       , Whitespace
201       , Plaintext "search"
202       , Whitespace
203       , Plaintext "for"
204       , Whitespace
205       , Plaintext "the"
206       , Whitespace
207       , Plaintext "word"
208       , Whitespace
209       , Plaintext "currently"
210       , Whitespace
211       , Plaintext "under"
212       , Whitespace
213       , Plaintext "the"
214       , Whitespace
215       , Plaintext "cursor"
216       , Whitespace
217       , Plaintext "(<leader>s)."
218       ]
219   , Paragraph
220       [ Plaintext "Results"
221       , Whitespace
222       , Plaintext "are"
223       , Whitespace
224       , Plaintext "normally"
225       , Whitespace
226       , Plaintext "displayed"
227       , Whitespace
228       , Plaintext "in"
229       , Whitespace
230       , Plaintext "the"
231       , Whitespace
232       , Link "quickfix"
233       , Whitespace
234       , Plaintext "window,"
235       , Whitespace
236       , Plaintext "but"
237       , Whitespace
238       , Plaintext "Ferret"
239       , Whitespace
240       , Plaintext "also"
241       , Whitespace
242       , Plaintext "provides"
243       , Whitespace
244       , Plaintext "a"
245       , Whitespace
246       , Link ":Lack"
247       , Whitespace
248       , Plaintext "command"
249       , Whitespace
250       , Plaintext "that"
251       , Whitespace
252       , Plaintext "behaves"
253       , Whitespace
254       , Plaintext "like"
255       , Whitespace
256       , Link ":Ack"
257       , Whitespace
258       , Plaintext "but"
259       , Whitespace
260       , Plaintext "uses"
261       , Whitespace
262       , Plaintext "the"
263       , Whitespace
264       , Link "location-list"
265       , Whitespace
266       , Plaintext "instead,"
267       , Whitespace
268       , Plaintext "and"
269       , Whitespace
270       , Plaintext "a"
271       , Whitespace
272       , Plaintext "<leader>l"
273       , Whitespace
274       , Plaintext "mapping"
275       , Whitespace
276       , Plaintext "as"
277       , Whitespace
278       , Plaintext "a"
279       , Whitespace
280       , Plaintext "shortcut"
281       , Whitespace
282       , Plaintext "to"
283       , Whitespace
284       , Link ":Lack"
285       , Plaintext "."
286       ]
287   , Paragraph
288       [ Plaintext "Finally,"
289       , Whitespace
290       , Plaintext "Ferret"
291       , Whitespace
292       , Plaintext "offers"
293       , Whitespace
294       , Plaintext "integration"
295       , Whitespace
296       , Plaintext "with"
297       , Whitespace
298       , Plaintext "dispatch.vim"
299       , Whitespace
300       , Plaintext "(https://github.com/tpope/vim-dispatch),"
301       , Whitespace
302       , Plaintext "which"
303       , Whitespace
304       , Plaintext "enables"
305       , Whitespace
306       , Plaintext "asynchronous"
307       , Whitespace
308       , Plaintext "searching"
309       , Whitespace
310       , Plaintext "despite"
311       , Whitespace
312       , Plaintext "the"
313       , Whitespace
314       , Plaintext "fact"
315       , Whitespace
316       , Plaintext "that"
317       , Whitespace
318       , Plaintext "Vim"
319       , Whitespace
320       , Plaintext "itself"
321       , Whitespace
322       , Plaintext "is"
323       , Whitespace
324       , Plaintext "single-threaded."
325       ]
326   , SubheadingAnnotation "2. Streamlined multi-file replace"
327   , Paragraph
328       [ Plaintext "The"
329       , Whitespace
330       , Plaintext "companion"
331       , Whitespace
332       , Plaintext "to"
333       , Whitespace
334       , Link ":Ack"
335       , Whitespace
336       , Plaintext "is"
337       , Whitespace
338       , Link ":Acks"
339       , Whitespace
340       , Plaintext "(mnemonic:"
341       , Whitespace
342       , Plaintext "\"Ack"
343       , Whitespace
344       , Plaintext "substitute\","
345       , Whitespace
346       , Plaintext "accessible"
347       , Whitespace
348       , Plaintext "via"
349       , Whitespace
350       , Plaintext "shortcut"
351       , Whitespace
352       , Plaintext "<leader>r),"
353       , Whitespace
354       , Plaintext "which"
355       , Whitespace
356       , Plaintext "allows"
357       , Whitespace
358       , Plaintext "you"
359       , Whitespace
360       , Plaintext "to"
361       , Whitespace
362       , Plaintext "run"
363       , Whitespace
364       , Plaintext "a"
365       , Whitespace
366       , Plaintext "multi-file"
367       , Whitespace
368       , Plaintext "replace"
369       , Whitespace
370       , Plaintext "across"
371       , Whitespace
372       , Plaintext "all"
373       , Whitespace
374       , Plaintext "the"
375       , Whitespace
376       , Plaintext "files"
377       , Whitespace
378       , Plaintext "placed"
379       , Whitespace
380       , Plaintext "in"
381       , Whitespace
382       , Plaintext "the"
383       , Whitespace
384       , Link "quickfix"
385       , Whitespace
386       , Plaintext "window"
387       , Whitespace
388       , Plaintext "by"
389       , Whitespace
390       , Plaintext "a"
391       , Whitespace
392       , Plaintext "previous"
393       , Whitespace
394       , Plaintext "invocation"
395       , Whitespace
396       , Plaintext "of"
397       , Whitespace
398       , Link ":Ack"
399       , Plaintext "."
400       ]
401   , SubheadingAnnotation "3. Quickfix listing enhancements"
402   , Paragraph
403       [ Plaintext "The"
404       , Whitespace
405       , Link "quickfix"
406       , Whitespace
407       , Plaintext "listing"
408       , Whitespace
409       , Plaintext "itself"
410       , Whitespace
411       , Plaintext "is"
412       , Whitespace
413       , Plaintext "enhanced"
414       , Whitespace
415       , Plaintext "with"
416       , Whitespace
417       , Plaintext "settings"
418       , Whitespace
419       , Plaintext "to"
420       , Whitespace
421       , Plaintext "improve"
422       , Whitespace
423       , Plaintext "its"
424       , Whitespace
425       , Plaintext "usability,"
426       , Whitespace
427       , Plaintext "and"
428       , Whitespace
429       , Plaintext "natural"
430       , Whitespace
431       , Plaintext "mappings"
432       , Whitespace
433       , Plaintext "that"
434       , Whitespace
435       , Plaintext "allow"
436       , Whitespace
437       , Plaintext "quick"
438       , Whitespace
439       , Plaintext "removal"
440       , Whitespace
441       , Plaintext "of"
442       , Whitespace
443       , Plaintext "items"
444       , Whitespace
445       , Plaintext "from"
446       , Whitespace
447       , Plaintext "the"
448       , Whitespace
449       , Plaintext "list"
450       , Whitespace
451       , Plaintext "(for"
452       , Whitespace
453       , Plaintext "example,"
454       , Whitespace
455       , Plaintext "you"
456       , Whitespace
457       , Plaintext "can"
458       , Whitespace
459       , Plaintext "reduce"
460       , Whitespace
461       , Plaintext "clutter"
462       , Whitespace
463       , Plaintext "in"
464       , Whitespace
465       , Plaintext "the"
466       , Whitespace
467       , Plaintext "listing"
468       , Whitespace
469       , Plaintext "by"
470       , Whitespace
471       , Plaintext "removing"
472       , Whitespace
473       , Plaintext "lines"
474       , Whitespace
475       , Plaintext "that"
476       , Whitespace
477       , Plaintext "you"
478       , Whitespace
479       , Plaintext "don't"
480       , Whitespace
481       , Plaintext "intend"
482       , Whitespace
483       , Plaintext "to"
484       , Whitespace
485       , Plaintext "make"
486       , Whitespace
487       , Plaintext "changes"
488       , Whitespace
489       , Plaintext "to)."
490       ]
491   , Paragraph
492       [ Plaintext "Additionally,"
493       , Whitespace
494       , Plaintext "Vim's"
495       , Whitespace
496       , Link ":cn"
497       , Plaintext ","
498       , Whitespace
499       , Link ":cp"
500       , Plaintext ","
501       , Whitespace
502       , Link ":cnf"
503       , Whitespace
504       , Plaintext "and"
505       , Whitespace
506       , Link ":cpf"
507       , Whitespace
508       , Plaintext "commands"
509       , Whitespace
510       , Plaintext "are"
511       , Whitespace
512       , Plaintext "tweaked"
513       , Whitespace
514       , Plaintext "to"
515       , Whitespace
516       , Plaintext "make"
517       , Whitespace
518       , Plaintext "it"
519       , Whitespace
520       , Plaintext "easier"
521       , Whitespace
522       , Plaintext "to"
523       , Whitespace
524       , Plaintext "immediately"
525       , Whitespace
526       , Plaintext "identify"
527       , Whitespace
528       , Plaintext "matches"
529       , Whitespace
530       , Plaintext "by"
531       , Whitespace
532       , Plaintext "centering"
533       , Whitespace
534       , Plaintext "them"
535       , Whitespace
536       , Plaintext "within"
537       , Whitespace
538       , Plaintext "the"
539       , Whitespace
540       , Plaintext "viewport."
541       ]
542   , SubheadingAnnotation
543       "4. Easy operations on files in the quickfix listing"
544   , Paragraph
545       [ Plaintext "Finally,"
546       , Whitespace
547       , Plaintext "Ferret"
548       , Whitespace
549       , Plaintext "provides"
550       , Whitespace
551       , Plaintext "a"
552       , Whitespace
553       , Link ":Qargs"
554       , Whitespace
555       , Plaintext "command"
556       , Whitespace
557       , Plaintext "that"
558       , Whitespace
559       , Plaintext "puts"
560       , Whitespace
561       , Plaintext "the"
562       , Whitespace
563       , Plaintext "files"
564       , Whitespace
565       , Plaintext "currently"
566       , Whitespace
567       , Plaintext "in"
568       , Whitespace
569       , Plaintext "the"
570       , Whitespace
571       , Link "quickfix"
572       , Whitespace
573       , Plaintext "listing"
574       , Whitespace
575       , Plaintext "into"
576       , Whitespace
577       , Plaintext "the"
578       , Whitespace
579       , Link ":args"
580       , Whitespace
581       , Plaintext "list,"
582       , Whitespace
583       , Plaintext "where"
584       , Whitespace
585       , Plaintext "they"
586       , Whitespace
587       , Plaintext "can"
588       , Whitespace
589       , Plaintext "be"
590       , Whitespace
591       , Plaintext "operated"
592       , Whitespace
593       , Plaintext "on"
594       , Whitespace
595       , Plaintext "in"
596       , Whitespace
597       , Plaintext "bulk"
598       , Whitespace
599       , Plaintext "via"
600       , Whitespace
601       , Plaintext "the"
602       , Whitespace
603       , Link ":argdo"
604       , Whitespace
605       , Plaintext "command."
606       , Whitespace
607       , Plaintext "This"
608       , Whitespace
609       , Plaintext "is"
610       , Whitespace
611       , Plaintext "what's"
612       , Whitespace
613       , Plaintext "used"
614       , Whitespace
615       , Plaintext "under"
616       , Whitespace
617       , Plaintext "the"
618       , Whitespace
619       , Plaintext "covers"
620       , Whitespace
621       , Plaintext "by"
622       , Whitespace
623       , Link ":Acks"
624       , Whitespace
625       , Plaintext "to"
626       , Whitespace
627       , Plaintext "do"
628       , Whitespace
629       , Plaintext "its"
630       , Whitespace
631       , Plaintext "work."
632       ]
633   , HeadingAnnotation "Installation"
634   , Paragraph
635       [ Plaintext "To"
636       , Whitespace
637       , Plaintext "install"
638       , Whitespace
639       , Plaintext "Ferret,"
640       , Whitespace
641       , Plaintext "use"
642       , Whitespace
643       , Plaintext "your"
644       , Whitespace
645       , Plaintext "plug-in"
646       , Whitespace
647       , Plaintext "management"
648       , Whitespace
649       , Plaintext "system"
650       , Whitespace
651       , Plaintext "of"
652       , Whitespace
653       , Plaintext "choice."
654       ]
655   , Paragraph
656       [ Plaintext "If"
657       , Whitespace
658       , Plaintext "you"
659       , Whitespace
660       , Plaintext "don't"
661       , Whitespace
662       , Plaintext "have"
663       , Whitespace
664       , Plaintext "a"
665       , Whitespace
666       , Plaintext "\"plug-in"
667       , Whitespace
668       , Plaintext "management"
669       , Whitespace
670       , Plaintext "system"
671       , Whitespace
672       , Plaintext "of"
673       , Whitespace
674       , Plaintext "choice\","
675       , Whitespace
676       , Plaintext "I"
677       , Whitespace
678       , Plaintext "recommend"
679       , Whitespace
680       , Plaintext "Pathogen"
681       , Whitespace
682       , Plaintext "(https://github.com/tpope/vim-pathogen)"
683       , Whitespace
684       , Plaintext "due"
685       , Whitespace
686       , Plaintext "to"
687       , Whitespace
688       , Plaintext "its"
689       , Whitespace
690       , Plaintext "simplicity"
691       , Whitespace
692       , Plaintext "and"
693       , Whitespace
694       , Plaintext "robustness."
695       , Whitespace
696       , Plaintext "Assuming"
697       , Whitespace
698       , Plaintext "that"
699       , Whitespace
700       , Plaintext "you"
701       , Whitespace
702       , Plaintext "have"
703       , Whitespace
704       , Plaintext "Pathogen"
705       , Whitespace
706       , Plaintext "installed"
707       , Whitespace
708       , Plaintext "and"
709       , Whitespace
710       , Plaintext "configured,"
711       , Whitespace
712       , Plaintext "and"
713       , Whitespace
714       , Plaintext "that"
715       , Whitespace
716       , Plaintext "you"
717       , Whitespace
718       , Plaintext "want"
719       , Whitespace
720       , Plaintext "to"
721       , Whitespace
722       , Plaintext "install"
723       , Whitespace
724       , Plaintext "Ferret"
725       , Whitespace
726       , Plaintext "into"
727       , Whitespace
728       , Code "~/.vim/bundle"
729       , Plaintext ","
730       , Whitespace
731       , Plaintext "you"
732       , Whitespace
733       , Plaintext "can"
734       , Whitespace
735       , Plaintext "do"
736       , Whitespace
737       , Plaintext "so"
738       , Whitespace
739       , Plaintext "with:"
740       ]
741   , Fenced
742       [ "git clone https://github.com/wincent/ferret.git ~/.vim/bundle/ferret"
743       ]
744   , Paragraph
745       [ Plaintext "Alternatively,"
746       , Whitespace
747       , Plaintext "if"
748       , Whitespace
749       , Plaintext "you"
750       , Whitespace
751       , Plaintext "use"
752       , Whitespace
753       , Plaintext "a"
754       , Whitespace
755       , Plaintext "Git"
756       , Whitespace
757       , Plaintext "submodule"
758       , Whitespace
759       , Plaintext "for"
760       , Whitespace
761       , Plaintext "each"
762       , Whitespace
763       , Plaintext "Vim"
764       , Whitespace
765       , Plaintext "plug-in,"
766       , Whitespace
767       , Plaintext "you"
768       , Whitespace
769       , Plaintext "could"
770       , Whitespace
771       , Plaintext "do"
772       , Whitespace
773       , Plaintext "the"
774       , Whitespace
775       , Plaintext "following"
776       , Whitespace
777       , Plaintext "after"
778       , Whitespace
779       , Code "cd"
780       , Plaintext "-ing"
781       , Whitespace
782       , Plaintext "into"
783       , Whitespace
784       , Plaintext "the"
785       , Whitespace
786       , Plaintext "top-level"
787       , Whitespace
788       , Plaintext "of"
789       , Whitespace
790       , Plaintext "your"
791       , Whitespace
792       , Plaintext "Git"
793       , Whitespace
794       , Plaintext "superproject:"
795       ]
796   , Fenced
797       [ "git submodule add https://github.com/wincent/ferret.git ~/vim/bundle/ferret"
798       , "git submodule init"
799       ]
800   , Paragraph
801       [ Plaintext "To"
802       , Whitespace
803       , Plaintext "generate"
804       , Whitespace
805       , Plaintext "help"
806       , Whitespace
807       , Plaintext "tags"
808       , Whitespace
809       , Plaintext "under"
810       , Whitespace
811       , Plaintext "Pathogen,"
812       , Whitespace
813       , Plaintext "you"
814       , Whitespace
815       , Plaintext "can"
816       , Whitespace
817       , Plaintext "do"
818       , Whitespace
819       , Plaintext "so"
820       , Whitespace
821       , Plaintext "from"
822       , Whitespace
823       , Plaintext "inside"
824       , Whitespace
825       , Plaintext "Vim"
826       , Whitespace
827       , Plaintext "with:"
828       ]
829   , Fenced [ ":call pathogen#helptags()" ]
830   , Project
831       [ Unit
832           [ GenericStatement
833               "if exists('g:FerretLoaded') || &compatible || v:version < 700"
834           , GenericStatement "finish"
835           , GenericStatement "endif"
836           , LetStatement { letLexpr = "g:FerretLoaded " , letValue = "1" }
837           , LetStatement
838               { letLexpr = "s:cpoptions " , letValue = "&cpoptions" }
839           , GenericStatement "set cpoptions&vim"
840           , GenericStatement
841               "if executable('ag') \" The Silver Searcher: faster than ack."
842           , LetStatement
843               { letLexpr = "s:ackprg "
844               , letValue = "'ag --column --nocolor --nogroup'"
845               }
846           , GenericStatement
847               "elseif executable('ack') \" Ack: better than grep."
848           , LetStatement
849               { letLexpr = "s:ackprg " , letValue = "'ack --column'" }
850           , GenericStatement
851               "elseif executable('grep') \" Grep: it's just grep."
852           , LetStatement
853               { letLexpr = "s:ackprg "
854               , letValue = "&grepprg \" default is: grep -n $* /dev/null"
855               }
856           , GenericStatement "endif"
857           , GenericStatement "if !empty(s:ackprg)"
858           , LetStatement { letLexpr = "&grepprg" , letValue = "s:ackprg" }
859           , GenericStatement "set grepformat=%f:%l:%c:%m"
860           , GenericStatement "endif"
861           , GenericStatement "if has('autocmd')"
862           , GenericStatement "augroup Ferret"
863           , GenericStatement "autocmd!"
864           , GenericStatement "autocmd QuickFixCmdPost [^l]* nested cwindow"
865           , GenericStatement "autocmd QuickFixCmdPost l* nested lwindow"
866           , GenericStatement "augroup END"
867           , GenericStatement "endif"
868           , GenericStatement
869               "command! -nargs=+ -complete=file Ack call ferret#private#ack(<q-args>)"
870           , GenericStatement
871               "command! -nargs=+ -complete=file Lack call ferret#private#lack(<q-args>)"
872           , GenericStatement
873               "command! -nargs=1 Acks call ferret#private#acks(<q-args>)"
874           , LetStatement
875               { letLexpr = "s:map" , letValue = "get(g:, 'FerretMap', 1)" }
876           , GenericStatement "if s:map"
877           , GenericStatement
878               "if !hasmapto('<Plug>(FerretAck)') && maparg('<leader>a', 'n') ==# ''"
879           , GenericStatement "nmap <unique> <leader>a <Plug>(FerretAck)"
880           , GenericStatement "endif"
881           , GenericStatement "nnoremap <Plug>(FerretAck) :Ack<space>"
882           , GenericStatement
883               "if !hasmapto('<Plug>FerretLack') && maparg('<leader>l', 'n') ==# ''"
884           , GenericStatement "nmap <unique> <leader>l <Plug>(FerretLack)"
885           , GenericStatement "endif"
886           , GenericStatement "nnoremap <Plug>(FerretLack) :Lack<space>"
887           , GenericStatement
888               "if !hasmapto('<Plug>(FerretAckWord)') && maparg('<leader>s', 'n') ==# ''"
889           , GenericStatement "nmap <unique> <leader>s <Plug>(FerretAckWord)"
890           , GenericStatement "endif"
891           , GenericStatement
892               "nnoremap <Plug>(FerretAckWord) :Ack <C-r><C-w><CR>"
893           , GenericStatement
894               "if !hasmapto('<Plug>(FerretAcks)') && maparg('<leader>r', 'n') ==# ''"
895           , GenericStatement "nmap <unique> <leader>r <Plug>(FerretAcks)"
896           , GenericStatement "endif"
897           , GenericStatement
898               "nnoremap <Plug>(FerretAcks) :Acks <c-r>=(exists('g:ferret_lastsearch') ? '/' . g:ferret_lastsearch . '//' : ' ')<CR><Left>"
899           , GenericStatement "endif"
900           , GenericStatement
901               "command! -bar Qargs execute 'args' ferret#private#qargs()"
902           , LetStatement
903               { letLexpr = "s:commands"
904               , letValue = "get(g:, 'FerretQFCommands', 1)"
905               }
906           , GenericStatement "if s:commands"
907           , GenericStatement
908               "cabbrev <silent> <expr> cn ((getcmdtype() == ':' && getcmdpos() == 3) ? 'cn <bar> normal zz' : 'cn')"
909           , GenericStatement
910               "cabbrev <silent> <expr> cnf ((getcmdtype() == ':' && getcmdpos() == 4) ? 'cnf <bar> normal zz' : 'cnf')"
911           , GenericStatement
912               "cabbrev <silent> <expr> cp ((getcmdtype() == ':' && getcmdpos() == 3) ? 'cp <bar> normal zz' : 'cp')"
913           , GenericStatement
914               "cabbrev <silent> <expr> cpf ((getcmdtype() == ':' && getcmdpos() == 4) ? 'cpf <bar> normal zz' : 'cpf')"
915           , GenericStatement "endif"
916           , LetStatement
917               { letLexpr = "&cpoptions " , letValue = "s:cpoptions" }
918           , UnletStatement { unletBang = False , unletBody = "s:cpoptions" }
919           ]
920       ]
921   , CommandsAnnotation
922   , CommandAnnotation "Ack" (Just "{pattern} {options}")
923   , Paragraph
924       [ Plaintext "Searches"
925       , Whitespace
926       , Plaintext "for"
927       , Whitespace
928       , Plaintext "{pattern}"
929       , Whitespace
930       , Plaintext "in"
931       , Whitespace
932       , Plaintext "all"
933       , Whitespace
934       , Plaintext "the"
935       , Whitespace
936       , Plaintext "files"
937       , Whitespace
938       , Plaintext "under"
939       , Whitespace
940       , Plaintext "the"
941       , Whitespace
942       , Plaintext "current"
943       , Whitespace
944       , Plaintext "directory"
945       , Whitespace
946       , Plaintext "(see"
947       , Whitespace
948       , Link ":pwd"
949       , Plaintext "),"
950       , Whitespace
951       , Plaintext "unless"
952       , Whitespace
953       , Plaintext "otherwise"
954       , Whitespace
955       , Plaintext "overridden"
956       , Whitespace
957       , Plaintext "via"
958       , Whitespace
959       , Plaintext "{options},"
960       , Whitespace
961       , Plaintext "and"
962       , Whitespace
963       , Plaintext "displays"
964       , Whitespace
965       , Plaintext "the"
966       , Whitespace
967       , Plaintext "results"
968       , Whitespace
969       , Plaintext "in"
970       , Whitespace
971       , Plaintext "the"
972       , Whitespace
973       , Link "quickfix"
974       , Whitespace
975       , Plaintext "listing."
976       ]
977   , Paragraph
978       [ Code "ag"
979       , Whitespace
980       , Plaintext "(The"
981       , Whitespace
982       , Plaintext "Silver"
983       , Whitespace
984       , Plaintext "Searcher)"
985       , Whitespace
986       , Plaintext "will"
987       , Whitespace
988       , Plaintext "be"
989       , Whitespace
990       , Plaintext "used"
991       , Whitespace
992       , Plaintext "preferentially"
993       , Whitespace
994       , Plaintext "if"
995       , Whitespace
996       , Plaintext "present"
997       , Whitespace
998       , Plaintext "on"
999       , Whitespace
1000       , Plaintext "the"
1001       , Whitespace
1002       , Plaintext "system,"
1003       , Whitespace
1004       , Plaintext "because"
1005       , Whitespace
1006       , Plaintext "it"
1007       , Whitespace
1008       , Plaintext "is"
1009       , Whitespace
1010       , Plaintext "faster,"
1011       , Whitespace
1012       , Plaintext "falling"
1013       , Whitespace
1014       , Plaintext "back"
1015       , Whitespace
1016       , Plaintext "to"
1017       , Whitespace
1018       , Code "ack"
1019       , Whitespace
1020       , Plaintext "and"
1021       , Whitespace
1022       , Plaintext "then"
1023       , Whitespace
1024       , Code "grep"
1025       , Whitespace
1026       , Plaintext "as"
1027       , Whitespace
1028       , Plaintext "needed."
1029       ]
1030   , Paragraph
1031       [ Plaintext "If"
1032       , Whitespace
1033       , Plaintext "dispatch.vim"
1034       , Whitespace
1035       , Plaintext "is"
1036       , Whitespace
1037       , Plaintext "installed"
1038       , Whitespace
1039       , Plaintext "the"
1040       , Whitespace
1041       , Plaintext "search"
1042       , Whitespace
1043       , Plaintext "process"
1044       , Whitespace
1045       , Plaintext "will"
1046       , Whitespace
1047       , Plaintext "run"
1048       , Whitespace
1049       , Plaintext "asynchronously"
1050       , Whitespace
1051       , Plaintext "via"
1052       , Whitespace
1053       , Plaintext "the"
1054       , Whitespace
1055       , Link ":Make"
1056       , Whitespace
1057       , Plaintext "command,"
1058       , Whitespace
1059       , Plaintext "otherwise"
1060       , Whitespace
1061       , Plaintext "it"
1062       , Whitespace
1063       , Plaintext "will"
1064       , Whitespace
1065       , Plaintext "be"
1066       , Whitespace
1067       , Plaintext "run"
1068       , Whitespace
1069       , Plaintext "synchronously"
1070       , Whitespace
1071       , Plaintext "via"
1072       , Whitespace
1073       , Link ":cexpr"
1074       , Plaintext "."
1075       , Whitespace
1076       , Plaintext "Asynchronous"
1077       , Whitespace
1078       , Plaintext "searches"
1079       , Whitespace
1080       , Plaintext "are"
1081       , Whitespace
1082       , Plaintext "preferred"
1083       , Whitespace
1084       , Plaintext "because"
1085       , Whitespace
1086       , Plaintext "they"
1087       , Whitespace
1088       , Plaintext "do"
1089       , Whitespace
1090       , Plaintext "not"
1091       , Whitespace
1092       , Plaintext "block,"
1093       , Whitespace
1094       , Plaintext "despite"
1095       , Whitespace
1096       , Plaintext "the"
1097       , Whitespace
1098       , Plaintext "fact"
1099       , Whitespace
1100       , Plaintext "that"
1101       , Whitespace
1102       , Plaintext "Vim"
1103       , Whitespace
1104       , Plaintext "itself"
1105       , Whitespace
1106       , Plaintext "is"
1107       , Whitespace
1108       , Plaintext "single"
1109       , Whitespace
1110       , Plaintext "threaded."
1111       , Whitespace
1112       , Plaintext "The"
1113       , Whitespace
1114       , Link "g:FerretDispatch"
1115       , Whitespace
1116       , Plaintext "option"
1117       , Whitespace
1118       , Plaintext "can"
1119       , Whitespace
1120       , Plaintext "be"
1121       , Whitespace
1122       , Plaintext "used"
1123       , Whitespace
1124       , Plaintext "to"
1125       , Whitespace
1126       , Plaintext "prevent"
1127       , Whitespace
1128       , Plaintext "the"
1129       , Whitespace
1130       , Plaintext "use"
1131       , Whitespace
1132       , Plaintext "of"
1133       , Whitespace
1134       , Plaintext "dispatch.vim."
1135       ]
1136   , Paragraph
1137       [ Plaintext "The"
1138       , Whitespace
1139       , Plaintext "{pattern}"
1140       , Whitespace
1141       , Plaintext "is"
1142       , Whitespace
1143       , Plaintext "passed"
1144       , Whitespace
1145       , Plaintext "through"
1146       , Whitespace
1147       , Plaintext "as-is"
1148       , Whitespace
1149       , Plaintext "to"
1150       , Whitespace
1151       , Plaintext "the"
1152       , Whitespace
1153       , Plaintext "underlying"
1154       , Whitespace
1155       , Plaintext "search"
1156       , Whitespace
1157       , Plaintext "program,"
1158       , Whitespace
1159       , Plaintext "and"
1160       , Whitespace
1161       , Plaintext "no"
1162       , Whitespace
1163       , Plaintext "escaping"
1164       , Whitespace
1165       , Plaintext "is"
1166       , Whitespace
1167       , Plaintext "required"
1168       , Whitespace
1169       , Plaintext "other"
1170       , Whitespace
1171       , Plaintext "than"
1172       , Whitespace
1173       , Plaintext "preceding"
1174       , Whitespace
1175       , Plaintext "spaces"
1176       , Whitespace
1177       , Plaintext "by"
1178       , Whitespace
1179       , Plaintext "a"
1180       , Whitespace
1181       , Plaintext "single"
1182       , Whitespace
1183       , Plaintext "backslash."
1184       , Whitespace
1185       , Plaintext "For"
1186       , Whitespace
1187       , Plaintext "example,"
1188       , Whitespace
1189       , Plaintext "to"
1190       , Whitespace
1191       , Plaintext "search"
1192       , Whitespace
1193       , Plaintext "for"
1194       , Whitespace
1195       , Plaintext "\"\\bfoo[0-9]{2}"
1196       , Whitespace
1197       , Plaintext "bar\\b\""
1198       , Whitespace
1199       , Plaintext "(ie."
1200       , Whitespace
1201       , Plaintext "using"
1202       , Whitespace
1203       , Code "ag"
1204       , Plaintext "'s"
1205       , Whitespace
1206       , Plaintext "Perl-style"
1207       , Whitespace
1208       , Plaintext "regular"
1209       , Whitespace
1210       , Plaintext "expression"
1211       , Whitespace
1212       , Plaintext "syntax),"
1213       , Whitespace
1214       , Plaintext "you"
1215       , Whitespace
1216       , Plaintext "could"
1217       , Whitespace
1218       , Plaintext "do:"
1219       ]
1220   , Fenced [ ":Ack \\bfoo[0-9]{2}\\ bar\\b" ]
1221   , Paragraph
1222       [ Plaintext "Likewise,"
1223       , Whitespace
1224       , Plaintext "{options}"
1225       , Whitespace
1226       , Plaintext "are"
1227       , Whitespace
1228       , Plaintext "passed"
1229       , Whitespace
1230       , Plaintext "through."
1231       , Whitespace
1232       , Plaintext "In"
1233       , Whitespace
1234       , Plaintext "this"
1235       , Whitespace
1236       , Plaintext "example,"
1237       , Whitespace
1238       , Plaintext "we"
1239       , Whitespace
1240       , Plaintext "pass"
1241       , Whitespace
1242       , Plaintext "the"
1243       , Whitespace
1244       , Code "-w"
1245       , Whitespace
1246       , Plaintext "option"
1247       , Whitespace
1248       , Plaintext "(to"
1249       , Whitespace
1250       , Plaintext "search"
1251       , Whitespace
1252       , Plaintext "on"
1253       , Whitespace
1254       , Plaintext "word"
1255       , Whitespace
1256       , Plaintext "boundaries),"
1257       , Whitespace
1258       , Plaintext "and"
1259       , Whitespace
1260       , Plaintext "scope"
1261       , Whitespace
1262       , Plaintext "the"
1263       , Whitespace
1264       , Plaintext "search"
1265       , Whitespace
1266       , Plaintext "to"
1267       , Whitespace
1268       , Plaintext "the"
1269       , Whitespace
1270       , Plaintext "\"foo\""
1271       , Whitespace
1272       , Plaintext "and"
1273       , Whitespace
1274       , Plaintext "\"bar\""
1275       , Whitespace
1276       , Plaintext "subdirectories:"
1277       , Whitespace
1278       , Plaintext ">"
1279       ]
1280   , Fenced [ ":Ack -w something foo bar" ]
1281   , Paragraph
1282       [ Plaintext "As"
1283       , Whitespace
1284       , Plaintext "a"
1285       , Whitespace
1286       , Plaintext "convenience"
1287       , Whitespace
1288       , Plaintext "<leader>a"
1289       , Whitespace
1290       , Plaintext "is"
1291       , Whitespace
1292       , Plaintext "set-up"
1293       , Whitespace
1294       , Plaintext "("
1295       , Link "<Plug>(FerretAck)"
1296       , Plaintext ")"
1297       , Whitespace
1298       , Plaintext "as"
1299       , Whitespace
1300       , Plaintext "a"
1301       , Whitespace
1302       , Plaintext "shortcut"
1303       , Whitespace
1304       , Plaintext "to"
1305       , Whitespace
1306       , Plaintext "enter"
1307       , Whitespace
1308       , Link "Cmdline-mode"
1309       , Whitespace
1310       , Plaintext "with"
1311       , Whitespace
1312       , Code ":Ack"
1313       , Whitespace
1314       , Plaintext "inserted"
1315       , Whitespace
1316       , Plaintext "on"
1317       , Whitespace
1318       , Plaintext "the"
1319       , Whitespace
1320       , Link "Cmdline"
1321       , Plaintext "."
1322       , Whitespace
1323       , Plaintext "Likewise"
1324       , Whitespace
1325       , Plaintext "<leader>s"
1326       , Whitespace
1327       , Plaintext "("
1328       , Link "<Plug>(FerretAckWord)"
1329       , Plaintext ")"
1330       , Whitespace
1331       , Plaintext "is"
1332       , Whitespace
1333       , Plaintext "a"
1334       , Whitespace
1335       , Plaintext "shortcut"
1336       , Whitespace
1337       , Plaintext "for"
1338       , Whitespace
1339       , Plaintext "running"
1340       , Whitespace
1341       , Link ":Ack"
1342       , Whitespace
1343       , Plaintext "with"
1344       , Whitespace
1345       , Plaintext "the"
1346       , Whitespace
1347       , Plaintext "word"
1348       , Whitespace
1349       , Plaintext "currently"
1350       , Whitespace
1351       , Plaintext "under"
1352       , Whitespace
1353       , Plaintext "the"
1354       , Whitespace
1355       , Plaintext "cursor."
1356       ]
1357   , CommandAnnotation "Lack" (Just "{pattern} {options}")
1358   , Paragraph
1359       [ Plaintext "Just"
1360       , Whitespace
1361       , Plaintext "like"
1362       , Whitespace
1363       , Link ":Ack"
1364       , Plaintext ","
1365       , Whitespace
1366       , Plaintext "but"
1367       , Whitespace
1368       , Plaintext "instead"
1369       , Whitespace
1370       , Plaintext "of"
1371       , Whitespace
1372       , Plaintext "using"
1373       , Whitespace
1374       , Plaintext "the"
1375       , Whitespace
1376       , Link "quickfix"
1377       , Whitespace
1378       , Plaintext "listing,"
1379       , Whitespace
1380       , Plaintext "which"
1381       , Whitespace
1382       , Plaintext "is"
1383       , Whitespace
1384       , Plaintext "global"
1385       , Whitespace
1386       , Plaintext "across"
1387       , Whitespace
1388       , Plaintext "an"
1389       , Whitespace
1390       , Plaintext "entire"
1391       , Whitespace
1392       , Plaintext "Vim"
1393       , Whitespace
1394       , Plaintext "instance,"
1395       , Whitespace
1396       , Plaintext "it"
1397       , Whitespace
1398       , Plaintext "uses"
1399       , Whitespace
1400       , Plaintext "the"
1401       , Whitespace
1402       , Link "location-list"
1403       , Plaintext ","
1404       , Whitespace
1405       , Plaintext "which"
1406       , Whitespace
1407       , Plaintext "is"
1408       , Whitespace
1409       , Plaintext "a"
1410       , Whitespace
1411       , Plaintext "per-window"
1412       , Whitespace
1413       , Plaintext "construct."
1414       ]
1415   , Paragraph
1416       [ Plaintext "Note"
1417       , Whitespace
1418       , Plaintext "that"
1419       , Whitespace
1420       , Link ":Lack"
1421       , Whitespace
1422       , Plaintext "always"
1423       , Whitespace
1424       , Plaintext "runs"
1425       , Whitespace
1426       , Plaintext "synchronously"
1427       , Whitespace
1428       , Plaintext "via"
1429       , Whitespace
1430       , Link ":cexpr"
1431       , Plaintext ","
1432       , Whitespace
1433       , Plaintext "because"
1434       , Whitespace
1435       , Plaintext "dispatch.vim"
1436       , Whitespace
1437       , Plaintext "doesn't"
1438       , Whitespace
1439       , Plaintext "currently"
1440       , Whitespace
1441       , Plaintext "support"
1442       , Whitespace
1443       , Plaintext "the"
1444       , Whitespace
1445       , Link "location-list"
1446       , Plaintext "."
1447       ]
1448   , CommandAnnotation "Acks" (Just "/{pattern}/{replacement}/")
1449   , Paragraph
1450       [ Plaintext "Takes"
1451       , Whitespace
1452       , Plaintext "all"
1453       , Whitespace
1454       , Plaintext "of"
1455       , Whitespace
1456       , Plaintext "the"
1457       , Whitespace
1458       , Plaintext "files"
1459       , Whitespace
1460       , Plaintext "currently"
1461       , Whitespace
1462       , Plaintext "in"
1463       , Whitespace
1464       , Plaintext "the"
1465       , Whitespace
1466       , Link "quickfix"
1467       , Whitespace
1468       , Plaintext "listing"
1469       , Whitespace
1470       , Plaintext "and"
1471       , Whitespace
1472       , Plaintext "performs"
1473       , Whitespace
1474       , Plaintext "a"
1475       , Whitespace
1476       , Plaintext "substitution"
1477       , Whitespace
1478       , Plaintext "of"
1479       , Whitespace
1480       , Plaintext "all"
1481       , Whitespace
1482       , Plaintext "instances"
1483       , Whitespace
1484       , Plaintext "of"
1485       , Whitespace
1486       , Plaintext "{pattern}"
1487       , Whitespace
1488       , Plaintext "(a"
1489       , Whitespace
1490       , Plaintext "standard"
1491       , Whitespace
1492       , Plaintext "Vim"
1493       , Whitespace
1494       , Plaintext "search"
1495       , Whitespace
1496       , Link "pattern"
1497       , Plaintext ")"
1498       , Whitespace
1499       , Plaintext "by"
1500       , Whitespace
1501       , Plaintext "{replacement}."
1502       ]
1503   , Paragraph
1504       [ Plaintext "A"
1505       , Whitespace
1506       , Plaintext "typical"
1507       , Whitespace
1508       , Plaintext "sequence"
1509       , Whitespace
1510       , Plaintext "consists"
1511       , Whitespace
1512       , Plaintext "of"
1513       , Whitespace
1514       , Plaintext "an"
1515       , Whitespace
1516       , Link ":Ack"
1517       , Whitespace
1518       , Plaintext "invocation"
1519       , Whitespace
1520       , Plaintext "to"
1521       , Whitespace
1522       , Plaintext "populate"
1523       , Whitespace
1524       , Plaintext "the"
1525       , Whitespace
1526       , Link "quickfix"
1527       , Whitespace
1528       , Plaintext "listing"
1529       , Whitespace
1530       , Plaintext "and"
1531       , Whitespace
1532       , Plaintext "then"
1533       , Whitespace
1534       , Link ":Acks"
1535       , Whitespace
1536       , Plaintext "(mnemonic:"
1537       , Whitespace
1538       , Plaintext "\"Ack"
1539       , Whitespace
1540       , Plaintext "substitute\")"
1541       , Whitespace
1542       , Plaintext "to"
1543       , Whitespace
1544       , Plaintext "perform"
1545       , Whitespace
1546       , Plaintext "replacements."
1547       , Whitespace
1548       , Plaintext "For"
1549       , Whitespace
1550       , Plaintext "example,"
1551       , Whitespace
1552       , Plaintext "to"
1553       , Whitespace
1554       , Plaintext "replace"
1555       , Whitespace
1556       , Plaintext "\"foo\""
1557       , Whitespace
1558       , Plaintext "with"
1559       , Whitespace
1560       , Plaintext "\"bar\""
1561       , Whitespace
1562       , Plaintext "across"
1563       , Whitespace
1564       , Plaintext "all"
1565       , Whitespace
1566       , Plaintext "files"
1567       , Whitespace
1568       , Plaintext "in"
1569       , Whitespace
1570       , Plaintext "the"
1571       , Whitespace
1572       , Plaintext "current"
1573       , Whitespace
1574       , Plaintext "directory:"
1575       ]
1576   , Fenced [ ":Ack foo" , ":Acks /foo/bar/" ]
1577   , CommandAnnotation "Qargs" Nothing
1578   , Paragraph
1579       [ Plaintext "This"
1580       , Whitespace
1581       , Plaintext "is"
1582       , Whitespace
1583       , Plaintext "a"
1584       , Whitespace
1585       , Plaintext "utility"
1586       , Whitespace
1587       , Plaintext "function"
1588       , Whitespace
1589       , Plaintext "that"
1590       , Whitespace
1591       , Plaintext "is"
1592       , Whitespace
1593       , Plaintext "used"
1594       , Whitespace
1595       , Plaintext "by"
1596       , Whitespace
1597       , Plaintext "the"
1598       , Whitespace
1599       , Link ":Acks"
1600       , Whitespace
1601       , Plaintext "command"
1602       , Whitespace
1603       , Plaintext "but"
1604       , Whitespace
1605       , Plaintext "is"
1606       , Whitespace
1607       , Plaintext "also"
1608       , Whitespace
1609       , Plaintext "generally"
1610       , Whitespace
1611       , Plaintext "useful"
1612       , Whitespace
1613       , Plaintext "enough"
1614       , Whitespace
1615       , Plaintext "to"
1616       , Whitespace
1617       , Plaintext "warrant"
1618       , Whitespace
1619       , Plaintext "being"
1620       , Whitespace
1621       , Plaintext "exposed"
1622       , Whitespace
1623       , Plaintext "publicly."
1624       ]
1625   , Paragraph
1626       [ Plaintext "It"
1627       , Whitespace
1628       , Plaintext "takes"
1629       , Whitespace
1630       , Plaintext "the"
1631       , Whitespace
1632       , Plaintext "files"
1633       , Whitespace
1634       , Plaintext "currently"
1635       , Whitespace
1636       , Plaintext "in"
1637       , Whitespace
1638       , Plaintext "the"
1639       , Whitespace
1640       , Link "quickfix"
1641       , Whitespace
1642       , Plaintext "listing"
1643       , Whitespace
1644       , Plaintext "and"
1645       , Whitespace
1646       , Plaintext "sets"
1647       , Whitespace
1648       , Plaintext "them"
1649       , Whitespace
1650       , Plaintext "as"
1651       , Whitespace
1652       , Link ":args"
1653       , Whitespace
1654       , Plaintext "so"
1655       , Whitespace
1656       , Plaintext "that"
1657       , Whitespace
1658       , Plaintext "they"
1659       , Whitespace
1660       , Plaintext "can"
1661       , Whitespace
1662       , Plaintext "be"
1663       , Whitespace
1664       , Plaintext "operated"
1665       , Whitespace
1666       , Plaintext "on"
1667       , Whitespace
1668       , Plaintext "en"
1669       , Whitespace
1670       , Plaintext "masse"
1671       , Whitespace
1672       , Plaintext "via"
1673       , Whitespace
1674       , Plaintext "the"
1675       , Whitespace
1676       , Link ":argdo"
1677       , Whitespace
1678       , Plaintext "command."
1679       ]
1680   , MappingsAnnotation
1681   , SubheadingAnnotation
1682       "Circumstances where mappings do not get set up"
1683   , Paragraph
1684       [ Plaintext "Note"
1685       , Whitespace
1686       , Plaintext "that"
1687       , Whitespace
1688       , Plaintext "Ferret"
1689       , Whitespace
1690       , Plaintext "will"
1691       , Whitespace
1692       , Plaintext "not"
1693       , Whitespace
1694       , Plaintext "try"
1695       , Whitespace
1696       , Plaintext "to"
1697       , Whitespace
1698       , Plaintext "set"
1699       , Whitespace
1700       , Plaintext "up"
1701       , Whitespace
1702       , Plaintext "the"
1703       , Whitespace
1704       , Plaintext "<leader>"
1705       , Whitespace
1706       , Plaintext "mappings"
1707       , Whitespace
1708       , Plaintext "if"
1709       , Whitespace
1710       , Plaintext "any"
1711       , Whitespace
1712       , Plaintext "of"
1713       , Whitespace
1714       , Plaintext "the"
1715       , Whitespace
1716       , Plaintext "following"
1717       , Whitespace
1718       , Plaintext "are"
1719       , Whitespace
1720       , Plaintext "true:"
1721       ]
1722   , List
1723       [ ListItem
1724           [ Plaintext "A"
1725           , Whitespace
1726           , Plaintext "mapping"
1727           , Whitespace
1728           , Plaintext "for"
1729           , Whitespace
1730           , Plaintext "already"
1731           , Whitespace
1732           , Plaintext "exists."
1733           ]
1734       , ListItem
1735           [ Plaintext "An"
1736           , Whitespace
1737           , Plaintext "alternative"
1738           , Whitespace
1739           , Plaintext "mapping"
1740           , Whitespace
1741           , Plaintext "for"
1742           , Whitespace
1743           , Plaintext "the"
1744           , Whitespace
1745           , Plaintext "same"
1746           , Whitespace
1747           , Plaintext "functionality"
1748           , Whitespace
1749           , Plaintext "has"
1750           , Whitespace
1751           , Plaintext "already"
1752           , Whitespace
1753           , Plaintext "been"
1754           , Whitespace
1755           , Plaintext "set"
1756           , Whitespace
1757           , Plaintext "up"
1758           , Whitespace
1759           , Plaintext "from"
1760           , Whitespace
1761           , Plaintext "a"
1762           , Whitespace
1763           , Link ".vimrc"
1764           , Plaintext "."
1765           ]
1766       , ListItem
1767           [ Plaintext "The"
1768           , Whitespace
1769           , Plaintext "mapping"
1770           , Whitespace
1771           , Plaintext "has"
1772           , Whitespace
1773           , Plaintext "been"
1774           , Whitespace
1775           , Plaintext "suppressed"
1776           , Whitespace
1777           , Plaintext "by"
1778           , Whitespace
1779           , Plaintext "setting"
1780           , Whitespace
1781           , Link "g:FerretMap"
1782           , Whitespace
1783           , Plaintext "to"
1784           , Whitespace
1785           , Plaintext "1"
1786           , Whitespace
1787           , Plaintext "in"
1788           , Whitespace
1789           , Plaintext "your"
1790           , Whitespace
1791           , Link ".vimrc"
1792           , Plaintext "."
1793           ]
1794       ]
1795   , SubheadingAnnotation "Mappings specific to the quickfix window"
1796   , Paragraph
1797       [ Plaintext "Additionally,"
1798       , Whitespace
1799       , Plaintext "Ferret"
1800       , Whitespace
1801       , Plaintext "will"
1802       , Whitespace
1803       , Plaintext "set"
1804       , Whitespace
1805       , Plaintext "up"
1806       , Whitespace
1807       , Plaintext "special"
1808       , Whitespace
1809       , Plaintext "mappings"
1810       , Whitespace
1811       , Plaintext "in"
1812       , Whitespace
1813       , Link "quickfix"
1814       , Whitespace
1815       , Plaintext "listings,"
1816       , Whitespace
1817       , Plaintext "unless"
1818       , Whitespace
1819       , Plaintext "prevented"
1820       , Whitespace
1821       , Plaintext "from"
1822       , Whitespace
1823       , Plaintext "doing"
1824       , Whitespace
1825       , Plaintext "so"
1826       , Whitespace
1827       , Plaintext "by"
1828       , Whitespace
1829       , Link "g:FerretQFMap"
1830       , Plaintext ":"
1831       ]
1832   , List
1833       [ ListItem
1834           [ Code "d"
1835           , Whitespace
1836           , Plaintext "("
1837           , Link "visual-mode"
1838           , Plaintext "):"
1839           , Whitespace
1840           , Plaintext "delete"
1841           , Whitespace
1842           , Plaintext "visual"
1843           , Whitespace
1844           , Plaintext "selection"
1845           ]
1846       , ListItem
1847           [ Code "dd"
1848           , Whitespace
1849           , Plaintext "("
1850           , Link "Normal-mode"
1851           , Plaintext "):"
1852           , Whitespace
1853           , Plaintext "delete"
1854           , Whitespace
1855           , Plaintext "current"
1856           , Whitespace
1857           , Plaintext "line"
1858           ]
1859       , ListItem
1860           [ Code "d"
1861           , Plaintext "{motion}"
1862           , Whitespace
1863           , Plaintext "("
1864           , Link "Normal-mode"
1865           , Plaintext "):"
1866           , Whitespace
1867           , Plaintext "delete"
1868           , Whitespace
1869           , Plaintext "range"
1870           , Whitespace
1871           , Plaintext "indicated"
1872           , Whitespace
1873           , Plaintext "by"
1874           , Whitespace
1875           , Plaintext "{motion}"
1876           ]
1877       ]
1878   , MappingAnnotation "<Plug>(FerretAck)"
1879   , Paragraph
1880       [ Plaintext "Ferret"
1881       , Whitespace
1882       , Plaintext "maps"
1883       , Whitespace
1884       , Plaintext "<leader>a"
1885       , Whitespace
1886       , Plaintext "to"
1887       , Whitespace
1888       , Link "<Plug>(FerretAck)"
1889       , Plaintext ","
1890       , Whitespace
1891       , Plaintext "which"
1892       , Whitespace
1893       , Plaintext "triggers"
1894       , Whitespace
1895       , Plaintext "the"
1896       , Whitespace
1897       , Link ":Ack"
1898       , Whitespace
1899       , Plaintext "command."
1900       , Whitespace
1901       , Plaintext "To"
1902       , Whitespace
1903       , Plaintext "use"
1904       , Whitespace
1905       , Plaintext "an"
1906       , Whitespace
1907       , Plaintext "alternative"
1908       , Whitespace
1909       , Plaintext "mapping"
1910       , Whitespace
1911       , Plaintext "instead,"
1912       , Whitespace
1913       , Plaintext "create"
1914       , Whitespace
1915       , Plaintext "a"
1916       , Whitespace
1917       , Plaintext "different"
1918       , Whitespace
1919       , Plaintext "one"
1920       , Whitespace
1921       , Plaintext "in"
1922       , Whitespace
1923       , Plaintext "your"
1924       , Whitespace
1925       , Link ".vimrc"
1926       , Whitespace
1927       , Plaintext "instead"
1928       , Whitespace
1929       , Plaintext "using"
1930       , Whitespace
1931       , Link ":nmap"
1932       , Plaintext ":"
1933       ]
1934   , Fenced
1935       [ "\" Instead of <leader>a, use <leader>x."
1936       , "nmap <leader>x <Plug>(FerretAck)"
1937       ]
1938   , MappingAnnotation "<Plug>(FerretLack)"
1939   , Paragraph
1940       [ Plaintext "Ferret"
1941       , Whitespace
1942       , Plaintext "maps"
1943       , Whitespace
1944       , Plaintext "<leader>l"
1945       , Whitespace
1946       , Plaintext "to"
1947       , Whitespace
1948       , Link "<Plug>(FerretLack)"
1949       , Plaintext ","
1950       , Whitespace
1951       , Plaintext "which"
1952       , Whitespace
1953       , Plaintext "triggers"
1954       , Whitespace
1955       , Plaintext "the"
1956       , Whitespace
1957       , Link ":Lack"
1958       , Whitespace
1959       , Plaintext "command."
1960       , Whitespace
1961       , Plaintext "To"
1962       , Whitespace
1963       , Plaintext "use"
1964       , Whitespace
1965       , Plaintext "an"
1966       , Whitespace
1967       , Plaintext "alternative"
1968       , Whitespace
1969       , Plaintext "mapping"
1970       , Whitespace
1971       , Plaintext "instead,"
1972       , Whitespace
1973       , Plaintext "create"
1974       , Whitespace
1975       , Plaintext "a"
1976       , Whitespace
1977       , Plaintext "different"
1978       , Whitespace
1979       , Plaintext "one"
1980       , Whitespace
1981       , Plaintext "in"
1982       , Whitespace
1983       , Plaintext "your"
1984       , Whitespace
1985       , Link ".vimrc"
1986       , Whitespace
1987       , Plaintext "instead"
1988       , Whitespace
1989       , Plaintext "using"
1990       , Whitespace
1991       , Link ":nmap"
1992       , Plaintext ":"
1993       ]
1994   , Fenced
1995       [ "\" Instead of <leader>l, use <leader>y."
1996       , "nmap <leader>y <Plug>(FerretLack)"
1997       ]
1998   , MappingAnnotation "<Plug>(FerretAckWord)"
1999   , Paragraph
2000       [ Plaintext "Ferret"
2001       , Whitespace
2002       , Plaintext "maps"
2003       , Whitespace
2004       , Plaintext "<leader>s"
2005       , Whitespace
2006       , Plaintext "(mnemonix:"
2007       , Whitespace
2008       , Plaintext "\"selection)"
2009       , Whitespace
2010       , Plaintext "to"
2011       , Whitespace
2012       , Link "<Plug>(FerretAckWord)"
2013       , Plaintext ","
2014       , Whitespace
2015       , Plaintext "which"
2016       , Whitespace
2017       , Plaintext "uses"
2018       , Whitespace
2019       , Link ":Ack"
2020       , Whitespace
2021       , Plaintext "to"
2022       , Whitespace
2023       , Plaintext "search"
2024       , Whitespace
2025       , Plaintext "for"
2026       , Whitespace
2027       , Plaintext "the"
2028       , Whitespace
2029       , Plaintext "word"
2030       , Whitespace
2031       , Plaintext "currently"
2032       , Whitespace
2033       , Plaintext "under"
2034       , Whitespace
2035       , Plaintext "the"
2036       , Whitespace
2037       , Plaintext "cursor."
2038       , Whitespace
2039       , Plaintext "To"
2040       , Whitespace
2041       , Plaintext "use"
2042       , Whitespace
2043       , Plaintext "an"
2044       , Whitespace
2045       , Plaintext "alternative"
2046       , Whitespace
2047       , Plaintext "mapping"
2048       , Whitespace
2049       , Plaintext "instead,"
2050       , Whitespace
2051       , Plaintext "create"
2052       , Whitespace
2053       , Plaintext "a"
2054       , Whitespace
2055       , Plaintext "different"
2056       , Whitespace
2057       , Plaintext "one"
2058       , Whitespace
2059       , Plaintext "in"
2060       , Whitespace
2061       , Plaintext "your"
2062       , Whitespace
2063       , Link ".vimrc"
2064       , Whitespace
2065       , Plaintext "instead"
2066       , Whitespace
2067       , Plaintext "using"
2068       , Whitespace
2069       , Link ":nmap"
2070       , Plaintext ":"
2071       ]
2072   , Fenced
2073       [ "\" Instead of <leader>s, use <leader>z."
2074       , "nmap <leader>z <Plug>(FerretAckWord)"
2075       ]
2076   , MappingAnnotation "<Plug>(FerretAcks)"
2077   , Paragraph
2078       [ Plaintext "Ferret"
2079       , Whitespace
2080       , Plaintext "maps"
2081       , Whitespace
2082       , Plaintext "<leader>r"
2083       , Whitespace
2084       , Plaintext "(mnemonic:"
2085       , Whitespace
2086       , Plaintext "\"replace\")"
2087       , Whitespace
2088       , Plaintext "to"
2089       , Whitespace
2090       , Link "<Plug>(FerretAcks)"
2091       , Plaintext ","
2092       , Whitespace
2093       , Plaintext "which"
2094       , Whitespace
2095       , Plaintext "triggers"
2096       , Whitespace
2097       , Plaintext "the"
2098       , Whitespace
2099       , Link ":Acks"
2100       , Whitespace
2101       , Plaintext "command"
2102       , Whitespace
2103       , Plaintext "and"
2104       , Whitespace
2105       , Plaintext "fills"
2106       , Whitespace
2107       , Plaintext "the"
2108       , Whitespace
2109       , Plaintext "prompt"
2110       , Whitespace
2111       , Plaintext "with"
2112       , Whitespace
2113       , Plaintext "the"
2114       , Whitespace
2115       , Plaintext "last"
2116       , Whitespace
2117       , Plaintext "search"
2118       , Whitespace
2119       , Plaintext "term"
2120       , Whitespace
2121       , Plaintext "from"
2122       , Whitespace
2123       , Plaintext "Ferret."
2124       , Whitespace
2125       , Plaintext "to"
2126       , Whitespace
2127       , Plaintext "use"
2128       , Whitespace
2129       , Plaintext "an"
2130       , Whitespace
2131       , Plaintext "alternative"
2132       , Whitespace
2133       , Plaintext "mapping"
2134       , Whitespace
2135       , Plaintext "instead,"
2136       , Whitespace
2137       , Plaintext "create"
2138       , Whitespace
2139       , Plaintext "a"
2140       , Whitespace
2141       , Plaintext "different"
2142       , Whitespace
2143       , Plaintext "one"
2144       , Whitespace
2145       , Plaintext "in"
2146       , Whitespace
2147       , Plaintext "your"
2148       , Whitespace
2149       , Link ".vimrc"
2150       , Whitespace
2151       , Plaintext "instead"
2152       , Whitespace
2153       , Plaintext "using"
2154       , Whitespace
2155       , Link ":nmap"
2156       , Plaintext ":"
2157       ]
2158   , Fenced
2159       [ "\" Instead of <leader>r, use <leader>u."
2160       , "nmap <leader>u <Plug>(FerretAcks)"
2161       ]
2162   , OptionsAnnotation
2163   , OptionAnnotation "g:FerretLoaded" "any" Nothing
2164   , Paragraph
2165       [ Plaintext "To"
2166       , Whitespace
2167       , Plaintext "prevent"
2168       , Whitespace
2169       , Plaintext "Ferret"
2170       , Whitespace
2171       , Plaintext "from"
2172       , Whitespace
2173       , Plaintext "being"
2174       , Whitespace
2175       , Plaintext "loaded,"
2176       , Whitespace
2177       , Plaintext "set"
2178       , Whitespace
2179       , Link "g:FerretLoaded"
2180       , Whitespace
2181       , Plaintext "to"
2182       , Whitespace
2183       , Plaintext "any"
2184       , Whitespace
2185       , Plaintext "value"
2186       , Whitespace
2187       , Plaintext "in"
2188       , Whitespace
2189       , Plaintext "your"
2190       , Whitespace
2191       , Link ".vimrc"
2192       , Plaintext "."
2193       , Whitespace
2194       , Plaintext "For"
2195       , Whitespace
2196       , Plaintext "example:"
2197       ]
2198   , Fenced [ "let g:FerretLoaded=1" ]
2199   , OptionAnnotation "g:FerretMap" "boolean" (Just "1")
2200   , Paragraph
2201       [ Plaintext "Controls"
2202       , Whitespace
2203       , Plaintext "whether"
2204       , Whitespace
2205       , Plaintext "to"
2206       , Whitespace
2207       , Plaintext "set"
2208       , Whitespace
2209       , Plaintext "up"
2210       , Whitespace
2211       , Plaintext "the"
2212       , Whitespace
2213       , Plaintext "Ferret"
2214       , Whitespace
2215       , Plaintext "mappings,"
2216       , Whitespace
2217       , Plaintext "such"
2218       , Whitespace
2219       , Plaintext "as"
2220       , Whitespace
2221       , Link "<Plug>(FerretAck)"
2222       , Whitespace
2223       , Plaintext "(see"
2224       , Whitespace
2225       , Link "ferret-mappings"
2226       , Whitespace
2227       , Plaintext "for"
2228       , Whitespace
2229       , Plaintext "a"
2230       , Whitespace
2231       , Plaintext "full"
2232       , Whitespace
2233       , Plaintext "list)."
2234       , Whitespace
2235       , Plaintext "To"
2236       , Whitespace
2237       , Plaintext "prevent"
2238       , Whitespace
2239       , Plaintext "any"
2240       , Whitespace
2241       , Plaintext "mapping"
2242       , Whitespace
2243       , Plaintext "from"
2244       , Whitespace
2245       , Plaintext "being"
2246       , Whitespace
2247       , Plaintext "configured,"
2248       , Whitespace
2249       , Plaintext "set"
2250       , Whitespace
2251       , Plaintext "to"
2252       , Whitespace
2253       , Plaintext "0:"
2254       ]
2255   , Fenced [ "let g:FerretMap=0" ]
2256   , OptionAnnotation "g:FerretQFCommands" "boolean" (Just "1")
2257   , Paragraph
2258       [ Plaintext "Controls"
2259       , Whitespace
2260       , Plaintext "whether"
2261       , Whitespace
2262       , Plaintext "to"
2263       , Whitespace
2264       , Plaintext "set"
2265       , Whitespace
2266       , Plaintext "up"
2267       , Whitespace
2268       , Plaintext "custom"
2269       , Whitespace
2270       , Plaintext "versions"
2271       , Whitespace
2272       , Plaintext "of"
2273       , Whitespace
2274       , Plaintext "the"
2275       , Whitespace
2276       , Link "quickfix"
2277       , Whitespace
2278       , Plaintext "commands,"
2279       , Whitespace
2280       , Link ":cn"
2281       , Plaintext ","
2282       , Whitespace
2283       , Link ":cnf"
2284       , Plaintext ","
2285       , Whitespace
2286       , Link ":cp"
2287       , Whitespace
2288       , Plaintext "an"
2289       , Whitespace
2290       , Link ":cpf"
2291       , Plaintext "."
2292       , Whitespace
2293       , Plaintext "These"
2294       , Whitespace
2295       , Plaintext "overrides"
2296       , Whitespace
2297       , Plaintext "vertically"
2298       , Whitespace
2299       , Plaintext "center"
2300       , Whitespace
2301       , Plaintext "the"
2302       , Whitespace
2303       , Plaintext "match"
2304       , Whitespace
2305       , Plaintext "within"
2306       , Whitespace
2307       , Plaintext "the"
2308       , Whitespace
2309       , Plaintext "viewport"
2310       , Whitespace
2311       , Plaintext "on"
2312       , Whitespace
2313       , Plaintext "each"
2314       , Whitespace
2315       , Plaintext "jump."
2316       , Whitespace
2317       , Plaintext "To"
2318       , Whitespace
2319       , Plaintext "prevent"
2320       , Whitespace
2321       , Plaintext "the"
2322       , Whitespace
2323       , Plaintext "custom"
2324       , Whitespace
2325       , Plaintext "versions"
2326       , Whitespace
2327       , Plaintext "from"
2328       , Whitespace
2329       , Plaintext "being"
2330       , Whitespace
2331       , Plaintext "configured,"
2332       , Whitespace
2333       , Plaintext "set"
2334       , Whitespace
2335       , Plaintext "to"
2336       , Whitespace
2337       , Plaintext "0:"
2338       ]
2339   , Fenced [ "let g:FerretQFCommands=0" ]
2340   , FooterAnnotation
2341   , HeadingAnnotation "Custom autocommands"
2342   , LinkTargets [ "FerretWillWrite" , "FerretDidWrite" ]
2343   , Paragraph
2344       [ Plaintext "For"
2345       , Whitespace
2346       , Plaintext "maximum"
2347       , Whitespace
2348       , Plaintext "compatibility"
2349       , Whitespace
2350       , Plaintext "with"
2351       , Whitespace
2352       , Plaintext "other"
2353       , Whitespace
2354       , Plaintext "plug-ins,"
2355       , Whitespace
2356       , Plaintext "Ferret"
2357       , Whitespace
2358       , Plaintext "runs"
2359       , Whitespace
2360       , Plaintext "the"
2361       , Whitespace
2362       , Plaintext "following"
2363       , Whitespace
2364       , Plaintext "\"User\""
2365       , Whitespace
2366       , Plaintext "autocommands"
2367       , Whitespace
2368       , Plaintext "before"
2369       , Whitespace
2370       , Plaintext "and"
2371       , Whitespace
2372       , Plaintext "after"
2373       , Whitespace
2374       , Plaintext "running"
2375       , Whitespace
2376       , Plaintext "the"
2377       , Whitespace
2378       , Plaintext "file"
2379       , Whitespace
2380       , Plaintext "writing"
2381       , Whitespace
2382       , Plaintext "operations"
2383       , Whitespace
2384       , Plaintext "during"
2385       , Whitespace
2386       , Link ":Acks"
2387       , Plaintext ":"
2388       ]
2389   , List
2390       [ ListItem [ Plaintext "FerretWillWrite" ]
2391       , ListItem [ Plaintext "FerretDidWrite" ]
2392       ]
2393   , Paragraph
2394       [ Plaintext "For"
2395       , Whitespace
2396       , Plaintext "example,"
2397       , Whitespace
2398       , Plaintext "to"
2399       , Whitespace
2400       , Plaintext "call"
2401       , Whitespace
2402       , Plaintext "a"
2403       , Whitespace
2404       , Plaintext "pair"
2405       , Whitespace
2406       , Plaintext "of"
2407       , Whitespace
2408       , Plaintext "custom"
2409       , Whitespace
2410       , Plaintext "functions"
2411       , Whitespace
2412       , Plaintext "in"
2413       , Whitespace
2414       , Plaintext "response"
2415       , Whitespace
2416       , Plaintext "to"
2417       , Whitespace
2418       , Plaintext "these"
2419       , Whitespace
2420       , Plaintext "events,"
2421       , Whitespace
2422       , Plaintext "you"
2423       , Whitespace
2424       , Plaintext "might"
2425       , Whitespace
2426       , Plaintext "do:"
2427       ]
2428   , Fenced
2429       [ "autocmd! User FerretWillWrite"
2430       , "autocmd User FerretWillWrite call CustomWillWrite()"
2431       , "autocmd! User FerretDidWrite"
2432       , "autocmd User FerretDidWrite call CustomDidWrite()"
2433       ]
2434   , HeadingAnnotation "Overrides"
2435   , Paragraph
2436       [ Plaintext "Ferret"
2437       , Whitespace
2438       , Plaintext "overrides"
2439       , Whitespace
2440       , Plaintext "the"
2441       , Whitespace
2442       , Plaintext "'grepformat'"
2443       , Whitespace
2444       , Plaintext "and"
2445       , Whitespace
2446       , Plaintext "'grepprg'"
2447       , Whitespace
2448       , Plaintext "settings,"
2449       , Whitespace
2450       , Plaintext "preferentially"
2451       , Whitespace
2452       , Plaintext "setting"
2453       , Whitespace
2454       , Code "ag"
2455       , Plaintext ","
2456       , Whitespace
2457       , Code "ack"
2458       , Whitespace
2459       , Plaintext "or"
2460       , Whitespace
2461       , Code "grep"
2462       , Whitespace
2463       , Plaintext "as"
2464       , Whitespace
2465       , Plaintext "the"
2466       , Whitespace
2467       , Plaintext "'grepprg'"
2468       , Whitespace
2469       , Plaintext "(in"
2470       , Whitespace
2471       , Plaintext "that"
2472       , Whitespace
2473       , Plaintext "order)"
2474       , Whitespace
2475       , Plaintext "and"
2476       , Whitespace
2477       , Plaintext "configuring"
2478       , Whitespace
2479       , Plaintext "a"
2480       , Whitespace
2481       , Plaintext "suitable"
2482       , Whitespace
2483       , Plaintext "'grepformat'."
2484       ]
2485   , Paragraph
2486       [ Plaintext "Additionally,"
2487       , Whitespace
2488       , Plaintext "Ferret"
2489       , Whitespace
2490       , Plaintext "includes"
2491       , Whitespace
2492       , Plaintext "an"
2493       , Whitespace
2494       , Link "ftplugin"
2495       , Whitespace
2496       , Plaintext "for"
2497       , Whitespace
2498       , Plaintext "the"
2499       , Whitespace
2500       , Link "quickfix"
2501       , Whitespace
2502       , Plaintext "listing"
2503       , Whitespace
2504       , Plaintext "that"
2505       , Whitespace
2506       , Plaintext "adjusts"
2507       , Whitespace
2508       , Plaintext "a"
2509       , Whitespace
2510       , Plaintext "number"
2511       , Whitespace
2512       , Plaintext "of"
2513       , Whitespace
2514       , Plaintext "settings"
2515       , Whitespace
2516       , Plaintext "to"
2517       , Whitespace
2518       , Plaintext "improve"
2519       , Whitespace
2520       , Plaintext "the"
2521       , Whitespace
2522       , Plaintext "usability"
2523       , Whitespace
2524       , Plaintext "of"
2525       , Whitespace
2526       , Plaintext "search"
2527       , Whitespace
2528       , Plaintext "results."
2529       ]
2530   , IndentAnnotation
2531   , LinkTargets [ "ferret-nolist" ]
2532   , Paragraph [ Plaintext "'nolist'" ]
2533   , Paragraph
2534       [ Plaintext "Turned"
2535       , Whitespace
2536       , Plaintext "off"
2537       , Whitespace
2538       , Plaintext "to"
2539       , Whitespace
2540       , Plaintext "reduce"
2541       , Whitespace
2542       , Plaintext "visual"
2543       , Whitespace
2544       , Plaintext "clutter"
2545       , Whitespace
2546       , Plaintext "in"
2547       , Whitespace
2548       , Plaintext "the"
2549       , Whitespace
2550       , Plaintext "search"
2551       , Whitespace
2552       , Plaintext "results,"
2553       , Whitespace
2554       , Plaintext "and"
2555       , Whitespace
2556       , Plaintext "because"
2557       , Whitespace
2558       , Plaintext "'list'"
2559       , Whitespace
2560       , Plaintext "is"
2561       , Whitespace
2562       , Plaintext "most"
2563       , Whitespace
2564       , Plaintext "useful"
2565       , Whitespace
2566       , Plaintext "in"
2567       , Whitespace
2568       , Plaintext "files"
2569       , Whitespace
2570       , Plaintext "that"
2571       , Whitespace
2572       , Plaintext "are"
2573       , Whitespace
2574       , Plaintext "being"
2575       , Whitespace
2576       , Plaintext "actively"
2577       , Whitespace
2578       , Plaintext "edited,"
2579       , Whitespace
2580       , Plaintext "which"
2581       , Whitespace
2582       , Plaintext "is"
2583       , Whitespace
2584       , Plaintext "not"
2585       , Whitespace
2586       , Plaintext "the"
2587       , Whitespace
2588       , Plaintext "case"
2589       , Whitespace
2590       , Plaintext "for"
2591       , Whitespace
2592       , Link "quickfix"
2593       , Whitespace
2594       , Plaintext "results."
2595       ]
2596   , LinkTargets [ "ferret-norelativenumber" ]
2597   , Paragraph [ Plaintext "'norelativenumber'" ]
2598   , Paragraph
2599       [ Plaintext "Turned"
2600       , Whitespace
2601       , Plaintext "off,"
2602       , Whitespace
2603       , Plaintext "because"
2604       , Whitespace
2605       , Plaintext "it"
2606       , Whitespace
2607       , Plaintext "is"
2608       , Whitespace
2609       , Plaintext "more"
2610       , Whitespace
2611       , Plaintext "useful"
2612       , Whitespace
2613       , Plaintext "to"
2614       , Whitespace
2615       , Plaintext "have"
2616       , Whitespace
2617       , Plaintext "a"
2618       , Whitespace
2619       , Plaintext "sense"
2620       , Whitespace
2621       , Plaintext "of"
2622       , Whitespace
2623       , Plaintext "absolute"
2624       , Whitespace
2625       , Plaintext "progress"
2626       , Whitespace
2627       , Plaintext "through"
2628       , Whitespace
2629       , Plaintext "the"
2630       , Whitespace
2631       , Plaintext "results"
2632       , Whitespace
2633       , Plaintext "list"
2634       , Whitespace
2635       , Plaintext "than"
2636       , Whitespace
2637       , Plaintext "to"
2638       , Whitespace
2639       , Plaintext "have"
2640       , Whitespace
2641       , Plaintext "the"
2642       , Whitespace
2643       , Plaintext "ability"
2644       , Whitespace
2645       , Plaintext "to"
2646       , Whitespace
2647       , Plaintext "jump"
2648       , Whitespace
2649       , Plaintext "to"
2650       , Whitespace
2651       , Plaintext "nearby"
2652       , Whitespace
2653       , Plaintext "results"
2654       , Whitespace
2655       , Plaintext "(especially"
2656       , Whitespace
2657       , Plaintext "seeing"
2658       , Whitespace
2659       , Plaintext "as"
2660       , Whitespace
2661       , Plaintext "the"
2662       , Whitespace
2663       , Plaintext "most"
2664       , Whitespace
2665       , Plaintext "common"
2666       , Whitespace
2667       , Plaintext "operations"
2668       , Whitespace
2669       , Plaintext "are"
2670       , Whitespace
2671       , Plaintext "moving"
2672       , Whitespace
2673       , Plaintext "to"
2674       , Whitespace
2675       , Plaintext "the"
2676       , Whitespace
2677       , Plaintext "next"
2678       , Whitespace
2679       , Plaintext "or"
2680       , Whitespace
2681       , Plaintext "previous"
2682       , Whitespace
2683       , Plaintext "file,"
2684       , Whitespace
2685       , Plaintext "which"
2686       , Whitespace
2687       , Plaintext "are"
2688       , Whitespace
2689       , Plaintext "both"
2690       , Whitespace
2691       , Plaintext "handled"
2692       , Whitespace
2693       , Plaintext "nicely"
2694       , Whitespace
2695       , Plaintext "by"
2696       , Whitespace
2697       , Link ":cnf"
2698       , Whitespace
2699       , Plaintext "and"
2700       , Whitespace
2701       , Link ":cpf"
2702       , Whitespace
2703       , Plaintext "respectively)."
2704       ]
2705   , LinkTargets [ "ferret-nowrap" ]
2706   , Paragraph [ Plaintext "'nowrap'" ]
2707   , Paragraph
2708       [ Plaintext "Turned"
2709       , Whitespace
2710       , Plaintext "off"
2711       , Whitespace
2712       , Plaintext "to"
2713       , Whitespace
2714       , Plaintext "avoid"
2715       , Whitespace
2716       , Plaintext "ugly"
2717       , Whitespace
2718       , Plaintext "wrapping"
2719       , Whitespace
2720       , Plaintext "that"
2721       , Whitespace
2722       , Plaintext "makes"
2723       , Whitespace
2724       , Plaintext "the"
2725       , Whitespace
2726       , Plaintext "results"
2727       , Whitespace
2728       , Plaintext "list"
2729       , Whitespace
2730       , Plaintext "hard"
2731       , Whitespace
2732       , Plaintext "to"
2733       , Whitespace
2734       , Plaintext "read,"
2735       , Whitespace
2736       , Plaintext "and"
2737       , Whitespace
2738       , Plaintext "because"
2739       , Whitespace
2740       , Plaintext "in"
2741       , Whitespace
2742       , Plaintext "search"
2743       , Whitespace
2744       , Plaintext "results,"
2745       , Whitespace
2746       , Plaintext "the"
2747       , Whitespace
2748       , Plaintext "most"
2749       , Whitespace
2750       , Plaintext "relevant"
2751       , Whitespace
2752       , Plaintext "information"
2753       , Whitespace
2754       , Plaintext "is"
2755       , Whitespace
2756       , Plaintext "the"
2757       , Whitespace
2758       , Plaintext "filename,"
2759       , Whitespace
2760       , Plaintext "which"
2761       , Whitespace
2762       , Plaintext "is"
2763       , Whitespace
2764       , Plaintext "on"
2765       , Whitespace
2766       , Plaintext "the"
2767       , Whitespace
2768       , Plaintext "left"
2769       , Whitespace
2770       , Plaintext "and"
2771       , Whitespace
2772       , Plaintext "is"
2773       , Whitespace
2774       , Plaintext "usually"
2775       , Whitespace
2776       , Plaintext "visible"
2777       , Whitespace
2778       , Plaintext "even"
2779       , Whitespace
2780       , Plaintext "without"
2781       , Whitespace
2782       , Plaintext "wrapping."
2783       ]
2784   , LinkTargets [ "ferret-number" ]
2785   , Paragraph [ Plaintext "'number'" ]
2786   , Paragraph
2787       [ Plaintext "Turned"
2788       , Whitespace
2789       , Plaintext "on"
2790       , Whitespace
2791       , Plaintext "to"
2792       , Whitespace
2793       , Plaintext "give"
2794       , Whitespace
2795       , Plaintext "a"
2796       , Whitespace
2797       , Plaintext "sense"
2798       , Whitespace
2799       , Plaintext "of"
2800       , Whitespace
2801       , Plaintext "absolute"
2802       , Whitespace
2803       , Plaintext "progress"
2804       , Whitespace
2805       , Plaintext "through"
2806       , Whitespace
2807       , Plaintext "the"
2808       , Whitespace
2809       , Plaintext "results."
2810       ]
2811   , LinkTargets [ "ferret-scrolloff" ]
2812   , Paragraph [ Plaintext "'scrolloff'" ]
2813   , Paragraph
2814       [ Plaintext "Set"
2815       , Whitespace
2816       , Plaintext "to"
2817       , Whitespace
2818       , Plaintext "0"
2819       , Whitespace
2820       , Plaintext "because"
2821       , Whitespace
2822       , Plaintext "the"
2823       , Whitespace
2824       , Link "quickfix"
2825       , Whitespace
2826       , Plaintext "listing"
2827       , Whitespace
2828       , Plaintext "is"
2829       , Whitespace
2830       , Plaintext "usually"
2831       , Whitespace
2832       , Plaintext "small"
2833       , Whitespace
2834       , Plaintext "by"
2835       , Whitespace
2836       , Plaintext "default,"
2837       , Whitespace
2838       , Plaintext "so"
2839       , Whitespace
2840       , Plaintext "trying"
2841       , Whitespace
2842       , Plaintext "to"
2843       , Whitespace
2844       , Plaintext "keep"
2845       , Whitespace
2846       , Plaintext "the"
2847       , Whitespace
2848       , Plaintext "current"
2849       , Whitespace
2850       , Plaintext "line"
2851       , Whitespace
2852       , Plaintext "away"
2853       , Whitespace
2854       , Plaintext "from"
2855       , Whitespace
2856       , Plaintext "the"
2857       , Whitespace
2858       , Plaintext "edge"
2859       , Whitespace
2860       , Plaintext "of"
2861       , Whitespace
2862       , Plaintext "the"
2863       , Whitespace
2864       , Plaintext "viewpoint"
2865       , Whitespace
2866       , Plaintext "is"
2867       , Whitespace
2868       , Plaintext "futile;"
2869       , Whitespace
2870       , Plaintext "by"
2871       , Whitespace
2872       , Plaintext "definition"
2873       , Whitespace
2874       , Plaintext "it"
2875       , Whitespace
2876       , Plaintext "is"
2877       , Whitespace
2878       , Plaintext "usually"
2879       , Whitespace
2880       , Plaintext "near"
2881       , Whitespace
2882       , Plaintext "the"
2883       , Whitespace
2884       , Plaintext "edge."
2885       ]
2886   , LinkTargets [ "ferret-nocursorline" ]
2887   , Paragraph [ Plaintext "'nocursorline'" ]
2888   , Paragraph
2889       [ Plaintext "Turned"
2890       , Whitespace
2891       , Plaintext "off"
2892       , Whitespace
2893       , Plaintext "to"
2894       , Whitespace
2895       , Plaintext "reduce"
2896       , Whitespace
2897       , Plaintext "visual"
2898       , Whitespace
2899       , Plaintext "clutter."
2900       ]
2901   , DedentAnnotation
2902   , Paragraph
2903       [ Plaintext "To"
2904       , Whitespace
2905       , Plaintext "prevent"
2906       , Whitespace
2907       , Plaintext "any"
2908       , Whitespace
2909       , Plaintext "of"
2910       , Whitespace
2911       , Plaintext "these"
2912       , Whitespace
2913       , Link "quickfix"
2914       , Plaintext "-specific"
2915       , Whitespace
2916       , Plaintext "overrides"
2917       , Whitespace
2918       , Plaintext "from"
2919       , Whitespace
2920       , Plaintext "being"
2921       , Whitespace
2922       , Plaintext "set"
2923       , Whitespace
2924       , Plaintext "up,"
2925       , Whitespace
2926       , Plaintext "you"
2927       , Whitespace
2928       , Plaintext "can"
2929       , Whitespace
2930       , Plaintext "set"
2931       , Whitespace
2932       , Link "g:FerretQFOptions"
2933       , Whitespace
2934       , Plaintext "to"
2935       , Whitespace
2936       , Plaintext "0"
2937       , Whitespace
2938       , Plaintext "in"
2939       , Whitespace
2940       , Plaintext "your"
2941       , Whitespace
2942       , Link ".vimrc"
2943       , Plaintext ":"
2944       ]
2945   , Fenced [ "let g:FerretQFOptions=0" ]
2946   , HeadingAnnotation "Troubleshooting"
2947   , LinkTargets [ "ferret-quotes" ]
2948   , SubheadingAnnotation
2949       "Ferret fails to find patterns containing spaces"
2950   , Paragraph
2951       [ Plaintext "As"
2952       , Whitespace
2953       , Plaintext "described"
2954       , Whitespace
2955       , Plaintext "in"
2956       , Whitespace
2957       , Plaintext "the"
2958       , Whitespace
2959       , Plaintext "documentation"
2960       , Whitespace
2961       , Plaintext "for"
2962       , Whitespace
2963       , Link ":Ack"
2964       , Plaintext ","
2965       , Whitespace
2966       , Plaintext "the"
2967       , Whitespace
2968       , Plaintext "search"
2969       , Whitespace
2970       , Plaintext "pattern"
2971       , Whitespace
2972       , Plaintext "is"
2973       , Whitespace
2974       , Plaintext "passed"
2975       , Whitespace
2976       , Plaintext "through"
2977       , Whitespace
2978       , Plaintext "as-is"
2979       , Whitespace
2980       , Plaintext "to"
2981       , Whitespace
2982       , Plaintext "the"
2983       , Whitespace
2984       , Plaintext "underlying"
2985       , Whitespace
2986       , Plaintext "search"
2987       , Whitespace
2988       , Plaintext "command,"
2989       , Whitespace
2990       , Plaintext "and"
2991       , Whitespace
2992       , Plaintext "no"
2993       , Whitespace
2994       , Plaintext "escaping"
2995       , Whitespace
2996       , Plaintext "is"
2997       , Whitespace
2998       , Plaintext "required"
2999       , Whitespace
3000       , Plaintext "other"
3001       , Whitespace
3002       , Plaintext "than"
3003       , Whitespace
3004       , Plaintext "preceding"
3005       , Whitespace
3006       , Plaintext "spaces"
3007       , Whitespace
3008       , Plaintext "by"
3009       , Whitespace
3010       , Plaintext "a"
3011       , Whitespace
3012       , Plaintext "single"
3013       , Whitespace
3014       , Plaintext "backslash."
3015       ]
3016   , Paragraph
3017       [ Plaintext "So,"
3018       , Whitespace
3019       , Plaintext "to"
3020       , Whitespace
3021       , Plaintext "find"
3022       , Whitespace
3023       , Plaintext "\"foo"
3024       , Whitespace
3025       , Plaintext "bar\","
3026       , Whitespace
3027       , Plaintext "you"
3028       , Whitespace
3029       , Plaintext "would"
3030       , Whitespace
3031       , Plaintext "search"
3032       , Whitespace
3033       , Plaintext "like:"
3034       ]
3035   , Fenced [ ":Ack foo\\ bar" ]
3036   , Paragraph
3037       [ Plaintext "Unescaped"
3038       , Whitespace
3039       , Plaintext "spaces"
3040       , Whitespace
3041       , Plaintext "in"
3042       , Whitespace
3043       , Plaintext "the"
3044       , Whitespace
3045       , Plaintext "search"
3046       , Whitespace
3047       , Plaintext "are"
3048       , Whitespace
3049       , Plaintext "treated"
3050       , Whitespace
3051       , Plaintext "as"
3052       , Whitespace
3053       , Plaintext "argument"
3054       , Whitespace
3055       , Plaintext "separators,"
3056       , Whitespace
3057       , Plaintext "so"
3058       , Whitespace
3059       , Plaintext "a"
3060       , Whitespace
3061       , Plaintext "command"
3062       , Whitespace
3063       , Plaintext "like"
3064       , Whitespace
3065       , Plaintext "the"
3066       , Whitespace
3067       , Plaintext "following"
3068       , Whitespace
3069       , Plaintext "means"
3070       , Whitespace
3071       , Plaintext "pass"
3072       , Whitespace
3073       , Plaintext "the"
3074       , Whitespace
3075       , Code "-w"
3076       , Whitespace
3077       , Plaintext "option"
3078       , Whitespace
3079       , Plaintext "through,"
3080       , Whitespace
3081       , Plaintext "search"
3082       , Whitespace
3083       , Plaintext "for"
3084       , Whitespace
3085       , Plaintext "pattern"
3086       , Whitespace
3087       , Plaintext "\"foo\","
3088       , Whitespace
3089       , Plaintext "and"
3090       , Whitespace
3091       , Plaintext "limit"
3092       , Whitespace
3093       , Plaintext "search"
3094       , Whitespace
3095       , Plaintext "to"
3096       , Whitespace
3097       , Plaintext "the"
3098       , Whitespace
3099       , Plaintext "\"bar\""
3100       , Whitespace
3101       , Plaintext "directory:"
3102       ]
3103   , Fenced [ ":Ack -w foo bar" ]
3104   , Paragraph
3105       [ Plaintext "Note"
3106       , Whitespace
3107       , Plaintext "that"
3108       , Whitespace
3109       , Plaintext "including"
3110       , Whitespace
3111       , Plaintext "quotes"
3112       , Whitespace
3113       , Plaintext "will"
3114       , Whitespace
3115       , Plaintext "not"
3116       , Whitespace
3117       , Plaintext "do"
3118       , Whitespace
3119       , Plaintext "what"
3120       , Whitespace
3121       , Plaintext "you"
3122       , Whitespace
3123       , Plaintext "intend."
3124       ]
3125   , Fenced
3126       [ " \" Search for '\"foo' in the 'bar\"' directory:"
3127       , " :Ack \"foo bar\""
3128       , ""
3129       , " \" Search for \"'foo' in the \"bar'\" directory:"
3130       , " :Ack 'foo bar'"
3131       ]
3132   , Paragraph
3133       [ Plaintext "This"
3134       , Whitespace
3135       , Plaintext "approach"
3136       , Whitespace
3137       , Plaintext "to"
3138       , Whitespace
3139       , Plaintext "escaping"
3140       , Whitespace
3141       , Plaintext "is"
3142       , Whitespace
3143       , Plaintext "taken"
3144       , Whitespace
3145       , Plaintext "in"
3146       , Whitespace
3147       , Plaintext "order"
3148       , Whitespace
3149       , Plaintext "to"
3150       , Whitespace
3151       , Plaintext "make"
3152       , Whitespace
3153       , Plaintext "it"
3154       , Whitespace
3155       , Plaintext "straightfoward"
3156       , Whitespace
3157       , Plaintext "to"
3158       , Whitespace
3159       , Plaintext "use"
3160       , Whitespace
3161       , Plaintext "powerful"
3162       , Whitespace
3163       , Plaintext "Perl-compatible"
3164       , Whitespace
3165       , Plaintext "regular"
3166       , Whitespace
3167       , Plaintext "expression"
3168       , Whitespace
3169       , Plaintext "syntax"
3170       , Whitespace
3171       , Plaintext "in"
3172       , Whitespace
3173       , Plaintext "an"
3174       , Whitespace
3175       , Plaintext "unambiguous"
3176       , Whitespace
3177       , Plaintext "way"
3178       , Whitespace
3179       , Plaintext "without"
3180       , Whitespace
3181       , Plaintext "having"
3182       , Whitespace
3183       , Plaintext "to"
3184       , Whitespace
3185       , Plaintext "worry"
3186       , Whitespace
3187       , Plaintext "about"
3188       , Whitespace
3189       , Plaintext "shell"
3190       , Whitespace
3191       , Plaintext "escaping"
3192       , Whitespace
3193       , Plaintext "rules:"
3194       ]
3195   , Fenced
3196       [ ":Ack \\blog\\((['\"]).*?\\1\\) -i --ignore-dir=src/vendor src dist build"
3197       ]
3198   , HeadingAnnotation "FAQ"
3199   , SubheadingAnnotation
3200       "Why do Ferret commands start with \"Ack\", \"Lack\" and so on?"
3201   , Paragraph
3202       [ Plaintext "Ferret"
3203       , Whitespace
3204       , Plaintext "was"
3205       , Whitespace
3206       , Plaintext "originally"
3207       , Whitespace
3208       , Plaintext "the"
3209       , Whitespace
3210       , Plaintext "thinnest"
3211       , Whitespace
3212       , Plaintext "of"
3213       , Whitespace
3214       , Plaintext "wrappers"
3215       , Whitespace
3216       , Plaintext "(7"
3217       , Whitespace
3218       , Plaintext "lines"
3219       , Whitespace
3220       , Plaintext "of"
3221       , Whitespace
3222       , Plaintext "code"
3223       , Whitespace
3224       , Plaintext "in"
3225       , Whitespace
3226       , Plaintext "my"
3227       , Whitespace
3228       , Link ".vimrc"
3229       , Plaintext ")"
3230       , Whitespace
3231       , Plaintext "around"
3232       , Whitespace
3233       , Code "ack"
3234       , Plaintext "."
3235       , Whitespace
3236       , Plaintext "The"
3237       , Whitespace
3238       , Plaintext "earliest"
3239       , Whitespace
3240       , Plaintext "traces"
3241       , Whitespace
3242       , Plaintext "of"
3243       , Whitespace
3244       , Plaintext "it"
3245       , Whitespace
3246       , Plaintext "can"
3247       , Whitespace
3248       , Plaintext "be"
3249       , Whitespace
3250       , Plaintext "seen"
3251       , Whitespace
3252       , Plaintext "in"
3253       , Whitespace
3254       , Plaintext "the"
3255       , Whitespace
3256       , Plaintext "initial"
3257       , Whitespace
3258       , Plaintext "commit"
3259       , Whitespace
3260       , Plaintext "to"
3261       , Whitespace
3262       , Plaintext "my"
3263       , Whitespace
3264       , Plaintext "dotfiles"
3265       , Whitespace
3266       , Plaintext "repo"
3267       , Whitespace
3268       , Plaintext "in"
3269       , Whitespace
3270       , Plaintext "May,"
3271       , Whitespace
3272       , Plaintext "2009"
3273       , Whitespace
3274       , Plaintext "(https://wt.pe/h)."
3275       ]
3276   , Paragraph
3277       [ Plaintext "So,"
3278       , Whitespace
3279       , Plaintext "even"
3280       , Whitespace
3281       , Plaintext "though"
3282       , Whitespace
3283       , Plaintext "Ferret"
3284       , Whitespace
3285       , Plaintext "has"
3286       , Whitespace
3287       , Plaintext "a"
3288       , Whitespace
3289       , Plaintext "new"
3290       , Whitespace
3291       , Plaintext "name"
3292       , Whitespace
3293       , Plaintext "now"
3294       , Whitespace
3295       , Plaintext "and"
3296       , Whitespace
3297       , Plaintext "actually"
3298       , Whitespace
3299       , Plaintext "prefers"
3300       , Whitespace
3301       , Code "ag"
3302       , Whitespace
3303       , Plaintext "over"
3304       , Whitespace
3305       , Code "ack"
3306       , Whitespace
3307       , Plaintext "when"
3308       , Whitespace
3309       , Plaintext "available,"
3310       , Whitespace
3311       , Plaintext "I"
3312       , Whitespace
3313       , Plaintext "prefer"
3314       , Whitespace
3315       , Plaintext "to"
3316       , Whitespace
3317       , Plaintext "keep"
3318       , Whitespace
3319       , Plaintext "the"
3320       , Whitespace
3321       , Plaintext "command"
3322       , Whitespace
3323       , Plaintext "names"
3324       , Whitespace
3325       , Plaintext "intact"
3326       , Whitespace
3327       , Plaintext "and"
3328       , Whitespace
3329       , Plaintext "benefit"
3330       , Whitespace
3331       , Plaintext "from"
3332       , Whitespace
3333       , Plaintext "years"
3334       , Whitespace
3335       , Plaintext "of"
3336       , Whitespace
3337       , Plaintext "accumulated"
3338       , Whitespace
3339       , Plaintext "muscle-memory."
3340       ]
3341   , HeadingAnnotation "Related"
3342   , Paragraph
3343       [ Plaintext "Just"
3344       , Whitespace
3345       , Plaintext "as"
3346       , Whitespace
3347       , Plaintext "Ferret"
3348       , Whitespace
3349       , Plaintext "aims"
3350       , Whitespace
3351       , Plaintext "to"
3352       , Whitespace
3353       , Plaintext "improve"
3354       , Whitespace
3355       , Plaintext "the"
3356       , Whitespace
3357       , Plaintext "multi-file"
3358       , Whitespace
3359       , Plaintext "search"
3360       , Whitespace
3361       , Plaintext "and"
3362       , Whitespace
3363       , Plaintext "replace"
3364       , Whitespace
3365       , Plaintext "experience,"
3366       , Whitespace
3367       , Plaintext "Loupe"
3368       , Whitespace
3369       , Plaintext "does"
3370       , Whitespace
3371       , Plaintext "the"
3372       , Whitespace
3373       , Plaintext "same"
3374       , Whitespace
3375       , Plaintext "for"
3376       , Whitespace
3377       , Plaintext "within-file"
3378       , Whitespace
3379       , Plaintext "searching:"
3380       ]
3381   , Paragraph [ Plaintext "https://github.com/wincent/loupe" ]
3382   , HeadingAnnotation "Website"
3383   , Paragraph
3384       [ Plaintext "The"
3385       , Whitespace
3386       , Plaintext "official"
3387       , Whitespace
3388       , Plaintext "Ferret"
3389       , Whitespace
3390       , Plaintext "source"
3391       , Whitespace
3392       , Plaintext "code"
3393       , Whitespace
3394       , Plaintext "repo"
3395       , Whitespace
3396       , Plaintext "is"
3397       , Whitespace
3398       , Plaintext "at:"
3399       ]
3400   , Paragraph [ Plaintext "http://git.wincent.com/ferret.git" ]
3401   , Paragraph
3402       [ Plaintext "A"
3403       , Whitespace
3404       , Plaintext "mirror"
3405       , Whitespace
3406       , Plaintext "exists"
3407       , Whitespace
3408       , Plaintext "at:"
3409       ]
3410   , Paragraph [ Plaintext "https://github.com/wincent/ferret" ]
3411   , Paragraph
3412       [ Plaintext "Official"
3413       , Whitespace
3414       , Plaintext "releases"
3415       , Whitespace
3416       , Plaintext "are"
3417       , Whitespace
3418       , Plaintext "listed"
3419       , Whitespace
3420       , Plaintext "at:"
3421       ]
3422   , Paragraph
3423       [ Plaintext "http://www.vim.org/scripts/script.php?script_id=5220"
3424       ]
3425   , HeadingAnnotation "License"
3426   , Paragraph
3427       [ Plaintext "Copyright"
3428       , Whitespace
3429       , Plaintext "2015-present"
3430       , Whitespace
3431       , Plaintext "Greg"
3432       , Whitespace
3433       , Plaintext "Hurrell."
3434       , Whitespace
3435       , Plaintext "All"
3436       , Whitespace
3437       , Plaintext "rights"
3438       , Whitespace
3439       , Plaintext "reserved."
3440       ]
3441   , Paragraph
3442       [ Plaintext "Redistribution"
3443       , Whitespace
3444       , Plaintext "and"
3445       , Whitespace
3446       , Plaintext "use"
3447       , Whitespace
3448       , Plaintext "in"
3449       , Whitespace
3450       , Plaintext "source"
3451       , Whitespace
3452       , Plaintext "and"
3453       , Whitespace
3454       , Plaintext "binary"
3455       , Whitespace
3456       , Plaintext "forms,"
3457       , Whitespace
3458       , Plaintext "with"
3459       , Whitespace
3460       , Plaintext "or"
3461       , Whitespace
3462       , Plaintext "without"
3463       , Whitespace
3464       , Plaintext "modification,"
3465       , Whitespace
3466       , Plaintext "are"
3467       , Whitespace
3468       , Plaintext "permitted"
3469       , Whitespace
3470       , Plaintext "provided"
3471       , Whitespace
3472       , Plaintext "that"
3473       , Whitespace
3474       , Plaintext "the"
3475       , Whitespace
3476       , Plaintext "following"
3477       , Whitespace
3478       , Plaintext "conditions"
3479       , Whitespace
3480       , Plaintext "are"
3481       , Whitespace
3482       , Plaintext "met:"
3483       ]
3484   , Paragraph
3485       [ Plaintext "1."
3486       , Whitespace
3487       , Plaintext "Redistributions"
3488       , Whitespace
3489       , Plaintext "of"
3490       , Whitespace
3491       , Plaintext "source"
3492       , Whitespace
3493       , Plaintext "code"
3494       , Whitespace
3495       , Plaintext "must"
3496       , Whitespace
3497       , Plaintext "retain"
3498       , Whitespace
3499       , Plaintext "the"
3500       , Whitespace
3501       , Plaintext "above"
3502       , Whitespace
3503       , Plaintext "copyright"
3504       , Whitespace
3505       , Plaintext "notice,"
3506       , Whitespace
3507       , Plaintext "this"
3508       , Whitespace
3509       , Plaintext "list"
3510       , Whitespace
3511       , Plaintext "of"
3512       , Whitespace
3513       , Plaintext "conditions"
3514       , Whitespace
3515       , Plaintext "and"
3516       , Whitespace
3517       , Plaintext "the"
3518       , Whitespace
3519       , Plaintext "following"
3520       , Whitespace
3521       , Plaintext "disclaimer."
3522       , Whitespace
3523       , Plaintext "2."
3524       , Whitespace
3525       , Plaintext "Redistributions"
3526       , Whitespace
3527       , Plaintext "in"
3528       , Whitespace
3529       , Plaintext "binary"
3530       , Whitespace
3531       , Plaintext "form"
3532       , Whitespace
3533       , Plaintext "must"
3534       , Whitespace
3535       , Plaintext "reproduce"
3536       , Whitespace
3537       , Plaintext "the"
3538       , Whitespace
3539       , Plaintext "above"
3540       , Whitespace
3541       , Plaintext "copyright"
3542       , Whitespace
3543       , Plaintext "notice,"
3544       , Whitespace
3545       , Plaintext "this"
3546       , Whitespace
3547       , Plaintext "list"
3548       , Whitespace
3549       , Plaintext "of"
3550       , Whitespace
3551       , Plaintext "conditions"
3552       , Whitespace
3553       , Plaintext "and"
3554       , Whitespace
3555       , Plaintext "the"
3556       , Whitespace
3557       , Plaintext "following"
3558       , Whitespace
3559       , Plaintext "disclaimer"
3560       , Whitespace
3561       , Plaintext "in"
3562       , Whitespace
3563       , Plaintext "the"
3564       , Whitespace
3565       , Plaintext "documentation"
3566       , Whitespace
3567       , Plaintext "and/or"
3568       , Whitespace
3569       , Plaintext "other"
3570       , Whitespace
3571       , Plaintext "materials"
3572       , Whitespace
3573       , Plaintext "provided"
3574       , Whitespace
3575       , Plaintext "with"
3576       , Whitespace
3577       , Plaintext "the"
3578       , Whitespace
3579       , Plaintext "distribution."
3580       ]
3581   , Paragraph
3582       [ Plaintext "THIS"
3583       , Whitespace
3584       , Plaintext "SOFTWARE"
3585       , Whitespace
3586       , Plaintext "IS"
3587       , Whitespace
3588       , Plaintext "PROVIDED"
3589       , Whitespace
3590       , Plaintext "BY"
3591       , Whitespace
3592       , Plaintext "THE"
3593       , Whitespace
3594       , Plaintext "COPYRIGHT"
3595       , Whitespace
3596       , Plaintext "HOLDERS"
3597       , Whitespace
3598       , Plaintext "AND"
3599       , Whitespace
3600       , Plaintext "CONTRIBUTORS"
3601       , Whitespace
3602       , Plaintext "\"AS"
3603       , Whitespace
3604       , Plaintext "IS\""
3605       , Whitespace
3606       , Plaintext "AND"
3607       , Whitespace
3608       , Plaintext "ANY"
3609       , Whitespace
3610       , Plaintext "EXPRESS"
3611       , Whitespace
3612       , Plaintext "OR"
3613       , Whitespace
3614       , Plaintext "IMPLIED"
3615       , Whitespace
3616       , Plaintext "WARRANTIES,"
3617       , Whitespace
3618       , Plaintext "INCLUDING,"
3619       , Whitespace
3620       , Plaintext "BUT"
3621       , Whitespace
3622       , Plaintext "NOT"
3623       , Whitespace
3624       , Plaintext "LIMITED"
3625       , Whitespace
3626       , Plaintext "TO,"
3627       , Whitespace
3628       , Plaintext "THE"
3629       , Whitespace
3630       , Plaintext "IMPLIED"
3631       , Whitespace
3632       , Plaintext "WARRANTIES"
3633       , Whitespace
3634       , Plaintext "OF"
3635       , Whitespace
3636       , Plaintext "MERCHANTABILITY"
3637       , Whitespace
3638       , Plaintext "AND"
3639       , Whitespace
3640       , Plaintext "FITNESS"
3641       , Whitespace
3642       , Plaintext "FOR"
3643       , Whitespace
3644       , Plaintext "A"
3645       , Whitespace
3646       , Plaintext "PARTICULAR"
3647       , Whitespace
3648       , Plaintext "PURPOSE"
3649       , Whitespace
3650       , Plaintext "ARE"
3651       , Whitespace
3652       , Plaintext "DISCLAIMED."
3653       , Whitespace
3654       , Plaintext "IN"
3655       , Whitespace
3656       , Plaintext "NO"
3657       , Whitespace
3658       , Plaintext "EVENT"
3659       , Whitespace
3660       , Plaintext "SHALL"
3661       , Whitespace
3662       , Plaintext "THE"
3663       , Whitespace
3664       , Plaintext "COPYRIGHT"
3665       , Whitespace
3666       , Plaintext "HOLDERS"
3667       , Whitespace
3668       , Plaintext "OR"
3669       , Whitespace
3670       , Plaintext "CONTRIBUTORS"
3671       , Whitespace
3672       , Plaintext "BE"
3673       , Whitespace
3674       , Plaintext "LIABLE"
3675       , Whitespace
3676       , Plaintext "FOR"
3677       , Whitespace
3678       , Plaintext "ANY"
3679       , Whitespace
3680       , Plaintext "DIRECT,"
3681       , Whitespace
3682       , Plaintext "INDIRECT,"
3683       , Whitespace
3684       , Plaintext "INCIDENTAL,"
3685       , Whitespace
3686       , Plaintext "SPECIAL,"
3687       , Whitespace
3688       , Plaintext "EXEMPLARY,"
3689       , Whitespace
3690       , Plaintext "OR"
3691       , Whitespace
3692       , Plaintext "CONSEQUENTIAL"
3693       , Whitespace
3694       , Plaintext "DAMAGES"
3695       , Whitespace
3696       , Plaintext "(INCLUDING,"
3697       , Whitespace
3698       , Plaintext "BUT"
3699       , Whitespace
3700       , Plaintext "NOT"
3701       , Whitespace
3702       , Plaintext "LIMITED"
3703       , Whitespace
3704       , Plaintext "TO,"
3705       , Whitespace
3706       , Plaintext "PROCUREMENT"
3707       , Whitespace
3708       , Plaintext "OF"
3709       , Whitespace
3710       , Plaintext "SUBSTITUTE"
3711       , Whitespace
3712       , Plaintext "GOODS"
3713       , Whitespace
3714       , Plaintext "OR"
3715       , Whitespace
3716       , Plaintext "SERVICES;"
3717       , Whitespace
3718       , Plaintext "LOSS"
3719       , Whitespace
3720       , Plaintext "OF"
3721       , Whitespace
3722       , Plaintext "USE,"
3723       , Whitespace
3724       , Plaintext "DATA,"
3725       , Whitespace
3726       , Plaintext "OR"
3727       , Whitespace
3728       , Plaintext "PROFITS;"
3729       , Whitespace
3730       , Plaintext "OR"
3731       , Whitespace
3732       , Plaintext "BUSINESS"
3733       , Whitespace
3734       , Plaintext "INTERRUPTION)"
3735       , Whitespace
3736       , Plaintext "HOWEVER"
3737       , Whitespace
3738       , Plaintext "CAUSED"
3739       , Whitespace
3740       , Plaintext "AND"
3741       , Whitespace
3742       , Plaintext "ON"
3743       , Whitespace
3744       , Plaintext "ANY"
3745       , Whitespace
3746       , Plaintext "THEORY"
3747       , Whitespace
3748       , Plaintext "OF"
3749       , Whitespace
3750       , Plaintext "LIABILITY,"
3751       , Whitespace
3752       , Plaintext "WHETHER"
3753       , Whitespace
3754       , Plaintext "IN"
3755       , Whitespace
3756       , Plaintext "CONTRACT,"
3757       , Whitespace
3758       , Plaintext "STRICT"
3759       , Whitespace
3760       , Plaintext "LIABILITY,"
3761       , Whitespace
3762       , Plaintext "OR"
3763       , Whitespace
3764       , Plaintext "TORT"
3765       , Whitespace
3766       , Plaintext "(INCLUDING"
3767       , Whitespace
3768       , Plaintext "NEGLIGENCE"
3769       , Whitespace
3770       , Plaintext "OR"
3771       , Whitespace
3772       , Plaintext "OTHERWISE)"
3773       , Whitespace
3774       , Plaintext "ARISING"
3775       , Whitespace
3776       , Plaintext "IN"
3777       , Whitespace
3778       , Plaintext "ANY"
3779       , Whitespace
3780       , Plaintext "WAY"
3781       , Whitespace
3782       , Plaintext "OUT"
3783       , Whitespace
3784       , Plaintext "OF"
3785       , Whitespace
3786       , Plaintext "THE"
3787       , Whitespace
3788       , Plaintext "USE"
3789       , Whitespace
3790       , Plaintext "OF"
3791       , Whitespace
3792       , Plaintext "THIS"
3793       , Whitespace
3794       , Plaintext "SOFTWARE,"
3795       , Whitespace
3796       , Plaintext "EVEN"
3797       , Whitespace
3798       , Plaintext "IF"
3799       , Whitespace
3800       , Plaintext "ADVISED"
3801       , Whitespace
3802       , Plaintext "OF"
3803       , Whitespace
3804       , Plaintext "THE"
3805       , Whitespace
3806       , Plaintext "POSSIBILITY"
3807       , Whitespace
3808       , Plaintext "OF"
3809       , Whitespace
3810       , Plaintext "SUCH"
3811       , Whitespace
3812       , Plaintext "DAMAGE."
3813       ]
3814   , HeadingAnnotation "Development"
3815   , SubheadingAnnotation "Contributing patches"
3816   , Paragraph
3817       [ Plaintext "Patches"
3818       , Whitespace
3819       , Plaintext "can"
3820       , Whitespace
3821       , Plaintext "be"
3822       , Whitespace
3823       , Plaintext "sent"
3824       , Whitespace
3825       , Plaintext "via"
3826       , Whitespace
3827       , Plaintext "mail"
3828       , Whitespace
3829       , Plaintext "to"
3830       , Whitespace
3831       , Plaintext "greg@hurrell.net,"
3832       , Whitespace
3833       , Plaintext "or"
3834       , Whitespace
3835       , Plaintext "as"
3836       , Whitespace
3837       , Plaintext "GitHub"
3838       , Whitespace
3839       , Plaintext "pull"
3840       , Whitespace
3841       , Plaintext "requests"
3842       , Whitespace
3843       , Plaintext "at:"
3844       , Whitespace
3845       , Plaintext "https://github.com/wincent/ferret/pulls"
3846       ]
3847   , SubheadingAnnotation "Cutting a new release"
3848   , Paragraph
3849       [ Plaintext "At"
3850       , Whitespace
3851       , Plaintext "the"
3852       , Whitespace
3853       , Plaintext "moment"
3854       , Whitespace
3855       , Plaintext "the"
3856       , Whitespace
3857       , Plaintext "release"
3858       , Whitespace
3859       , Plaintext "process"
3860       , Whitespace
3861       , Plaintext "is"
3862       , Whitespace
3863       , Plaintext "manual:"
3864       ]
3865   , List
3866       [ ListItem
3867           [ Plaintext "Perform"
3868           , Whitespace
3869           , Plaintext "final"
3870           , Whitespace
3871           , Plaintext "sanity"
3872           , Whitespace
3873           , Plaintext "checks"
3874           , Whitespace
3875           , Plaintext "and"
3876           , Whitespace
3877           , Plaintext "manual"
3878           , Whitespace
3879           , Plaintext "testing"
3880           ]
3881       , ListItem
3882           [ Plaintext "Update"
3883           , Whitespace
3884           , Plaintext "the"
3885           , Whitespace
3886           , Link "ferret-history"
3887           , Whitespace
3888           , Plaintext "section"
3889           , Whitespace
3890           , Plaintext "of"
3891           , Whitespace
3892           , Plaintext "the"
3893           , Whitespace
3894           , Plaintext "documentation"
3895           ]
3896       , ListItem
3897           [ Plaintext "Verify"
3898           , Whitespace
3899           , Plaintext "clean"
3900           , Whitespace
3901           , Plaintext "work"
3902           , Whitespace
3903           , Plaintext "tree:"
3904           ]
3905       ]
3906   , Fenced [ "git status" ]
3907   , List
3908       [ ListItem
3909           [ Plaintext "Tag"
3910           , Whitespace
3911           , Plaintext "the"
3912           , Whitespace
3913           , Plaintext "release:"
3914           ]
3915       ]
3916   , Fenced [ "git tag -s -m \"$VERSION release\" $VERSION" ]
3917   , List
3918       [ ListItem
3919           [ Plaintext "Publish"
3920           , Whitespace
3921           , Plaintext "the"
3922           , Whitespace
3923           , Plaintext "code:"
3924           ]
3925       ]
3926   , Fenced
3927       [ "git push origin master --follow-tags"
3928       , "git push github master --follow-tags"
3929       ]
3930   , List
3931       [ ListItem
3932           [ Plaintext "Produce"
3933           , Whitespace
3934           , Plaintext "the"
3935           , Whitespace
3936           , Plaintext "release"
3937           , Whitespace
3938           , Plaintext "archive:"
3939           ]
3940       ]
3941   , Fenced [ "git archive -o ferret-$VERSION.zip HEAD -- ." ]
3942   , List
3943       [ ListItem
3944           [ Plaintext "Upload"
3945           , Whitespace
3946           , Plaintext "to"
3947           , Whitespace
3948           , Plaintext "http://www.vim.org/scripts/script.php?script_id=5220"
3949           ]
3950       ]
3951   , HeadingAnnotation "Authors"
3952   , Paragraph
3953       [ Plaintext "Ferret"
3954       , Whitespace
3955       , Plaintext "is"
3956       , Whitespace
3957       , Plaintext "written"
3958       , Whitespace
3959       , Plaintext "and"
3960       , Whitespace
3961       , Plaintext "maintained"
3962       , Whitespace
3963       , Plaintext "by"
3964       , Whitespace
3965       , Plaintext "Greg"
3966       , Whitespace
3967       , Plaintext "Hurrell"
3968       , Whitespace
3969       , Plaintext "<greg@hurrell.net>."
3970       ]
3971   , Paragraph
3972       [ Plaintext "The"
3973       , Whitespace
3974       , Plaintext "idea"
3975       , Whitespace
3976       , Plaintext "for"
3977       , Whitespace
3978       , Plaintext "vim-dispatch"
3979       , Whitespace
3980       , Plaintext "integration"
3981       , Whitespace
3982       , Plaintext "was"
3983       , Whitespace
3984       , Plaintext "taken"
3985       , Whitespace
3986       , Plaintext "from"
3987       , Whitespace
3988       , Plaintext "Miles"
3989       , Whitespace
3990       , Plaintext "Sterrett's"
3991       , Whitespace
3992       , Plaintext "ack.vim"
3993       , Whitespace
3994       , Plaintext "plug-in"
3995       , Whitespace
3996       , Plaintext "(https://github.com/mileszs/ack.vim)."
3997       ]
3998   , Paragraph
3999       [ Plaintext "Other"
4000       , Whitespace
4001       , Plaintext "contributors"
4002       , Whitespace
4003       , Plaintext "that"
4004       , Whitespace
4005       , Plaintext "have"
4006       , Whitespace
4007       , Plaintext "submitted"
4008       , Whitespace
4009       , Plaintext "patches"
4010       , Whitespace
4011       , Plaintext "include"
4012       , Whitespace
4013       , Plaintext "(in"
4014       , Whitespace
4015       , Plaintext "alphabetical"
4016       , Whitespace
4017       , Plaintext "order):"
4018       ]
4019   , List
4020       [ ListItem [ Plaintext "Daniel" , Whitespace , Plaintext "Silva" ]
4021       , ListItem [ Plaintext "Joe" , Whitespace , Plaintext "Lencioni" ]
4022       , ListItem
4023           [ Plaintext "Nelo-Thara" , Whitespace , Plaintext "Wallus" ]
4024       , ListItem [ Plaintext "Vaibhav" , Whitespace , Plaintext "Sagar" ]
4025       ]
4026   , HeadingAnnotation "History"
4027   , Paragraph
4028       [ Plaintext "0.3.1"
4029       , Whitespace
4030       , Plaintext "(not"
4031       , Whitespace
4032       , Plaintext "yet"
4033       , Whitespace
4034       , Plaintext "released)"
4035       ]
4036   , List
4037       [ ListItem
4038           [ Plaintext "Fix"
4039           , Whitespace
4040           , Plaintext "broken"
4041           , Whitespace
4042           , Link ":Qargs"
4043           , Whitespace
4044           , Plaintext "command"
4045           , Whitespace
4046           , Plaintext "(patch"
4047           , Whitespace
4048           , Plaintext "from"
4049           , Whitespace
4050           , Plaintext "Daniel"
4051           , Whitespace
4052           , Plaintext "Silva)."
4053           ]
4054       ]
4055   , Paragraph
4056       [ Plaintext "0.3"
4057       , Whitespace
4058       , Plaintext "(24"
4059       , Whitespace
4060       , Plaintext "July"
4061       , Whitespace
4062       , Plaintext "2015)"
4063       ]
4064   , List
4065       [ ListItem
4066           [ Plaintext "Added"
4067           , Whitespace
4068           , Plaintext "highlighting"
4069           , Whitespace
4070           , Plaintext "of"
4071           , Whitespace
4072           , Plaintext "search"
4073           , Whitespace
4074           , Plaintext "pattern"
4075           , Whitespace
4076           , Plaintext "and"
4077           , Whitespace
4078           , Plaintext "related"
4079           , Whitespace
4080           , Link "g:FerretHlsearch"
4081           , Whitespace
4082           , Plaintext "option"
4083           , Whitespace
4084           , Plaintext "(patch"
4085           , Whitespace
4086           , Plaintext "from"
4087           , Whitespace
4088           , Plaintext "Nelo-Thara"
4089           , Whitespace
4090           , Plaintext "Wallus)."
4091           ]
4092       , ListItem