david
790d6f170a
git-svn-id: https://192.168.0.254/svn/Proyectos.MatritumCantat_Web/trunk@2 8e3496fd-7892-4c45-be36-0ff06e9dacc6
120 lines
11 KiB
HTML
120 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>Zoom Thumb Mambot:: manual</title>
|
|
<link rel="stylesheet" type="text/css" href="style-for-html-files.css" />
|
|
</head>
|
|
<body>
|
|
<!--@version@ section with this tag are hidden but used by author to indicate places which need his attention before a new official release.-->
|
|
<h1>Zoom Thumb Mambot</h1>
|
|
<!--@version@-->
|
|
<p>(version 1.0.beta.1.1 Feb 2005 )</p>
|
|
<p>This page documents the Zoom Thumb mambot. This mambot makes it possible to use thumbnail images from the Zoom gallery module to be used in content items. See also the next warning.</p>
|
|
<h2>General security warning!!!</h2>
|
|
<!--@version@1.1 :: remove warming-->
|
|
<p>This version of the mambot does not validate if a user has access to an image. Zoom gallery allows for certain security restrictions on an individual level. This mambot however does <strong>NOT!</strong> appreciate those restrictions.</p>
|
|
<p>If you have public images only, then it's no problem. If admins are the only persons writing pages then, if they pay attention to which images are selected, it shouldn't be a problem too.</p>
|
|
<p>If it is a problem then uninstall this mambot or at least make sure it's not published.</p>
|
|
<h2>How to use the mambot?</h2>
|
|
<!--@version@1.1 :: add frontend plus imgid selection if Zoom author wont help.-->
|
|
<p>(Tip: you need to save the mambot settings at least once, otherwise it won't work.)</p>
|
|
<p>Well, first you need to have the Zoom Gallery installed, of course. If not, see the resource paragraph for web links. You also need to add some pictures to the Gallery.</p>
|
|
<p>Since your're reading this, you probably have the Zoom Thumb mambot installed as well. If not, see the resource paragraph for web links. </p>
|
|
<!--@version@1.1-->
|
|
<p>The you have two options: manually adding the tags or, option 2, using the Zoom Thumb Wizard. The wizard is a set of instructions and coding that, if applied, will make it all much more userfriendly.</p>
|
|
<p>For information on the Zoom Thumb Wizard see the resources below.</p>
|
|
<h2>Manually adding the mambot code</h2>
|
|
<p>Start editing a content item. In the same place where you add text, you can add this sample code as well: {moszoomthumb imgid=1} . See the paragraph with quick sampes for more. In reading mode, the content item will display a thumbnail picture.</p>
|
|
<h3>Quick samples for usage</h3>
|
|
<ul>
|
|
<li>{moszoomthumb imgid=1}<br />display the thumbnail of the image that is uniqely identified by 'imgid' in the Zoom Gallery module. The default styles in your mambot-config-settings are applied.</li>
|
|
<li>{moszoomthumb imgid=1 caption="this is my caption text"}<br />previous example plus a custom caption text is placed with the image. The default styling for the caption is applied.</li>
|
|
<li>{moszoomthumb imgid=1 caption="this is my caption text" style_m=2}<br />Previous example, but the second style is applied to the container that holds both the image as well as the caption (if any). The style is defined in the mambot-config-settings.</li>
|
|
<li>{moszoomthumb imgid=1 style_m=2 style_c=2}<br />previous example, but the second style for captions is used.</li>
|
|
</ul>
|
|
|
|
<h3>Complete syntax for the ZoomThumb tag</h3>
|
|
<p><strong>{moszoomthumb imgid=number</strong> caption=text style_m=number style_i=number style_c=number<strong>}</strong></p>
|
|
<ul>
|
|
<li>Use single spaces to seperate key=value pairs. Do not add spaces around the '='. This is good: 'key=pair'. This is wrong: 'key = pair'.</li>
|
|
<li><strong>imgid=number (required)</strong><br />is the unique id given to an image in the Zoom gallery Module (see also 'How do i find the image id?')</li>
|
|
<li>caption=(texthere) between a left and a right parenthesis<br />is caption text placed with the image. The caption text given to the picture in the Zoom Gallery is ignored. Also, if the mambot-config-settings are set to not display caption text (texts from from the Zoom gallery) if you provide a caption text as parameter it will be shown (thus overriding the mambot-config-settings).</li>
|
|
<li>style_m=number 1,2,3 or 4<br />indicates one of the four styles as defined in your mambot-config. See also 'About styling'.</li>
|
|
<li>style_i=number 1 or 2<br />indicates one of the two styles as defined in your mambot-config. See also 'About styling'.</li>
|
|
<li>style_c=numbers 1 or 2<br />indicates one of two styles as defined in your mambot-config. See also 'About styling'.</li>
|
|
</ul>
|
|
<p><strong>Nota bene</strong>:: do not provide any values containing <strong>'}'</strong> or <strong> '=' </strong> or <strong> ( ) parentheses </strong>, it will screw things up.</p>
|
|
<p><strong>Nota bene</strong>:: do not add spaces around the '='. This is good: 'key=pair'. This is wrong: 'key = pair'.</p>
|
|
<p><strong>Nota bene</strong>:: do not use the " (the single double quote) in caption texts. This is good: ' caption=(my caption text) for this image" ', this is good as well: ' caption=(my 'funny' caption text for this image) '. This is wrong: ' caption=(my "funny" caption text for this image) '</p>
|
|
<h3>How do i find the image id?</h3>
|
|
<!--@version@1.0.beta.1.9-->
|
|
<p>Although the coding sample is very simple: {moszoomthumb imgid=1} , it's not that simple to get the imgid (unique id of image) from zoom gallery. That's because Zoom Gallery never shows that id in the front end. Not even as part of some url. So to get the img id you need to open the mysql table (table is named _zoomfiles) and find the id.</p>
|
|
<p>Try applying the Zoom Thumb Wizard (see resources) if you think this is too much effort.</p>
|
|
<h2>The Zoom Thumb Wizard</h2>
|
|
<!--@version@1.0.beta.1.9-->
|
|
<p>The wizard allows administrators (next version will support normal users as well) to simply create the code, by just clicking on some options. The mambot code will then be automatically generated. For instrunctions on how to install it, visit the project home page (see resources).</p>
|
|
<p>The installation of the wizard consists of <strong>two</strong> steps. If you choose to only perform step 1, you can compute the mambot code by go to the Zoom Gallery Component homepage (menu>component>Zoom gallery) and click on the <strong>Zoom Thumb coder</strong> option. Then just follow the steps.</p>
|
|
<p>If you applied the second step of the Wizard as well, just go to your content item and start editing it (administrator access only) and an extra tab (where Publication. Images, etc are) will be available. Follow the steps there.</p>
|
|
<h2>About styling</h2>
|
|
<p>The mambot-config-settings provide styling options for this ZoomThumb mambot. There are three elements to style: the main container for the image and caption, the image and finally the caption.</p>
|
|
<h3>Main container styling</h3>
|
|
<ul>
|
|
<li>default style applied to main container:<br />
|
|
class='mosimage' style='float: left; border-width: 0px; margin: px; padding: px;' align='center'<br />
|
|
this will bring the main container to the left of the text in which it is embedded.</li>
|
|
<li>style 2 applied to main container:<br />
|
|
class='mosimage' style='float: right; border-width: 0px; margin: px; padding: px;' align='center'<br />
|
|
this will bring the main container to the right of the text in which it is embedded.</li>
|
|
<li>style 3 applied to main container:<br />
|
|
class='mosimage' style='border-width: 0px; margin: px; padding: px;' align='center'<br />
|
|
this will bring the main container in the middle of the text. Text stops above and continues below the picture.</li>
|
|
<li>style 4 applied to main container:<br />
|
|
this is empty by default: you can of course use it and change it anyway you like it (same goes of course for previous three) .</li>
|
|
</ul>
|
|
|
|
<h3>Image styling</h3>
|
|
<p>After installation the two default settings are as follows:</p>
|
|
<ul>
|
|
<li>default style applied to image:<br />
|
|
empty by default, use it as you might otherwise add html/style/etc tags to your image code.</li>
|
|
<li>style 2 applied to the image:<br />
|
|
this is empty by default: you can of course use it and change it anyway you like it (same goes of course for previous one) .</li>
|
|
</ul>
|
|
<h3>Caption styling</h3>
|
|
<p>After installation the two default settings are as follows:</p>
|
|
<ul>
|
|
<li>default style applied to caption:<br />
|
|
class='mosimage_caption' style='width: 100px'<br />
|
|
Apply a standard Mambo 452 class, but added a width as well.
|
|
</li>
|
|
<li>style 2 applied to the caption:<br />
|
|
this is empty by default: you can of course use it and change it anyway you like it (same goes of course for previous one) .</li>
|
|
</ul>
|
|
<h3>Some good styling tips</h3>
|
|
<p>The default settings contain a lot of added styling values (e.g. style='border-width: 0px; ' ). This was done to stay inline with the normal method used in mambo 4.5.2. A better approach would be to use 'stylesheets only' for the actual styling. In the end it will provide a better seperation of content en styling.</p>
|
|
<p>To do this, use only values in the styling fiels that are something like "class='contentthumb-left'" and then define that class in your website templates. So for each template you have, you need to do this.</p>
|
|
|
|
|
|
<h2>Other configuration settings explained</h2>
|
|
<p>The <strong>Show unpublished thumbs?</strong> setting allows you to use and display thumb nails from Zoom despite having their status set to 'Unpublished'. Normally thumbnails are displayed only when their individul status is set to 'Published' AND it's gallery status is set to 'Published'. If you decide to override this, thumbnails are shown BUT they will not link to the larger image in the Zoom gallery (because Zoom shows published images only).</p>
|
|
<p>Also, enter the correct Itemid of the menu option that opens the Zoom Gallery. Find this by looking at the url and look for <strong>Itemid</strong>. The default setting 0 (zero) that was set during mambot installation will make Zoom Thumb ignore it. Any other value will trigger Zoom Thumb to add this itemid to the url over the thumbnail image. Why should you enter the itemid? Because with this itemid, mambo will provide better information for the pathway (the 'breadcrumb' trail).</p>
|
|
<h2>ZoomThumb not working as it should do?</h2>
|
|
<p>Check your mambot tag: does it comply to the syntax as described above? Pay attention to the "nota bene's".</p>
|
|
<p>Check your mambot-config-settings: does it point to the root folder of the Zoom Gallery directory?</p>
|
|
<p>Check the page-source in your browser: does the html look allright?</p>
|
|
<p>Do you use the compatible versions of Zoom Gallery and this Zoom Thumb mambot? See below.</p>
|
|
<h2>Compatibility</h2>
|
|
<p>Do you use the compatible versions of Zoom Gallery and this Zoom Thumb mambot?</p>
|
|
<!--@version@-->
|
|
<p>ZoomThumb mambot has been developed using Mambo 4.5.2 together with Zoom Gallery 2.5Beta</p>
|
|
<h2>Resources</h2>
|
|
<h3>ZoomThumb mambot</h3>
|
|
<p>You may find more info on <strong>Zoom Thumb</strong> and the <strong>Zoom Thumb Wizard</strong> at <a href="http://mamboforge.net/projects/zoomthumb/">MamboForge.net :: Zoom Thumb</a> (check the project homepage there for full info). </p>
|
|
<h3>Zoom Gallery</h3>
|
|
<p>You may find additional information on <strong>Zoom Gallery</strong> at <a href="http://mamboforge.net/projects/zoom/">MamboForge.net :: Zoom</a> (check the project homepage there for info on beta's). </p>
|
|
<h2>About the author</h2>
|
|
<p>Jetze van der Wal: freelance web developer, The Netherlands.</p>
|
|
<p>mambo@jetze.com</p>
|
|
</body>
|
|
</html> |