- task: establish event listener infrastructure
[project/gallery.git] / gallery_help.inc
1 <?php
2 // $Id$
4 /**
5 * gallery.module : gallery_help.inc
6 * Help info
7 */
9 /**
10 * Implementation of hook_help().
11 */
12 function _gallery_help($section) {
13 switch ($section) {
14 case 'filter#short-tip' :
15 return gallery_filter_short_tip_translated();
16 case 'filter#long-tip' :
17 return gallery_filter_long_tip_translated();
18 case 'admin/help#gallery':
19 $output = t('
20 <h3>Online Documentation</h3>
21 <p>Complete documentation can be found on the <a href="http://drupal.galleryembedded.com">wiki</a>.</p>
22 <h3>Settings</h3>
23 <h4>Directory Settings</h4>
24 <p>"URI of Gallery2" is the URI of the Gallery2 standalone location. Path from docroot to the directory main.php is located. Protocol / host name are both optional. Examples: /gallery2/, /sub/gallery2/, http://photos.example.com/,
25 www.example.com/photos/main.php</p>
26 <p>"Location of Gallery2" is the path of your gallery2 installation, either absolute (starts with "/") or relative to your Drupal installation directory. Normally this is auto-detected, but in case this fails you can turn off auto-detection and manually enter a value.</p>
27 <p>"Embed URI" is the URI needed to access Gallery2 through Drupal. This will end in \'?q=gallery\' (non-clean URLs) or \'gallery\' (clean URLs). Normally this is auto-detected, but in case this fails you can turn off auto-detection and manually enter a value.</p>
28 <p>Some examples:</p>
29 <p>Example 1: If your directory structure and website structure is
30 <ul>
31 <li>Drupal dir: /var/www/web/html/</li>
32 <li>Gallery dir: /var/www/web/html/gallery2/</li>
33 <li>Website URL: http://www.example.com</li>
34 <li>Standalone Gallery2 URL: http://www.example.com/gallery2/</li>
35 <li>Then<ul>
36 <li>"URI of Gallery2" = "/gallery2/" or "http://www.example.com/gallery2/"</li>
37 <li>"Location of Gallery2" = "gallery2/" or "/var/www/web/html/gallery2/"</li>
38 <li>"Embed URI" = "?q=gallery" or "http://www.example.com/?q=gallery"</li>
39 </ul>
40 </ul>
41 </p><p>Example 2: If your directory structure and website structure is
42 <ul>
43 <li>Drupal dir: /var/www/web/html/drupal/</li>
44 <li>Gallery dir: /var/www/web/html/gallery2/</li>
45 <li>Website URL: http://www.example.com/drupal</li>
46 <li>Standalone Gallery2 URL: http://www.example.com/gallery2/</li>
47 <li>Then<ul>
48 <li>"URI of Gallery2" = "/gallery2/" or "http://www.example.com/gallery2/"</li>
49 <li>"Location of Gallery2" = "../gallery2/" or "/var/www/web/html/gallery2/"</li>
50 <li>"Embed URI" = "/drupal/?q=gallery" or "http://www.example.com/drupal/?q=gallery"</li>
51 </ul>
52 </ul>
53 </p><p>Example 3: If your directory structure and website structure is
54 <ul>
55 <li>Drupal dir: /var/www/web/html/drupal/</li>
56 <li>Gallery dir: /var/www/web/html/someotherdir/gallery2/</li>
57 <li>Website URL: http://www.example.com/</li>
58 <li>Standalone Gallery2 URL: http://www.anotherexample.com/gallery2/</li>
59 <li>Then<ul>
60 <li>"URI of Gallery2" = "http://www.anotherexample.com/gallery2/"</li>
61 <li>"Location of Gallery2" = "/var/www/web/html/someotherdir/gallery2/"</li>
62 <li>"Embed URI" = "/drupal/?q=gallery" or "http://www.example.com/drupal/?q=gallery"</li>
63 </ul>
64 </ul>
65 </p>
66 <h4>Full Name settings</h4>
67 <p>Drupal does not have in-built support for full names but Gallery 2 does. If you would like full names in both then you can install profile.module in Drupal and define a "full name" field. Include the name of that field here. You can enable/disable this functionality at will, but it may leave some users with different full names in their Drupal and Gallery users, so it is not recommended.</p>
68 <h4>Search settings</h4>
69 <p>You can select how many items are returned per Gallery2 module. You can also specify whether thumbnails should be returned, and if so, how they should be formatted.</p>
70 <h4>Error Logging settings</h4>
71 <p>You can choose whether errors occuring in this module are logged in the watchdog, displayed in the browser, or both.</p>
72 ');
73 $output .= _gallery_g2image_help();
74 return $output;
75 case 'admin/settings/gallery':
76 return t('');
77 /* Used in the default value for the pages list in g2image settings */
78 case 'admin/settings/gallery_g2image#pages':
79 return "node/*\ncomment/*";
80 }
81 }
83 /**
84 * Function gallery_filter_short_tip_translated().
85 */
86 function gallery_filter_short_tip_translated() {
87 return t('You may link to Gallery2 items on this site <a href="@explanation-url">using a special syntax</a>.', array('@explanation-url' => url('filter/tips', NULL, 'filter-gallery-0')));
88 }
90 /**
91 * Function gallery_filter_long_tip_translated().
92 */
93 function gallery_filter_long_tip_translated() {
94 $prefix = variable_get("gallery_filter_prefix", "G2");
96 return t('
97 <p><strong>Gallery2 Filter:</strong></p>
99 <p>You can link to items in your embedded Gallery2 using a special code. This code will be replaced by a thumbnail image that is linked to the actual item in your Gallery. </p>
101 <p><em>Syntax:</em></p>
103 <blockquote><code>
104 ['. $prefix .':<em>item_id</em> n=<em>number</em> type=<em>type</em> size=<em>number</em> class=<em>name</em> frame=<em>name</em> album_frame=<em>name</em> item_frame=<em>name</em>]
105 </code></blockquote>
107 <ul><li>item_id (required): This is the item ID from Gallery2. If you look at the URL of the item, this is the last number. <em>Note that if the item_id is a single photo, n must be 1.</em></li>
109 <li>n (suggested): This is the number of photos you want the block to show. It will override whatever is set in the defaults (initially 1). Note: this will change past instances where you did not set n -- the reason for its suggested use.</li>
111 <li>type: The default type of gallery block. Any of the following may be used: <em>randomImage, recentImage, viewedImage, randomAlbum, recentAlbum, viewedAlbum, dailyImage, weeklyImage, monthlyImage, dailyAlbum, weeklyAlbum, monthlyAlbum, specificItem. </em> Note that for n=1, selectedItem is automatically chosen regardless of this parameter.</li>
113 <li>class: The block that Gallery2 returns is wrapped in a DIV so additional styling can be done. The classes for this DIV are located in g2_filter.css. Included with the module are "left", "right", and "nowrap". These position the image block to the left or right or on a line all its own with the text not wrapping. You can also add your own class(es) to the CSS file and they will automatically be available.</li>
115 <li>size: The length of the longest side for the thumbnail. The other side is determined automatically to keep the same aspect ratio. This option (for Gallery2.2 and above) will use the gallery image that is closest in size, and so may end up using a smaller image and expanding it (lower quality). If so, use "exactsize". For Gallery2.1, if you want your size to be bigger than
116 the thumbnail size for that image as defined in your Gallery2, you must select "Full Size" in
117 the gallery settings page (but note that the full image will be returned and then resized by the
118 browser, so it may take a while to download).</li>
120 <li>exactsize: The length of the longest side for the thumbnail. The other side is determined automatically to keep the same aspect ratio. This option always ensures that the image is scaled
121 from a larger image and so image quality is maintained. This only works for Gallery2.2 and above.</li>
123 <li>frame/album_frame/item_frame: You can use just "frame" to assign a frame to the thumbnail regardless of whether it\'s for an album or a single item. Using aframe will only affect albums and iframe will only affect single items. Frames included with the default Gallery 2 install are: bamboo, book, brand , dots, flicking, gold, gold2, polaroid, polaroids, shadow, shells, slide, solid, notebook, wood.</li></ul>');
124 }
126 /**
127 * Function _gallery_g2image_help().
128 */
129 function _gallery_g2image_help() {
130 return t('
131 <h3>Gallery Image Assist (g2image)</h3>
132 <p>Support for <a href="http://g2image.steffensenfamily.com">g2image</a> in either Standalone or TinyMCE is available to simplify adding images already in your Gallery2 albums into your Drupal nodes.</p>
133 <p>Caution: By default, Drupal uses the \'Filtered HTML\' input format for adding content to the site and the default settings cause the &lt;img&gt; tags added by g2image to be removed. Check the TinyMCE documentation for instructions on how to avoid this.</p>');
134 }
136 /**
137 * Function _gallery_report_help().
138 */
139 function _gallery_report_help() {
140 return t('<p><strong>A serious error has occured. This can happen due to an incorrect configuration or a bug in the gallery module. If you plan to submit a bug report to the issue queue at <a href="@gallery-issues">drupal.org</a> consider to include the <a href="@report">pre-generated report file</a>.</strong></p>',
141 array('@gallery-issues' => 'http://drupal.org/project/issues/gallery', '@report' => url('admin/settings/gallery/report/download')));
142 }