From: Richard Russon <rich@flatcap.org>
Date: Mon, 1 Aug 2016 23:39:39 +0000 (+0100)
Subject: docs: initials
X-Git-Tag: neomutt-20160822~24^2~15
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e15e98979aa4cd785cfffcab5026df613d116056;p=neomutt

docs: initials
---

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 640cc82e7..0b6d1223d 100644
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -9480,6 +9480,132 @@ color index_size cyan default
   </sect2>
 </sect1>
 
+<sect1 id="initials">
+  <title>Initials Expando Patch</title>
+  <subtitle>Expando for author's initials</subtitle>
+
+  <sect2 id="initials-patch">
+    <title>Patch</title>
+
+    <para>
+      To check if Mutt supports <quote>Initials</quote>, look for
+      <quote>patch-initials</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="initials-intro">
+    <title>Introduction</title>
+
+        <para>
+    The <quote>initials</quote> patch adds an expando (%I) for an author's
+    initials.
+        </para>
+
+    <para>
+    The index panel displays a list of emails.  Its layout is controlled by
+    the <link linkend="index-format">$index_format</link> variable.  Using
+    this expando saves space in the index panel.  This can be useful if you
+    are regularly working with a small set of people.
+    </para>
+  </sect2>
+
+  <sect2 id="initials-variables">
+    <title>Variables</title>
+
+        <para>
+        This patch has no config of its own.  It adds an expando which can be
+    used in the <link linkend="index-format">$index_format</link> variable.
+        </para>
+  </sect2>
+
+<!--
+  <sect2 id="initials-functions">
+    <title>Functions</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="initials-commands">
+    <title>Commands</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="initials-colors">
+    <title>Colors</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="initials-sort">
+    <title>Sort</title>
+    <para>None</para>
+  </sect2>
+-->
+
+  <sect2 id="initials-muttrc">
+    <title>Muttrc</title>
+<screen>
+<emphasis role="comment"># Example Mutt config file for the 'initials' patch.
+ 
+# The 'initials' patch has no config of its own.
+# It adds an expando for an author's initials,
+# which can be used in the 'index_format' variable.
+ 
+# The default 'index_format' is:</emphasis>
+set index_format='%4C %Z %{%b %d} %-15.15L (%?l?%4l&amp;%4c?) %s'
+ 
+<emphasis role="comment"># Where %L represents the author/recipient
+ 
+# This might look like:
+#       1   + Nov 17 David Bowie   Changesbowie    ( 689)
+#       2   ! Nov 17 Stevie Nicks  Rumours         ( 555)
+#       3   + Nov 16 Jimi Hendrix  Voodoo Child    ( 263)
+#       4   + Nov 16 Debbie Harry  Parallel Lines  ( 540)
+ 
+# Using the %I expando:</emphasis>
+set index_format='%4C %Z %{%b %d} %I (%?l?%4l&amp;%4c?) %s'
+ 
+<emphasis role="comment"># This might look like:
+#       1   + Nov 17 DB Changesbowie    ( 689)
+#       2   ! Nov 17 SN Rumours         ( 555)
+#       3   + Nov 16 JH Voodoo Child    ( 263)
+#       4   + Nov 16 DH Parallel Lines  ( 540)
+ 
+# vim: syntax=muttrc</emphasis>
+</screen>
+  </sect2>
+
+  <sect2 id="initials-see-also">
+    <title>See Also</title>
+
+    <itemizedlist>
+      <listitem><para><ulink url="http://www.neomutt.org/">NeoMutt Project</ulink></para></listitem>
+      <listitem><para><link linkend="index-format">$index_format</link></para></listitem>
+      <listitem><para><link linkend="index-color">index-color patch</link></para></listitem>
+      <listitem><para><link linkend="folder-hook">folder-hook</link></para></listitem>
+    </itemizedlist>
+  </sect2>
+
+  <sect2 id="initials-known-bugs">
+    <title>Known Bugs</title>
+    <para>None</para>
+  </sect2>
+
+  <sect2 id="initials-credits">
+    <title>Credits</title>
+    <itemizedlist>
+    <listitem><para>Vsevolod Volkov <email>vvv@mutt.org.ua</email></para></listitem>
+    <listitem><para>Richard Russon <email>rich@flatcap.org</email></para></listitem>
+    </itemizedlist>
+  </sect2>
+</sect1>
+
 <sect1 id="sidebar">
   <title>Sidebar</title>
   <subtitle>Overview of mailboxes</subtitle>
diff --git a/doc/muttrc.initials b/doc/muttrc.initials
new file mode 100644
index 000000000..644c1b7fd
--- /dev/null
+++ b/doc/muttrc.initials
@@ -0,0 +1,27 @@
+# Example Mutt config file for the 'initials' patch.
+
+# The 'initials' patch has no config of its own.
+# It adds an expando for an author's initials,
+# which can be used in the 'index_format' variable.
+
+# The default 'index_format' is:
+set index_format='%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s'
+
+# Where %L represents the author/recipient
+
+# This might look like:
+#       1   + Nov 17 David Bowie   Changesbowie    ( 689)
+#       2   ! Nov 17 Stevie Nicks  Rumours         ( 555)
+#       3   + Nov 16 Jimi Hendrix  Voodoo Child    ( 263)
+#       4   + Nov 16 Debbie Harry  Parallel Lines  ( 540)
+
+# Using the %I expando:
+set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s'
+
+# This might look like:
+#       1   + Nov 17 DB Changesbowie    ( 689)
+#       2   ! Nov 17 SN Rumours         ( 555)
+#       3   + Nov 16 JH Voodoo Child    ( 263)
+#       4   + Nov 16 DH Parallel Lines  ( 540)
+
+# vim: syntax=muttrc