aboutsummaryrefslogtreecommitdiff
path: root/help.html
diff options
context:
space:
mode:
authorKevin Chabowski <kevin@kch42.de>2012-03-03 22:40:07 +0100
committerKevin Chabowski <kevin@kch42.de>2012-03-03 22:40:07 +0100
commit610a6cee5eca3ca433506b5dfea8d239d7cd1a50 (patch)
tree1cec5809d06c06eeee522ab4ef9db428812fb2cd /help.html
downloadkch42_gravatar-610a6cee5eca3ca433506b5dfea8d239d7cd1a50.tar.gz
kch42_gravatar-610a6cee5eca3ca433506b5dfea8d239d7cd1a50.tar.bz2
kch42_gravatar-610a6cee5eca3ca433506b5dfea8d239d7cd1a50.zip
Initial commit.
Diffstat (limited to 'help.html')
-rw-r--r--help.html55
1 files changed, 55 insertions, 0 deletions
diff --git a/help.html b/help.html
new file mode 100644
index 0000000..74a0b56
--- /dev/null
+++ b/help.html
@@ -0,0 +1,55 @@
+<h2>kch42_gravatar</h2>
+
+<p>This Plugin gives you an STE tag, which will return the <a href="http://www.gravatar.com">Gravatar</a> of the person, who written a comment.</p>
+<p>This tag is: <code>&lt;ste:kch42_gravatar /&gt;</code>.</p>
+
+<h3>How to use this tag</h3>
+
+<p>The tag will return a HTML <code>&lt;img /&gt;</code> tag.</p>
+
+<p>The tag will accept these parameters:</p>
+
+<p>
+ <table>
+ <thead>
+ <tr>
+ <th>Parameter name</th>
+ <th>Mandatory?</th>
+ <th>Default value</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>comment</code></td>
+ <td><strong>Yes</strong></td>
+ <td>&nbsp;</td>
+ <td>Name of a variable that contains information about a comment (usually generated by <code>&lt;ste:article_comments /&gt;</code>)</td>
+ </tr>
+ <tr>
+ <td><code>size</code></td>
+ <td>No</td>
+ <td>80</td>
+ <td>Size of image in pixels.</td>
+ </tr>
+ <tr>
+ <td><code>default</code></td>
+ <td>No</td>
+ <td>identicon</td>
+ <td>The default image, if no Gravatar is available. Can be a URL to an image or one of <a href="http://gravatar.com/site/implement/images/#default-image">Gravatar's default values</a>.</td>
+ </tr>
+ <tr>
+ <td><code>rating</code></td>
+ <td>No</td>
+ <td>g</td>
+ <td>One of <a href="http://gravatar.com/site/implement/images/#rating">Gravatar's rating values</a>.</td>
+ </tr>
+ <tr>
+ <td><code>style</code></td>
+ <td>No</td>
+ <td>&nbsp;</td>
+ <td>Additional (CSS) styles for the image.</td>
+ </tr>
+ </tbody>
+ </table>
+</p>