Hrm... better use [[!ResourceName]] to avoid conflicts with Markdown.

This commit is contained in:
Thomas Keller 2011-12-03 02:32:16 +01:00
parent ac4d974abb
commit 959ea74291
2 changed files with 6 additions and 6 deletions

View File

@ -55,14 +55,14 @@ with the corresponding issue number.</li>
<h2 id="q-wiki">{trans 'How can I embed images and other resources in my documentation pages?'}</h2>
{blocktrans}
<p>To embed any previously uploaded resource into your wiki page, you can use the <code>[!ResourceName]</code> syntax.</p>
<p>To embed any previously uploaded resource into your wiki page, you can use the <code>[[!ResourceName]]</code> syntax.</p>
<p>The rendering of the resource can then be further fine-tuned:
<ul>
<li><code>[!ImageResource, align=right, width=200]</code> renders "ImageResource" right-aligned and scale its width to 200</li>
<li><code>[!TextResource, align=center, width=300, height=300]</code> renders "TextResource" in a centered, 300 by 300 px iframe</li>
<li><code>[!AnyResource, preview=no]</code> does not render a preview of the resource, but only provides a download link (default for binary resources)</li>
<li><code>[!BinaryResource, title=Download]</code> renders the download link of "BinaryResource" with an alternative title</li>
<li><code>[[!ImageResource, align=right, width=200]]</code> renders "ImageResource" right-aligned and scale its width to 200</li>
<li><code>[[!TextResource, align=center, width=300, height=300]]</code> renders "TextResource" in a centered, 300 by 300 px iframe</li>
<li><code>[[!AnyResource, preview=no]]</code> does not render a preview of the resource, but only provides a download link (default for binary resources)</li>
<li><code>[[!BinaryResource, title=Download]]</code> renders the download link of "BinaryResource" with an alternative title</li>
</ul>
</p>

View File

@ -5,6 +5,6 @@
<p><strong>Instructions:</strong></p>
<p>The content of the page can use the <a href="{$burl}">Markdown syntax</a> with the <a href="{$eurl}"><em>Extra</em> extension</a>.</p>
<p>Website addresses are automatically linked and you can link to another page in the documentation using double square brackets like that <code>[[AnotherPage]]</code>.</p>
<p>If you want to embed uploaded resources, use the <code>[!ResourceName]</code> syntax for that. This is described more in detail <a href="{$furl}#q-wiki">in the FAQ.</a></p>
<p>If you want to embed uploaded resources, use the <code>[[!ResourceName]]</code> syntax for that. This is described more in detail <a href="{$furl}#q-wiki">in the FAQ.</a></p>
<p>To directly include a file content from the repository, embrace its path with triple square brackets: <code>[[[my/file.txt]]]</code>.</p>
{/blocktrans}