Skip to content

Commit

Permalink
Deployed 79cfb2f with MkDocs version: 1.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jako
Jako committed Mar 10, 2023
1 parent 7fa6197 commit fb94641
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 51 deletions.
8 changes: 4 additions & 4 deletions sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>None</loc>
<lastmod>2023-01-24</lastmod>
<lastmod>2023-03-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-01-24</lastmod>
<lastmod>2023-03-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-01-24</lastmod>
<lastmod>2023-03-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2023-01-24</lastmod>
<lastmod>2023-03-10</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
View file
Binary file not shown.
106 changes: 59 additions & 47 deletions usage/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,22 +254,21 @@
</a>
<h1>Usage</h1>
<h2 id="how-it-works">How it works</h2>
<p>Ajaxupload generates an upload button for uploading multiple files with progress
counter in FormIt forms. Works well in FF3.6+, Safari4+, Chrome and falls back to
hidden iframe based upload in other browsers, providing good user experience
everywhere.</p>
<p>All uploaded files and generated thumbnails are given random filenames to avoid
hotlinking uploaded not published files. Automatic thumbnail generation for
uploaded jpeg, png and gif files. Other uploaded files will get a generic icon
the file extension.</p>
<p>The package contains FormIt hooks for prefilling the upload queue from a FormIt
field value and to save the upload queue into a FormIt field value after a form
submission. A third FormIt hook could attach the uploaded files to the FormIt
mails.</p>
<p>Ajaxupload creates an upload button for uploading multiple files with progress
counter in FormIt forms. Works well in FF3.6+, Safari4+, Chrome and falls back
to a hidden iframe-based upload in other browsers, providing a good user
experience everywhere.</p>
<p>All uploaded files and generated thumbnails are given random file names to avoid
hotlinking of uploaded unpublished files. Automatic thumbnail generation for
uploaded jpg, png and gif files. Other uploaded files get a generic file
extension icon.</p>
<p>The package includes FormIt hooks for pre-filling the upload queue from a FormIt
field and saving the upload queue to a FormIt field after a form submission. A
third FormIt hook can append the uploaded files to the FormIt mails.</p>
<h2 id="display-the-upload-button">Display the Upload Button</h2>
<p>To display the upload button, you have to insert the <em>AjaxUpload snippet</em> call
somewhere in a Resource. If you want to use it with FormIt, you should place the
snippet call in the FormIt form:</p>
<p>To display the upload button, you need to place the <em>AjaxUpload snippet</em> call
somewhere in a Resource. If you want to use it with FormIt, you need to place
the snippet call in the FormIt form:</p>
<div class="highlight"><pre><span></span><code>[[!AjaxUpload?
&amp;uid=`image`
&amp;allowedExtensions=`jpg,jpeg,png,gif`
Expand All @@ -288,31 +287,41 @@ <h2 id="display-the-upload-button">Display the Upload Button</h2>
</thead>
<tbody>
<tr>
<td>uid</td>
<td>Unique upload queue id <sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup>.</td>
<td>md5 of MODX 'site_url' setting and the current resource id</td>
<td>addCss</td>
<td>Add the snippet css ad the end of the head.</td>
<td>1 (Yes)</td>
</tr>
<tr>
<td>language</td>
<td>Snippet/Javascript language.</td>
<td>-</td>
<td>addJquery</td>
<td>Add jQuery script at the end of the body.</td>
<td>0 (No)</td>
</tr>
<tr>
<td>addJscript</td>
<td>Add the snippet javascript and the fileuploader script at the end of the body.</td>
<td>1 (Yes)</td>
</tr>
<tr>
<td>allowedExtensions</td>
<td>Allowed file extensions for upload.</td>
<td>jpg,jpeg,png,gif</td>
</tr>
<tr>
<td>maxFilesizeMb</td>
<td>Maximum size for one file to upload.</td>
<td>8</td>
<td>language</td>
<td>Snippet/Javascript language.</td>
<td>-</td>
</tr>
<tr>
<td>maxFiles</td>
<td>Maximum count of files to upload.</td>
<td>3</td>
</tr>
<tr>
<td>maxFilesizeMb</td>
<td>Maximum size for one file to upload.</td>
<td>8</td>
</tr>
<tr>
<td>thumbX</td>
<td>Horizontal size of generated thumb.</td>
<td>100</td>
Expand All @@ -323,19 +332,14 @@ <h2 id="display-the-upload-button">Display the Upload Button</h2>
<td>100</td>
</tr>
<tr>
<td>addJquery</td>
<td>Add jQuery script at the end of the body.</td>
<td>0 (No)</td>
</tr>
<tr>
<td>addJscript</td>
<td>Add the snippet javascript and the fileuploader script at the end of the body.</td>
<td>1 (Yes)</td>
<td>uid</td>
<td>Unique upload queue id <sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup>.</td>
<td>md5 of MODX 'site_url' setting and the current resource id</td>
</tr>
<tr>
<td>addCss</td>
<td>Add the snippet css ad the end of the head.</td>
<td>1 (Yes)</td>
<td>uploadSectionTpl</td>
<td>Name of a chunk that contains the HTML code for the upload section.</td>
<td>tplAjaxuploadUploadSection</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -365,9 +369,9 @@ <h2 id="set-and-retrieve-the-upload-queue">Set and retrieve the upload queue</h2
</thead>
<tbody>
<tr>
<td>ajaxuploadUid</td>
<td>Unique upload queue id.</td>
<td>-</td>
<td>ajaxuploadFieldformat</td>
<td>Format of the data saved in <code>ajaxuploadFieldname</code>.</td>
<td>csv</td>
</tr>
<tr>
<td>ajaxuploadFieldname</td>
Expand All @@ -380,12 +384,14 @@ <h2 id="set-and-retrieve-the-upload-queue">Set and retrieve the upload queue</h2
<td>-</td>
</tr>
<tr>
<td>ajaxuploadFieldformat</td>
<td>Format of the data saved in <code>ajaxuploadFieldname</code>.</td>
<td>csv</td>
<td>ajaxuploadUid</td>
<td>Unique upload queue id.</td>
<td>-</td>
</tr>
</tbody>
</table>
<p>The folder in <code>ajaxuploadTarget</code> has to exist and it has to be writable for PHP
or it must be createable.</p>
<p>The AjaxUpload2Formit hook uses additional properties:</p>
<table>
<thead>
Expand All @@ -397,15 +403,15 @@ <h2 id="set-and-retrieve-the-upload-queue">Set and retrieve the upload queue</h2
</thead>
<tbody>
<tr>
<td>ajaxuploadClearQueue</td>
<td>Clear the upload queue after a sucessful run of the hook.</td>
<td>0 (No)</td>
</tr>
<tr>
<td>ajaxuploadAllowOverwrite</td>
<td>Allow overwrite of existing files with the same filename.</td>
<td>1 (Yes)</td>
</tr>
<tr>
<td>ajaxuploadClearQueue</td>
<td>Clear the upload queue after a sucessful run of the hook.</td>
<td>0 (No)</td>
</tr>
</tbody>
</table>
<h2 id="attach-the-uploaded-files-to-a-mail">Attach the uploaded files to a mail</h2>
Expand Down Expand Up @@ -466,13 +472,19 @@ <h2 id="system-settings">System Settings</h2>
<td>Log debug information in the MODX error log.</td>
<td>No</td>
</tr>
<tr>
<td>ajaxupload.image_tpl</td>
<td>Image Template</td>
<td>Name of a chunk that contains the HTML code for displaying the uploaded image.</td>
<td>tplAjaxUploadImage</td>
</tr>
</tbody>
</table>
<div class="footnote">
<hr/>
<ol>
<li id="fn:1">
<p>The parameter uid should be set different for each upload button on the site to separate multiple upload queues. <a class="footnote-backref" href="#fnref:1" title="Jump back to footnote 1 in the text">↩</a></p>
<p>The parameter uid has to be set different for each upload button on the site to separate multiple upload queues. <a class="footnote-backref" href="#fnref:1" title="Jump back to footnote 1 in the text">↩</a></p>
</li>
</ol>
</div>
Expand Down

0 comments on commit fb94641

Please sign in to comment.