]> granicus.if.org Git - neomutt/commitdiff
docs: skip-quoted
authorRichard Russon <rich@flatcap.org>
Tue, 2 Aug 2016 09:17:55 +0000 (10:17 +0100)
committerRichard Russon <rich@flatcap.org>
Thu, 18 Aug 2016 14:51:02 +0000 (15:51 +0100)
doc/manual.xml.head
doc/muttrc.skip-quoted [new file with mode: 0644]

index d0ba1c20fd68b7aa80e32e857125a58a134f11b9..5704f3087bb23fee8dbbf3b9bb9ceffcee186631 100644 (file)
@@ -11982,6 +11982,127 @@ bind index,pager Q quasi-delete
   </sect2>
 </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.6.2</para></listitem>
+    </itemizedlist>
+
+    <para>This patch is part of the <ulink url="http://www.neomutt.org/">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="http://www.neomutt.org/">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
@@ -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