mirror of
https://github.com/Hopiu/django-markdownx.git
synced 2026-03-17 05:50:23 +00:00
311 lines
No EOL
14 KiB
HTML
311 lines
No EOL
14 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>markdownx.views — Django Markdownx 2.0.0 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="index" title="Index"
|
|
href="../../genindex.html"/>
|
|
<link rel="search" title="Search" href="../../search.html"/>
|
|
<link rel="top" title="Django Markdownx 2.0.0 documentation" href="../../index.html"/>
|
|
<link rel="up" title="Module code" href="../index.html"/>
|
|
|
|
|
|
<script src="../../_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="../../index.html" class="icon icon-home"> Django Markdownx
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
2.0
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../getting_started.html">Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../example.html">Example</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../customization.html">Customization</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../translation.html">Translation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../js/js.html">JavaScript</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../markdownx/markdownx.html">MarkdownX Modules</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../index.html">Django Markdownx</a>
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../../index.html">Docs</a> »</li>
|
|
|
|
<li><a href="../index.html">Module code</a> »</li>
|
|
|
|
<li>markdownx.views</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<h1>Source code for markdownx.views</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span> <span class="nn">django.http</span> <span class="k">import</span> <span class="n">HttpResponse</span><span class="p">,</span> <span class="n">JsonResponse</span>
|
|
<span class="kn">from</span> <span class="nn">django.utils.module_loading</span> <span class="k">import</span> <span class="n">import_string</span>
|
|
<span class="kn">from</span> <span class="nn">django.views.generic.edit</span> <span class="k">import</span> <span class="n">View</span><span class="p">,</span> <span class="n">FormView</span><span class="p">,</span> <span class="n">BaseFormView</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">.forms</span> <span class="k">import</span> <span class="n">ImageForm</span>
|
|
<span class="kn">from</span> <span class="nn">.settings</span> <span class="k">import</span> <span class="n">MARKDOWNX_MARKDOWNIFY_FUNCTION</span>
|
|
|
|
|
|
<div class="viewcode-block" id="MarkdownifyView"><a class="viewcode-back" href="../../markdownx/docs/views.html#markdownx.views.MarkdownifyView">[docs]</a><span class="k">class</span> <span class="nc">MarkdownifyView</span><span class="p">(</span><span class="n">View</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Conversion of Markdown to HTML.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="MarkdownifyView.post"><a class="viewcode-back" href="../../markdownx/docs/views.html#markdownx.views.MarkdownifyView.post">[docs]</a> <span class="k">def</span> <span class="nf">post</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Handling of the conversion from Markdown to HTML using the conversion</span>
|
|
<span class="sd"> function in settings under ``MARKDOWNX_MARKDOWNIFY_FUNCTION``.</span>
|
|
|
|
<span class="sd"> :param request: HTTP request.</span>
|
|
<span class="sd"> :param args: Default Django POST arguments.</span>
|
|
<span class="sd"> :param kwargs: Default Django POST keyword arguments.</span>
|
|
<span class="sd"> :return: HTTP response</span>
|
|
<span class="sd"> :rtype: django.http.HttpResponse</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">markdownify</span> <span class="o">=</span> <span class="n">import_string</span><span class="p">(</span><span class="n">MARKDOWNX_MARKDOWNIFY_FUNCTION</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">HttpResponse</span><span class="p">(</span><span class="n">markdownify</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">POST</span><span class="p">[</span><span class="s1">'content'</span><span class="p">]))</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ImageUploadView"><a class="viewcode-back" href="../../markdownx/docs/views.html#markdownx.views.ImageUploadView">[docs]</a><span class="k">class</span> <span class="nc">ImageUploadView</span><span class="p">(</span><span class="n">BaseFormView</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Handling requests for uploading images.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="c1"># template_name = "dummy.html"</span>
|
|
<span class="n">form_class</span> <span class="o">=</span> <span class="n">ImageForm</span>
|
|
<span class="n">success_url</span> <span class="o">=</span> <span class="s1">'/'</span>
|
|
|
|
<div class="viewcode-block" id="ImageUploadView.form_invalid"><a class="viewcode-back" href="../../markdownx/docs/views.html#markdownx.views.ImageUploadView.form_invalid">[docs]</a> <span class="k">def</span> <span class="nf">form_invalid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">form</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Handling of invalid form events.</span>
|
|
|
|
<span class="sd"> :param form: Django form instance.</span>
|
|
<span class="sd"> :type form: django.forms.Form</span>
|
|
<span class="sd"> :return: JSON response with the HTTP-400 error message for AJAX requests</span>
|
|
<span class="sd"> and the default response for HTTP requests.</span>
|
|
<span class="sd"> :rtype: django.http.JsonResponse, django.http.HttpResponse</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">response</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">ImageUploadView</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">form_invalid</span><span class="p">(</span><span class="n">form</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">is_ajax</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">JsonResponse</span><span class="p">(</span><span class="n">form</span><span class="o">.</span><span class="n">errors</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="mi">400</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">response</span></div>
|
|
|
|
<div class="viewcode-block" id="ImageUploadView.form_valid"><a class="viewcode-back" href="../../markdownx/docs/views.html#markdownx.views.ImageUploadView.form_valid">[docs]</a> <span class="k">def</span> <span class="nf">form_valid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">form</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> If the form is valid, the contents are saved.</span>
|
|
|
|
<span class="sd"> If the **POST** request is AJAX (image uploads), a JSON response will be</span>
|
|
<span class="sd"> produced containing the Markdown encoded image insertion tag with the URL</span>
|
|
<span class="sd"> using which the uploaded image may be accessed.</span>
|
|
|
|
<span class="sd"> JSON response would be as follows:</span>
|
|
|
|
<span class="sd"> .. code-block:: json</span>
|
|
|
|
<span class="sd"> { image_code: "" }</span>
|
|
|
|
<span class="sd"> :param form: Django form instance.</span>
|
|
<span class="sd"> :type form: django.forms.Form</span>
|
|
<span class="sd"> :return: JSON encoded Markdown tag for AJAX requests, and an appropriate</span>
|
|
<span class="sd"> response for HTTP requests.</span>
|
|
<span class="sd"> :rtype: django.http.JsonResponse, django.http.HttpResponse</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">response</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">ImageUploadView</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">form_valid</span><span class="p">(</span><span class="n">form</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">is_ajax</span><span class="p">():</span>
|
|
<span class="n">image_path</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">commit</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="n">image_code</span> <span class="o">=</span> <span class="s1">'![](</span><span class="si">{}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">image_path</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">JsonResponse</span><span class="p">({</span><span class="s1">'image_code'</span><span class="p">:</span> <span class="n">image_code</span><span class="p">})</span>
|
|
|
|
<span class="k">return</span> <span class="n">response</span></div></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
<div class="articleComments">
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2017 - Adi, Pouria Hadjibagheri.
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'../../',
|
|
VERSION:'2.0.0',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true,
|
|
SOURCELINK_SUFFIX: '.txt'
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../../_static/doctools.js"></script>
|
|
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../../_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |