holm/django-helpdeskmig
1
0
Fork 0
mirror of https://gitea.mueller.network/extern/django-helpdesk.git synced 2024-12-25 16:18:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to include note about installing Markdown

Browse Source
This commit is contained in:
Ross Poulton 2011-02-12 01:21:34 +00:00
parent 8920824a7b
commit c129445ceb
12 changed files with 100 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/doctrees/environment.pickle
View File

Binary file not shown.

BIN
docs/doctrees/index.doctree
View File

Binary file not shown.

BIN
docs/doctrees/install.doctree
View File

Binary file not shown.

BIN
docs/doctrees/license.doctree
View File

Binary file not shown.

11
docs/html/_sources/index.txt
View File

@ -56,6 +56,17 @@ Dependencies
2. Django (1.2 or newer)
3. An existing **working** Django project with database etc. If you cannot log into the Admin, you won't get this product working!
Translation
-----------
.. image:: http://www.transifex.net/projects/p/django-helpdesk/resource/core/chart/image_png
If you want to help translate django-helpdesk into languages other than English, we encourage you to make use of our Transifex project.
http://www.transifex.net/projects/p/django-helpdesk/resource/core/
Feel free to request access to contribute your translations.
Contents:
---------

13
docs/html/_sources/install.txt
View File

@ -45,6 +45,12 @@ Adding To Your Django Project
(r'helpdesk/', include('helpdesk.urls')),
Note that you can change 'helpdesk/' to anything you like, such as 'support/' or 'help/'. If you want django-helpdesk to be available at the root of your site (for example at http://support.mysite.tld/) then the line will be as follows::
(r'', include('helpdesk.urls')),
This line will have to come *after* any other lines in your urls.py such as those used by the Django admin.
3. Create the required database tables. I'd suggest using *South*, however the following will work::
./manage.py syncdb
@ -72,7 +78,10 @@ Adding To Your Django Project
Options -Indexes
You will also have to make sure that ``.htaccess`` files aren't being ignored.
You will also have to make sure that ``.htaccess`` files aren't being ignored.
Ideally, accessing http://MEDIA_URL/helpdesk/attachments/ will give you a 403 access denied error.
Ideally, accessing http://MEDIA_URL/helpdesk/attachments/ will give you a 403 access denied error.
7. If it's not already installed, install ``python-markdown``::
pip install Markdown

25
docs/html/_sources/license.txt
View File

@ -108,3 +108,28 @@ License for akismet.py
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License for flot
----------------
::
Copyright (c) 2007-2009 IOLA and Ole Laursen
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

9
docs/html/index.html
View File

@ -98,6 +98,13 @@
<li>An existing <strong>working</strong> Django project with database etc. If you cannot log into the Admin, you won&#8217;t get this product working!</li>
</ol>
</div>
<div class="section" id="translation">
<h2>Translation<a class="headerlink" href="#translation" title="Permalink to this headline"></a></h2>
<img alt="http://www.transifex.net/projects/p/django-helpdesk/resource/core/chart/image_png" src="http://www.transifex.net/projects/p/django-helpdesk/resource/core/chart/image_png" />
<p>If you want to help translate django-helpdesk into languages other than English, we encourage you to make use of our Transifex project.</p>
<p><a class="reference external" href="http://www.transifex.net/projects/p/django-helpdesk/resource/core/">http://www.transifex.net/projects/p/django-helpdesk/resource/core/</a></p>
<p>Feel free to request access to contribute your translations.</p>
</div>
<div class="section" id="contents">
<h2>Contents:<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
@ -106,6 +113,7 @@
<li class="toctree-l2"><a class="reference internal" href="license.html#license-for-jquery-jquery-ui">License for jQuery &amp; jQuery UI</a></li>
<li class="toctree-l2"><a class="reference internal" href="license.html#license-for-jquery-ui-smoothness-theme">License for jQuery UI &#8216;Smoothness&#8217; theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="license.html#license-for-akismet-py">License for akismet.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="license.html#license-for-flot">License for flot</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
@ -149,6 +157,7 @@
</li>
<li><a class="reference internal" href="#licensing">Licensing</a></li>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#translation">Translation</a></li>
<li><a class="reference internal" href="#contents">Contents:</a><ul>
</ul>
</li>

13
docs/html/install.html
View File

@ -88,6 +88,11 @@
<div class="highlight-python"><div class="highlight"><pre><span class="p">(</span><span class="s">r&#39;helpdesk/&#39;</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="s">&#39;helpdesk.urls&#39;</span><span class="p">)),</span>
</pre></div>
</div>
<p>Note that you can change &#8216;helpdesk/&#8217; to anything you like, such as &#8216;support/&#8217; or &#8216;help/&#8217;. If you want django-helpdesk to be available at the root of your site (for example at <a class="reference external" href="http://support.mysite.tld/">http://support.mysite.tld/</a>) then the line will be as follows:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">(</span><span class="s">r&#39;&#39;</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="s">&#39;helpdesk.urls&#39;</span><span class="p">)),</span>
</pre></div>
</div>
<p>This line will have to come <em>after</em> any other lines in your urls.py such as those used by the Django admin.</p>
</li>
<li><p class="first">Create the required database tables. I&#8217;d suggest using <em>South</em>, however the following will work:</p>
<div class="highlight-python"><pre>./manage.py syncdb</pre>
@ -113,10 +118,14 @@ chmod 700 attachments</pre>
<div class="highlight-python"><div class="highlight"><pre><span class="n">Options</span> <span class="o">-</span><span class="n">Indexes</span>
</pre></div>
</div>
</li>
</ol>
<p>You will also have to make sure that <tt class="docutils literal"><span class="pre">.htaccess</span></tt> files aren&#8217;t being ignored.</p>
<p>Ideally, accessing <a class="reference external" href="http://MEDIA_URL/helpdesk/attachments/">http://MEDIA_URL/helpdesk/attachments/</a> will give you a 403 access denied error.</p>
</li>
<li><p class="first">If it&#8217;s not already installed, install <tt class="docutils literal"><span class="pre">python-markdown</span></tt>:</p>
<div class="highlight-python"><pre>pip install Markdown</pre>
</div>
</li>
</ol>
</div>
</div>

27
docs/html/license.html
View File

@ -164,6 +164,32 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
</dd>
</dl>
</div>
<div class="section" id="license-for-flot">
<h2>License for flot<a class="headerlink" href="#license-for-flot" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>::</dt>
<dd><p class="first">Copyright (c) 2007-2009 IOLA and Ole Laursen</p>
<p>Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the &#8220;Software&#8221;), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:</p>
<p>The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.</p>
<p class="last">THE SOFTWARE IS PROVIDED &#8220;AS IS&#8221;, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.</p>
</dd>
</dl>
</div>
</div>
@ -178,6 +204,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
<li><a class="reference internal" href="#license-for-jquery-jquery-ui">License for jQuery &amp; jQuery UI</a></li>
<li><a class="reference internal" href="#license-for-jquery-ui-smoothness-theme">License for jQuery UI &#8216;Smoothness&#8217; theme</a></li>
<li><a class="reference internal" href="#license-for-akismet-py">License for akismet.py</a></li>
<li><a class="reference internal" href="#license-for-flot">License for flot</a></li>
</ul>
</li>
</ul>

2
docs/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

7
docs/source/install.rst
View File

@ -78,7 +78,10 @@ Adding To Your Django Project
Options -Indexes
You will also have to make sure that ``.htaccess`` files aren't being ignored.
You will also have to make sure that ``.htaccess`` files aren't being ignored.
Ideally, accessing http://MEDIA_URL/helpdesk/attachments/ will give you a 403 access denied error.
Ideally, accessing http://MEDIA_URL/helpdesk/attachments/ will give you a 403 access denied error.
7. If it's not already installed, install ``python-markdown``::
pip install Markdown