add docs

diff --git a/README.skip-quoted b/README.skip-quoted
new file mode 100644 (file)
index 0000000..666e98e
--- /dev/null
+++ b/README.skip-quoted
@@ -0,0 +1,47 @@
+Skip-Quoted Patch
+=================
+
+    Leave some context visible
+
+Patch
+-----
+
+    To check if Mutt supports "Skip-Quoted", look for "patch-skip-quoted" in
+    the mutt version.
+
+    Dependencies
+    * mutt-1.5.24
+
+Introduction
+------------
+
+    When viewing an email, the '<skip-to-quoted>' function (by default the 'S'
+    key) will scroll past any quoted text. Sometimes, a little context is
+    useful.
+
+    By setting the '$skip_quoted_offset' variable, you can select how much of
+    the quoted text is left visible.
+
+Variables
+---------
+
+    | Name                 | Type   | Default |
+    |----------------------|--------|---------|
+    | 'skip_quoted_offset' | number | 0       |
+
+See Also
+--------
+
+    * NeoMutt project
+
+Known Bugs
+----------
+
+    None
+
+Credits
+-------
+
+    * David Sterba <dsterba@suse.cz>
+    * Richard Russon <rich@flatcap.org>
+

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index b90908f001610306861479d3bc7440f848d5e17c..ffe805fe2a060ff5032d59925d0ca344127f9fd3 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -8081,6 +8081,127 @@ please have a look at the mixmaster documentation.
 
 </sect1>
 
+<sect1 id="skip-quoted-patch">
+       <title>Skip-Quoted Patch</title>
+       <subtitle>Leave some context visible</subtitle>
+
+       <sect2 id="skip-quoted-patch2">
+               <title>Patch</title>
+
+               <para>
+                       To check if Mutt supports <quote>skip-quoted</quote>, look for
+                       <quote>patch-skip-quoted</quote> in the mutt version.
+                       See: <xref linkend="mutt-patches"/>.
+               </para>
+
+               <itemizedlist>
+                       <title>Dependencies:</title>
+                       <listitem><para>mutt-1.5.24</para></listitem>
+               </itemizedlist>
+
+               <para>This patch is part of the <ulink url="https://github.com/neomutt/neomutt/wiki">NeoMutt Project</ulink>.</para>
+       </sect2>
+
+       <sect2 id="skip-quoted-intro">
+               <title>Introduction</title>
+
+               <para>
+                       When viewing an email, the
+                       <literal>&lt;skip-to-quoted&gt;</literal> function (by default the
+                       <literal>S</literal> key) will scroll past any quoted text.
+                       Sometimes, a little context is useful.
+               </para>
+
+               <para>
+                       By setting the <literal>$skip_quoted_offset</literal> variable, you
+                       can select how much of the quoted text is left visible.
+               </para>
+       </sect2>
+
+       <sect2 id="skip-quoted-variables">
+               <title>Variables</title>
+               <table id="table-skip-quoted-variables">
+                       <title>Skip-Quoted Variables</title>
+                       <tgroup cols="3">
+                               <thead>
+                                       <row>
+                                               <entry>Name</entry>
+                                               <entry>Type</entry>
+                                               <entry>Default</entry>
+                                       </row>
+                               </thead>
+                               <tbody>
+                                       <row>
+                                               <entry><literal>skip_quoted_offset</literal></entry>
+                                               <entry>number</entry>
+                                               <entry>0</entry>
+                                       </row>
+                               </tbody>
+                       </tgroup>
+               </table>
+       </sect2>
+
+<!--
+       <sect2 id="skip-quoted-functions">
+               <title>Functions</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="skip-quoted-commands">
+               <title>Commands</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="skip-quoted-colors">
+               <title>Colors</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="skip-quoted-sort">
+               <title>Sort</title>
+               <para>None</para>
+       </sect2>
+-->
+
+       <sect2 id="skip-quoted-muttrc">
+               <title>Muttrc</title>
+
+<screen>
+<emphasis role="comment"># Example Mutt config file for the 'skip-quoted' patch.
+ 
+# The 'S' (skip-quoted) command scrolls the pager past the quoted text (usually
+# indented with '&gt; '.  Setting 'skip_quoted_offset' leaves some lines of quoted
+# text on screen for context.
+ 
+# Show three quoted lines before the reply</emphasis>
+set skip_quoted_offset = 3
+ 
+<emphasis role="comment"># vim: syntax=muttrc</emphasis>
+</screen>
+       </sect2>
+
+       <sect2 id="skip-quoted-see-also">
+               <title>See Also</title>
+
+               <itemizedlist>
+                       <listitem><para><ulink url="https://github.com/neomutt/neomutt/wiki">NeoMutt Project</ulink></para></listitem>
+               </itemizedlist>
+       </sect2>
+
+       <sect2 id="skip-quoted-known-bugs">
+               <title>Known Bugs</title>
+               <para>None</para>
+       </sect2>
+
+       <sect2 id="skip-quoted-credits">
+               <title>Credits</title>
+               <itemizedlist>
+               <listitem><para>David Sterba <email>dsterba@suse.cz</email></para></listitem>
+               <listitem><para>Richard Russon <email>rich@flatcap.org</email></para></listitem>
+               </itemizedlist>
+       </sect2>
+</sect1>
+
 </chapter>
 
 <chapter id="security">

diff --git a/doc/muttrc.skip-quoted b/doc/muttrc.skip-quoted
new file mode 100644 (file)
index 0000000..cd13ed4
--- /dev/null
+++ b/doc/muttrc.skip-quoted
@@ -0,0 +1,10 @@
+# Example Mutt config file for the 'skip-quoted' patch.
+ 
+# The 'S' (skip-quoted) command scrolls the pager past the quoted text (usually
+# indented with '> '.  Setting 'skip_quoted_offset' leaves some lines of quoted
+# text on screen for context.
+ 
+# Show three quoted lines before the reply
+set skip_quoted_offset = 3
+ 
+# vim: syntax=muttrc