urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve img's documentation. 

Jon is right, of course.  User error, not an ikiwiki bug.  So, I removed the
false bug report and added its gist to img's documentation.
master
Thomas Schwinge 2009-11-15 00:33:28 +01:00
parent 7b2571adf4
commit 88a217598d
2 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/bugs/img_vs_align.mdwn
View File

@ -1,11 +0,0 @@
The *[[ikiwiki/directive/img]]* directive allows for specifying an
*align* parameter -- which is of limited usability as the image is
embedded as `<p><img ...></p>`. That's at least what I see on
<http://www.bddebian.com:8888/~hurd-web/hurd/status/>. On the other
hand, CSS is supposed to be used instead, I guess. (But how... I forgot
almost of my CSS foo again ;-) it seems.) --[[tschwinge]]
> [[!img logo/ikiwiki.png align=right]]The [img tag doesn't create P tags](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=IkiWiki/Plugin/img.pm;h=32023fa97af8ba8e63192cacaff10a4677d20654;hb=HEAD), but if you have surrounded the img directive with newlines, they will result in paragraph tags.
>
> I've edited the URL you provided to demonstrate this -- hope you don't mind! I've also added an inline, right-aligned image to this page.[[!tag done]]
> -- [[Jon]]

6
doc/ikiwiki/directive/img.mdwn
View File

@ -22,6 +22,12 @@ You can also pass `alt`, `title`, `class`, `align` and `id` parameters.
These are passed through unchanged to the html img tag. If you include a These are passed through unchanged to the html img tag. If you include a
`caption` parameter, the caption will be displayed centered beneath the image. `caption` parameter, the caption will be displayed centered beneath the image.
Note that for the `align` parameter to work, you have to make sure that the
`img` directive isn't surrounded with newlines, as the [[Markdown]] renderer
would otherwise put the image into its own paragraph, inhibiting this
functionality from working. On the other hand, CSS should probably rather be
used instead.
The `link` parameter is used to control whether the scaled image links The `link` parameter is used to control whether the scaled image links
to the full size version. By default it does; set "link=somepage" to link to the full size version. By default it does; set "link=somepage" to link
to another page instead, or "link=no" to disable the link, or to another page instead, or "link=no" to disable the link, or