mirror of
https://github.com/Hopiu/django-markdownx.git
synced 2026-03-16 21:40:24 +00:00
324 lines
No EOL
12 KiB
HTML
324 lines
No EOL
12 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>Form — Django Markdownx 2.0.19 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.19 documentation" href="../../index.html"/>
|
|
<link rel="up" title="MarkdownX Modules" href="../markdownx.html"/>
|
|
<link rel="next" title="Models" href="models.html"/>
|
|
<link rel="prev" title="Fields" href="fields.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 class="current">
|
|
<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 current"><a class="reference internal" href="../markdownx.html">MarkdownX Modules</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="admins.html">Admin</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="fields.html">Fields</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Form</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="urls.html">URLs</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="utilities.html">Utilities</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../contribution.html">Contributions</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="../markdownx.html">MarkdownX Modules</a> »</li>
|
|
|
|
<li>Form</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
<!-- User defined GitHub URL -->
|
|
<a href="https://github.com/adi-/django-markdownx/tree/master/markdownx/forms.py" class="fa fa-github"> Edit on GitHub</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="module-markdownx.forms">
|
|
<span id="form"></span><h1>Form<a class="headerlink" href="#module-markdownx.forms" title="Permalink to this headline">¶</a></h1>
|
|
<dl class="class">
|
|
<dt id="markdownx.forms.ImageForm">
|
|
<em class="property">class </em><code class="descclassname">markdownx.forms.</code><code class="descname">ImageForm</code><span class="sig-paren">(</span><em>data=None</em>, <em>files=None</em>, <em>auto_id='id_%s'</em>, <em>prefix=None</em>, <em>initial=None</em>, <em>error_class=<class 'django.forms.utils.ErrorList'></em>, <em>label_suffix=None</em>, <em>empty_permitted=False</em>, <em>field_order=None</em>, <em>use_required_attribute=None</em>, <em>renderer=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/markdownx/forms.html#ImageForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#markdownx.forms.ImageForm" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Used for the handling of images uploaded using the editor through <span class="guilabel">AJAX</span>.</p>
|
|
<dl class="method">
|
|
<dt id="markdownx.forms.ImageForm.clean">
|
|
<code class="descname">clean</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/markdownx/forms.html#ImageForm.clean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#markdownx.forms.ImageForm.clean" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Checks the upload against allowed extensions and maximum size.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Upload</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="staticmethod">
|
|
<dt id="markdownx.forms.ImageForm.get_unique_file_name">
|
|
<em class="property">static </em><code class="descname">get_unique_file_name</code><span class="sig-paren">(</span><em>file_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/markdownx/forms.html#ImageForm.get_unique_file_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#markdownx.forms.ImageForm.get_unique_file_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Generates a universally unique ID using Python <code class="docutils literal"><span class="pre">UUID</span></code> and attaches the
|
|
extension of file name to it.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file_name</strong> (<em>str</em>) – Name of the uploaded file, including the extension.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Universally unique ID, ending with the extension extracted
|
|
from <code class="docutils literal"><span class="pre">file_name</span></code>.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="markdownx.forms.ImageForm.save">
|
|
<code class="descname">save</code><span class="sig-paren">(</span><em>commit=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/markdownx/forms.html#ImageForm.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#markdownx.forms.ImageForm.save" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Saves the uploaded image in the designated location.</p>
|
|
<p>If image type is not SVG, a byteIO of image content_type is created and
|
|
subsequently save; otherwise, the SVG is saved in its existing <code class="docutils literal"><span class="pre">charset</span></code>
|
|
as an <code class="docutils literal"><span class="pre">image/svg+xml</span></code>.</p>
|
|
<p><em>Note</em>: The dimension of image files (excluding SVG) are set using <code class="docutils literal"><span class="pre">PIL</span></code>.</p>
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
<col class="field-name" />
|
|
<col class="field-body" />
|
|
<tbody valign="top">
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>commit</strong> (<em>bool</em>) – If <code class="docutils literal"><span class="pre">True</span></code>, the file is saved to the disk;
|
|
otherwise, it is held in the memory.</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An instance of saved image if <code class="docutils literal"><span class="pre">commit</span> <span class="pre">is</span> <span class="pre">True</span></code>,
|
|
else <code class="docutils literal"><span class="pre">namedtuple(path,</span> <span class="pre">image)</span></code>.</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool, namedtuple</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<div class="articleComments">
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="models.html" class="btn btn-neutral float-right" title="Models" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="fields.html" class="btn btn-neutral" title="Fields" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<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.19',
|
|
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> |