Overcomers

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
<title>CoderWiki: OCImage Plugin</title>

<WRAP round box justify>
To return to the Wiki Tech Notes index, [[wikitech|click here.]]
</WRAP>

<WRAP round box justify>
**ocimage plugin:**

This DokuWiki includes a plugin named "ocimage" that was created by OldCoder for use by the original "overcomers.group" site. The plugin hasn't been formally released yet but a release should be expected in due course.
</WRAP>

<WRAP round box justify>
Presently, "ocimage" can be used to insert images in either of two modes:

01) Large image inserted **outside** of all WRAP divs, centered, can be displayed either with or without a title. The image will scale up to a specified width and not beyond.

02) Small image (100px to 300px wide) inserted **inside** a WRAP div. The image floats to the right of the text in the div.
</WRAP>

<WRAP round box justify>
The first "ocimage" mode works like this:

<code patch>
<ocimage toast.jpg | 800 | We boast of toast></ocimage>

1st arg = Image-file name without path
2nd arg = Max width in pixels to display
3rd arg = Image title
</code>

Important: This mode should only be used **outside** of page-content WRAP divs. It should, however, be used **inside** the page-background WRAP div (if one exists for a particular page).

A subdirectory named "images" should be created in the DokuWiki top-level directory. Image files to be used with "ocimage" should be uploaded manually to that directory.

The filename shouldn't include spaces. None of the arguments should include unusual characters. If possible, just these characters should be used: letters, digits, underscores, dashes, periods, and (for the title only) spaces.
</WRAP>

<WRAP round box justify>
The type of command line indicated above will display a centered and mobile-responsive image with a title line of the same width right above it. The image will expand, as the display permits, up to the specified maximum width.

If somebody clicks or taps on the image, they'll get a larger and/or zoomable copy of the image. Android zoom gestures, for example, should work.

This plugin may work in some contexts where standard image support and/or other plugins don't work as desired.
</WRAP>

<WRAP round box justify>
If a title line isn't desired, either of the following alternate command formats may be used:

<code patch>
<ocimage toast.jpg | 800></ocimage>
<ocimage toast.jpg | 800 | none></ocimage>
</code>
</WRAP>

<WRAP round box justify>
The second "ocimage" mode works like this:

<code patch>
<ocimage toast.jpg | right></ocimage>

1st arg = Image-file name without path
2nd arg = The word "right" (without double quotes)
</code>

This mode should only be used **inside** a WRAP div and before other content in the div. It'll float the specified image to the right of the content.

Important: The image file should have small dimensions in this case as this version of the command doesn't support scaling.
</WRAP>

<WRAP round box justify>
To return to the Wiki Tech Notes index, [[wikitech|click here.]]
</WRAP>
Overcomers

User Tools

Site Tools

Page Tools
