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