docs: on new file element type

LifeboyTech · Jun 2, 2016 · 365e620 · 365e620
1 parent 9902a09
commit 365e620
Show file tree

Hide file tree

Showing 15 changed files with 32 additions and 1 deletion.
diff --git a/docs/_build/doctrees/element-options.doctree b/docs/_build/doctrees/element-options.doctree
diff --git a/docs/_build/doctrees/emailers.doctree b/docs/_build/doctrees/emailers.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/license.doctree b/docs/_build/doctrees/license.doctree
diff --git a/docs/_build/doctrees/models.doctree b/docs/_build/doctrees/models.doctree
diff --git a/docs/_build/doctrees/panel-options.doctree b/docs/_build/doctrees/panel-options.doctree
diff --git a/docs/_build/doctrees/panels.doctree b/docs/_build/doctrees/panels.doctree
diff --git a/docs/_build/doctrees/principles.doctree b/docs/_build/doctrees/principles.doctree
diff --git a/docs/_build/doctrees/roadmap.doctree b/docs/_build/doctrees/roadmap.doctree
diff --git a/docs/_build/doctrees/start.doctree b/docs/_build/doctrees/start.doctree
diff --git a/docs/_build/html/_sources/element-options.txt b/docs/_build/html/_sources/element-options.txt
@@ -104,6 +104,15 @@ image
 
    .. image:: images/image.png
 
+file
+^^^^
+
+   * This will generate a VARCHAR(255) database field.
+   * The input for user manipulation is a special file uploader modal dialog.
+   * You may also supply a ``allowed_types`` array containing the file-extensions this will allow.
+   * You may also supply a ``directory`` string containing the remote directory that uploaded files will save to.
+   * The uploaded file name will be saved to the database field.
+
 tags
 ^^^^
 

diff --git a/docs/_build/html/element-options.html b/docs/_build/html/element-options.html
@@ -94,6 +94,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#integer">integer</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#boolean">boolean</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#image">image</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#file">file</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tags">tags</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#select">select</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#multiselect">multiselect</a></li>
@@ -275,6 +276,18 @@ <h3>boolean<a class="headerlink" href="#boolean" title="Permalink to this headli
 <img alt="_images/image.png" src="_images/image.png" />
 </div></blockquote>
 </div>
+<div class="section" id="file">
+<h3>file<a class="headerlink" href="#file" title="Permalink to this headline">¶</a></h3>
+<blockquote>
+<div><ul class="simple">
+<li>This will generate a VARCHAR(255) database field.</li>
+<li>The input for user manipulation is a special file uploader modal dialog.</li>
+<li>You may also supply a <code class="docutils literal"><span class="pre">allowed_types</span></code> array containing the file-extensions this will allow.</li>
+<li>You may also supply a <code class="docutils literal"><span class="pre">directory</span></code> string containing the remote directory that uploaded files will save to.</li>
+<li>The uploaded file name will be saved to the database field.</li>
+</ul>
+</div></blockquote>
+</div>
 <div class="section" id="tags">
 <h3>tags<a class="headerlink" href="#tags" title="Permalink to this headline">¶</a></h3>
 <blockquote>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/element-options.rst b/docs/element-options.rst
@@ -104,6 +104,15 @@ image
 
    .. image:: images/image.png
 
+file
+^^^^
+
+   * This will generate a VARCHAR(255) database field.
+   * The input for user manipulation is a special file uploader modal dialog.
+   * You may also supply a ``allowed_types`` array containing the file-extensions this will allow.
+   * You may also supply a ``directory`` string containing the remote directory that uploaded files will save to.
+   * The uploaded file name will be saved to the database field.
+
 tags
 ^^^^