Merged branch 'documentation'. Fixes issue #17.

Author: andrewscaya

docs/_build/.doctrees/advanced_options.doctree

@@ -8,10 +8,12 @@ Advanced configuration options
 Caching
 -------
 
-**Use global** means that this module's content will be cached according to your Joomla's global cache setings.
+**Use global** means that this module's content will be cached according to your Joomla's global cache settings.
 
 **No caching** means that no content from this module will be cached.
 
+This option is provided by `Joomla <https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced>`_.
+
 .. index:: Form Instance
 
 Form Instance
@@ -91,13 +93,13 @@ Captcha Use
 With the **JForm** type:
 
 To be able to use Captcha, you can follow the procedure on the `Joomla Website
-<https://docs.joomla.org/How_do_you_use_Recaptcha_in_Joomla%3F>`_
+<https://docs.joomla.org/How_do_you_use_Recaptcha_in_Joomla%3F>`_.
 
 This will produce a captcha looking like this:
 
 .. image:: /images/advanced_options01.png
 
-.. note:: If you don't have a Google account and don't want to create one, you can use a Captcha extension available in the `Joomla Extenstions Directory <https://extensions.joomla.org/tags/captcha>`_.
+.. note:: If you don't have a Google account and don't want to create one, you can use a Captcha extension available in the `Joomla Extensions Directory <https://extensions.joomla.org/tags/captcha>`_.
 
 With the **Classic** form type:
 
@@ -201,6 +203,8 @@ Name of Anchor Tag
 After submitting the form, the user is redirected to the anchor tag mentioned here.
 By default, this tag is placed at the beginning of the form.
 
+The name of the tag must start with #. Example : #tag
+
 .. index:: Number of Upload Fields
 
 Number of Upload Fields
@@ -298,32 +302,32 @@ modify the module's display.
 Module Tag
 ----------
 
-The html tag used for the module.
+The html tag used for the module. This option is provided by `Joomla <https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced>`_.
 
 .. index:: Bootstrap Size
 
 Bootstrap Size
 --------------
 
-The number of columns used in the module.
+The number of columns used in the module. This option is provided by `Joomla <https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced>`_.
 
 .. index:: Header Tag
 
 Header Tag
 ----------
 
-The HTML tag used for module headers and titles.
+The HTML tag used for module headers and titles. This option is provided by `Joomla <https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced>`_.
 
 .. index:: Header Class
 
 Header Class
 ------------
 
-The CSS class used for module headers and titles.
+The CSS class used for module headers and titles. This option is provided by `Joomla <https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced>`_.
 
 .. index:: Module Style
 
 Module Style
 ------------
 
-This option is used to override the template style.
+The option used to override the template style. It is provided by `Joomla <https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced>`_.

docs/_build/.doctrees/basic_options.doctree

@@ -14,11 +14,11 @@ Form type
 
 First, the form type must be chosen.
 
+**JForm** is the most recent version that integrates new Joomla requirements.
+
 **Classic** shows the form as it used to be.
 This option is deprecated and won't be available in version 3.0 of the module.
 
-**JForm** is the most recent version that integrates new Joomla requirements.
-
 .. image:: /images/basic_options02.png
 
 .. index:: Language
@@ -29,11 +29,11 @@ You can then set the language used in the form.
 Language files can be found and edited at
 ``/path/to/joomla/modules/mod_simpleemailform/language_files``.
 
-You can choose from 30 different languages.
+Thirty languages are available.
 
 .. image:: /images/basic_options03.png
 
-.. note:: The module is now integrated with Joomla native language support.
+.. note:: The module is now integrated with Joomla native language support, so this field has no effect on the JForm type.
 
 .. index:: Send Results To
 .. index:: Email address

docs/_build/.doctrees/environment.pickle

@@ -8,6 +8,8 @@ Installation
 Here is the installation procedure for Joomla 3.x.  The procedure is very
 similar for Joomla 2.5, but the screens look slightly different.
 
+Download the module on the `Simple Email Form page <http://joomla.unlikelysource.org/>`_.
+
 Login as the Joomla administrator
 
 .. image:: /images/installation01.png

docs/_build/.doctrees/installation.doctree

@@ -55,8 +55,9 @@ <h3>Navigation</h3>
 <span id="advancedoptionsanchor"></span><h1>Advanced configuration options<a class="headerlink" href="#advanced-configuration-options" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="caching">
 <span id="index-0"></span><h2>Caching<a class="headerlink" href="#caching" title="Permalink to this headline">¶</a></h2>
-<p><strong>Use global</strong> means that this module&#8217;s content will be cached according to your Joomla&#8217;s global cache setings.</p>
+<p><strong>Use global</strong> means that this module&#8217;s content will be cached according to your Joomla&#8217;s global cache settings.</p>
 <p><strong>No caching</strong> means that no content from this module will be cached.</p>
+<p>This option is provided by <a class="reference external" href="https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced">Joomla</a>.</p>
 </div>
 <div class="section" id="form-instance">
 <span id="index-1"></span><h2>Form Instance<a class="headerlink" href="#form-instance" title="Permalink to this headline">¶</a></h2>
@@ -105,12 +106,12 @@ <h3>Navigation</h3>
 <div class="section" id="captcha-use">
 <span id="index-10"></span><h2>Captcha Use<a class="headerlink" href="#captcha-use" title="Permalink to this headline">¶</a></h2>
 <p>With the <strong>JForm</strong> type:</p>
-<p>To be able to use Captcha, you can follow the procedure on the <a class="reference external" href="https://docs.joomla.org/How_do_you_use_Recaptcha_in_Joomla%3F">Joomla Website</a></p>
+<p>To be able to use Captcha, you can follow the procedure on the <a class="reference external" href="https://docs.joomla.org/How_do_you_use_Recaptcha_in_Joomla%3F">Joomla Website</a>.</p>
 <p>This will produce a captcha looking like this:</p>
 <img alt="_images/advanced_options01.png" src="_images/advanced_options01.png" />
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
-<p class="last">If you don&#8217;t have a Google account and don&#8217;t want to create one, you can use a Captcha extension available in the <a class="reference external" href="https://extensions.joomla.org/tags/captcha">Joomla Extenstions Directory</a>.</p>
+<p class="last">If you don&#8217;t have a Google account and don&#8217;t want to create one, you can use a Captcha extension available in the <a class="reference external" href="https://extensions.joomla.org/tags/captcha">Joomla Extensions Directory</a>.</p>
 </div>
 <p>With the <strong>Classic</strong> form type:</p>
 <p>Set to <strong>No Captcha</strong> if you don&#8217;t want any Captcha protection.</p>
@@ -170,6 +171,7 @@ <h3>Navigation</h3>
 <span id="index-22"></span><h2>Name of Anchor Tag<a class="headerlink" href="#name-of-anchor-tag" title="Permalink to this headline">¶</a></h2>
 <p>After submitting the form, the user is redirected to the anchor tag mentioned here.
 By default, this tag is placed at the beginning of the form.</p>
+<p>The name of the tag must start with #. Example : #tag</p>
 </div>
 <div class="section" id="number-of-upload-fields">
 <span id="index-23"></span><h2>Number of Upload Fields<a class="headerlink" href="#number-of-upload-fields" title="Permalink to this headline">¶</a></h2>
@@ -233,23 +235,23 @@ <h3>Navigation</h3>
 </div>
 <div class="section" id="module-tag">
 <span id="index-35"></span><h2>Module Tag<a class="headerlink" href="#module-tag" title="Permalink to this headline">¶</a></h2>
-<p>The html tag used for the module.</p>
+<p>The html tag used for the module. This option is provided by <a class="reference external" href="https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced">Joomla</a>.</p>
 </div>
 <div class="section" id="bootstrap-size">
 <span id="index-36"></span><h2>Bootstrap Size<a class="headerlink" href="#bootstrap-size" title="Permalink to this headline">¶</a></h2>
-<p>The number of columns used in the module.</p>
+<p>The number of columns used in the module. This option is provided by <a class="reference external" href="https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced">Joomla</a>.</p>
 </div>
 <div class="section" id="header-tag">
 <span id="index-37"></span><h2>Header Tag<a class="headerlink" href="#header-tag" title="Permalink to this headline">¶</a></h2>
-<p>The HTML tag used for module headers and titles.</p>
+<p>The HTML tag used for module headers and titles. This option is provided by <a class="reference external" href="https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced">Joomla</a>.</p>
 </div>
 <div class="section" id="header-class">
 <span id="index-38"></span><h2>Header Class<a class="headerlink" href="#header-class" title="Permalink to this headline">¶</a></h2>
-<p>The CSS class used for module headers and titles.</p>
+<p>The CSS class used for module headers and titles. This option is provided by <a class="reference external" href="https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced">Joomla</a>.</p>
 </div>
 <div class="section" id="module-style">
 <span id="index-39"></span><h2>Module Style<a class="headerlink" href="#module-style" title="Permalink to this headline">¶</a></h2>
-<p>This option is used to override the template style.</p>
+<p>The option used to override the template style. It is provided by <a class="reference external" href="https://docs.joomla.org/Help36:Extensions_Module_Manager_Tags_Popular#Advanced">Joomla</a>.</p>
 </div>
 </div>
 

docs/_build/_sources/advanced_options.rst.txt

@@ -61,21 +61,21 @@ <h3>Navigation</h3>
 <div class="section" id="form-type">
 <span id="index-0"></span><h2>Form type<a class="headerlink" href="#form-type" title="Permalink to this headline">¶</a></h2>
 <p>First, the form type must be chosen.</p>
+<p><strong>JForm</strong> is the most recent version that integrates new Joomla requirements.</p>
 <p><strong>Classic</strong> shows the form as it used to be.
 This option is deprecated and won&#8217;t be available in version 3.0 of the module.</p>
-<p><strong>JForm</strong> is the most recent version that integrates new Joomla requirements.</p>
 <img alt="_images/basic_options02.png" src="_images/basic_options02.png" />
 </div>
 <div class="section" id="language">
 <span id="index-1"></span><h2>Language<a class="headerlink" href="#language" title="Permalink to this headline">¶</a></h2>
 <p>You can then set the language used in the form.
 Language files can be found and edited at
 <code class="docutils literal"><span class="pre">/path/to/joomla/modules/mod_simpleemailform/language_files</span></code>.</p>
-<p>You can choose from 30 different languages.</p>
+<p>Thirty languages are available.</p>
 <img alt="_images/basic_options03.png" src="_images/basic_options03.png" />
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
-<p class="last">The module is now integrated with Joomla native language support.</p>
+<p class="last">The module is now integrated with Joomla native language support, so this field has no effect on the JForm type.</p>
 </div>
 <span class="target" id="index-2"></span></div>
 <div class="section" id="email-address">

docs/_build/_sources/basic_options.rst.txt

@@ -55,6 +55,7 @@ <h3>Navigation</h3>
 <span id="installationanchor"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
 <p id="index-0">Here is the installation procedure for Joomla 3.x.  The procedure is very
 similar for Joomla 2.5, but the screens look slightly different.</p>
+<p>Download the module on the <a class="reference external" href="http://joomla.unlikelysource.org/">Simple Email Form page</a>.</p>
 <p>Login as the Joomla administrator</p>
 <img alt="_images/installation01.png" src="_images/installation01.png" />
 <p>Select <code class="docutils literal"><span class="pre">Extensions</span></code> - <code class="docutils literal"><span class="pre">Manage</span></code> - <code class="docutils literal"><span class="pre">Install</span></code></p>