summaryrefslogtreecommitdiff
path: root/support/gtex-letter/manual/html/advanced-features.html
diff options
context:
space:
mode:
Diffstat (limited to 'support/gtex-letter/manual/html/advanced-features.html')
-rw-r--r--support/gtex-letter/manual/html/advanced-features.html162
1 files changed, 162 insertions, 0 deletions
diff --git a/support/gtex-letter/manual/html/advanced-features.html b/support/gtex-letter/manual/html/advanced-features.html
new file mode 100644
index 0000000000..01b7d86a65
--- /dev/null
+++ b/support/gtex-letter/manual/html/advanced-features.html
@@ -0,0 +1,162 @@
+<HTML><HEAD><TITLE>Gtex-Letter User Manual</TITLE>
+
+<LINK REL="HOME" TITLE="Gtex-Letter User Manual" HREF="index.html">
+<LINK REL="PREVIOUS" TITLE="" HREF="rc-files.html">
+<LINK REL="NEXT" TITLE="" HREF="">
+
+</HEAD><BODY>
+
+<DIV CLASS="NAVHEADER">
+
+<TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0">
+
+<TR> <TH COLSPAN="3" ALIGN="center">Gtex-Letter User Manual</TH></TR>
+
+<TR><TD WIDTH="10%" ALIGN="left" VALIGN="bottom"><A HREF="rc-files.html">Prev</A></TD>
+
+ <TD WIDTH="80%" ALIGN="center" VALIGN="bottom"></TD>
+ <TD WIDTH="10%" ALIGN="right" VALIGN="bottom"><A HREF=""></A></TD>
+
+</TR></TABLE>
+
+<HR ALIGN="LEFT" WIDTH="100%"></DIV><DIV CLASS="CHAPTER"><H1><A NAME="advanced-featrues">The Advanced Features</A></H1>
+
+<DIV CLASS="TOC"><DL>
+
+<DT><B>Table of Contents</B></DT>
+<DT><A HREF="advanced-features.html#sex-adoption">Automatic Adoption to the Sex of the Addressee</A></DT>
+<DT><A HREF="advanced-features.html#filenames">Paths and Filenames</A></DT>
+<DT><A HREF="advanced-features.html#noninteractive">The Non-Interactive Mode</A></DT>
+
+</DL></DIV>
+
+<P>&nbsp;</P>
+
+<DIV CLASS="SECT1"><H1 CLASS="SECT1"><A NAME="sex-adoption">Automatic Adoption to the Sex of the Addressee</A></H1>
+
+<P>
+ One of the prime features of gtex-letter is its configurable adoption
+ to the sex of the addressee of you letter. This is helpful in most
+ languages. For example in German, where the ending of adjectives depends
+ on the person's sex the adjective is connected to.</P>
+
+<P>
+ Therefore you write <i class="EMPHASIS">"Sehr geehrte Frau Schneider"</i> and <i class="EMPHASIS">"Sehr geehrter Herr Schulze"</i>. Accordingly it is <i class="EMPHASIS">"Estimada Sra. Gonzalez"</i> and <i class="EMPHASIS">"Estimado Sr. Ortega"</i> in Spanish. Of course, you do not want to make this adoption yourself; especially not in serial letters.</P>
+
+<P>
+ Gtex-letter will take care of it automatically, if you configure it in a proper way and if you use the addressbook for the selection of an addressee. Use one of the language-specific <A HREF="rc-files.html#various-files">rc-files</A> for a start. However, you can easily enhance the setting.</P>
+
+<P>
+ There is a kind of pattern matching included in the programm. Such a clause looks like this:</P>
+
+<P><i class="EMPHASIS">"Sehr geehrte[__name_prefix__='Herr':'r'] __name_prefix__ __lastname__,"</i></P>
+
+<P>
+ The part in braces is optional. It reads: If the prefix is equal to 'Herr', add an 'r'. Therefore, if the person is a female ('Frau'), nothing is added. This depends on the entries in your addressbook. It adopts only if you select one of the addressbook entries. If you enter an address directly into the <A HREF="gui.html#address-page">addressfield</A>, you have to take care of the sec yourself.</P>
+
+<p>
+ Also more complex clauses are possible. This is the default Spanish one:</P>
+
+<P><i class="EMPHASIS">"Estimad[__name_prefix__='Sr.':'o'][__name_prefix__='D.':'o'][__name_prefix__='Sra.':'a']<br>[__name_prefix__='Sta.':'a'][__name_prefix__='Dña.':'a'] __name_prefix__ __lastname__,"</i></P>
+
+<P>
+ It takes care of the multiple forms of common prefixes.</P>
+
+
+</DIV>
+
+<P>&nbsp;</P>
+
+<DIV CLASS="SECT1"><H1 CLASS="SECT1"><A NAME="filenames">Paths and Filenames</A></H1>
+
+
+<p>
+ In the standard setup, gtex-letter will use your home directory as the stanard
+ save your letter. Using the
+ <a href="rc-files.html#filename_guess_path">filename-guess-path-option</a>,
+ you set a different default path. (XXX: So far this only works for filename
+ guessing. It is planned to update that behavior to manually choosen filenames
+ too.)</P>
+
+<p>
+ Most of the time it is annoying to choose a filename by yourself. With gtex-letter,
+ you can let the application choose one. If you think it does not fit, you
+ can set a different one. Gtex-letter will just guess a filename, therefore
+ this feature is called filename-guessing. It depends on the
+ <a href="rc-files.html#filename_guess_path">filename-guess-path-option</a> and
+ the <a href="rc-files.html#filename_guess_format">filename-guess-format-option</a>.
+ With the latter you can define the way gtex-letter guesses the filename.
+ Let me present a few useful formats to you:</P>
+
+<p><i class="EMPHASIS">__subject__-__date__.tex</i></p>
+
+<p>
+ This one will set filename equal to the subject and the date, connected by
+ a hyphen. The suffix of the files should always be tex. Please remember,
+ that empty spaces, colons and slashes will all be converted to underscores.</p>
+
+
+<p><i class="EMPHASIS">__id____date__.tex</i></p>
+
+<p>
+ Using this clause, you command gtex-letter to make a filename out of the addressbook-id and the date.</p>
+
+
+<p><i class="EMPHASIS">[__id__-][__subject__-]__date__.tex</i></p>
+
+<p>
+ This format uses optional clauses. If you did not choose an address from the
+ addressbook, the id and the hyphen will be omitted. The id would be omitted anyways
+ of course, but using the braces, you make clear to set the hyphen just in
+ case an id is set. The same holds for the subject. If it is empty, no subject and
+ no hyphen will be used.</p>
+
+</DIV>
+
+<P>&nbsp;</P>
+
+<DIV CLASS="SECT1"><H1 CLASS="SECT1"><A NAME="noninteractive">The Non-Interactive Mode</A></H1>
+
+<p>
+ Gtex-letter comes with a non-interactive mode, that can be called from the
+ console. Use the <i class="EMPHASIS">-n/--nogui-option</i> to call it. Of course
+ you have submit enough information to produce a successful letter. We will let
+ it up to you to find out what fancy things you can do with this feature.
+ Just a hint about its power:</p>
+
+
+<p><i class="EMPHASIS">gtex-letter --address ted_baker --opening 'Dear Mr. Baker' --closing 'Yours sincerely' --file ~/letters/we_have_moved --nogui --noshow --print</i></p>
+
+<p>
+ This will create a letter for Ted Baker, with supplied opening and closing.
+ The text of the letter will be taken from the file 'we_have_moved'. The letter
+ will be assembles non-interactively and will be sent to the printer directly,
+ without showing it first.</p>
+
+
+
+
+</DIV>
+
+<DIV CLASS="NAVFOOTER">
+
+<HR ALIGN="LEFT" WIDTH="100%">
+
+<TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0">
+
+<TR>
+<TD WIDTH="33%" ALIGN="left" VALIGN="top"><A HREF="rc-files.html">Prev</A></TD>
+<TD WIDTH="34%" ALIGN="center" VALIGN="top"><A HREF="index.html">Home</A></TD>
+<TD WIDTH="33%" ALIGN="right" VALIGN="top"><A HREF=""></A></TD>
+</TR>
+
+<TR>
+<TD WIDTH="33%" ALIGN="left" VALIGN="top">The Configuration Files</TD>
+<TD WIDTH="34%" ALIGN="center" VALIGN="top">&nbsp;</TD>
+<TD WIDTH="33%" ALIGN="right" VALIGN="top"></TD>
+</TR>
+
+</TABLE>
+</DIV>
+</BODY>
+</HTML>