This repository has been archived by the owner on Mar 1, 2024. It is now read-only.
/
wppa-help.php
153 lines (139 loc) · 12.7 KB
/
wppa-help.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<?php
/* wppa-help.php
* Pachkage: wp-photo-album-plus
*
* admin help page
* version 6.3.0
*/
function _wppa_page_help() {
global $wppa_revno;
?>
<div class="wrap">
<?php
$iconurl = "http://www.gravatar.com/avatar/b421f77aa39db35a5c1787240c77634f?s=32&d=http%3A%2F%2Fwww.gravatar.com%2Favatar%2Fad516503a11cd5ca435acc9bb6523536%3Fs%3D32&r=G";
?>
<div id="icon-album" class="icon32" style="background: transparent url(<?php echo($iconurl); ?>) no-repeat">
<br />
</div>
<h2><?php _e('Help and Information', 'wp-photo-album-plus'); ?></h2>
<h3><?php _e('Plugin Description', 'wp-photo-album-plus'); ?></h3>
<p><?php _e('This plugin is designed to easily manage and display your photo albums within your WordPress site.', 'wp-photo-album-plus'); ?></p>
<?php _e('Features:', 'wp-photo-album-plus'); ?><br /><br />
<ul class="wppa-help-ul">
<li><?php _e('You can create various albums that contain photos as well as sub albums at the same time.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('There is no limitation to the number of albums and photos.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('There is no limitation to the nesting depth of sub-albums.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('You have full control over the display sizes of the photos.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('You can specify the way the albums are ordered.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('You can specify the way the photos are ordered within the albums, both on a system-wide as well as an per album basis.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('The visitor of your site can run a slideshow from the photos in an album by a single mouseclick.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('The visitor can see an overview of thumbnail images of the photos in album.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('The visitor can browse through the photos in each album you decide to publish.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('You can add a Sidebar Widget that displays a photo which can be changed every hour, day or week.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('You can add a Sidebar Search Widget, a Tagcloud widget and many others. See the WP Widgets admin page.', 'wp-photo-album-plus'); ?></li>
</ul>
<h3><?php _e('Plugin Admin Features', 'wp-photo-album-plus'); ?></h3>
<p><?php _e('You can find the plugin admin section under Menu Photo Albums on the admin screen.', 'wp-photo-album-plus'); ?></p>
<?php _e('The following submenus exist.', 'wp-photo-album-plus'); ?><br />
<ul class="wppa-help-ul">
<li><?php _e('Photo Albums: Create and manage Albums.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Upload photos: To upload photos to an album you created.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Import photos: To bulk import photos that have been uploaded by an ftp program.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Settings: To control the various settings to customize your needs.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Photo of the Day: To specify the behaviour for an optional potd sidebar widget.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Comments: The comments on photos management admin page.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Help & Info: The screen you are watching now.', 'wp-photo-album-plus'); ?></li>
</ul>
<h3><?php _e('Installation', 'wp-photo-album-plus'); ?></h3>
<ul>
<li><?php _e('You can install the plugin via the standard WP plugins admin page.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('If you want to do it manually, follow the next steps:', 'wp-photo-album-plus'); ?></li>
</ul>
<ol class="wppa-help-ol">
<?php $temp = wp_upload_dir();
$ud = $temp['basedir'];
$ud = str_replace(WPPA_ABSPATH, '', $ud);
?>
<li><?php _e('Unzip and upload the wppa plugin folder to', 'wp-photo-album-plus'); ?> <tt>...<?php echo str_replace(home_url(), '', plugins_url()) ?></tt></li>
<li><?php _e('Make sure that the folder', 'wp-photo-album-plus'); ?> <tt>.../<?php echo $ud ?></tt> <?php _e('exists and is writable by the server (CHMOD 755)', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Activate the plugin in WP Admin -> Plugins.', 'wp-photo-album-plus'); ?></li>
</ol>
<h3><?php _e('Upgrading WP Photo Album Plus', 'wp-photo-album-plus'); ?></h3>
<p><?php _e('When upgrading WP Photo Album Plus be aware of:', 'wp-photo-album-plus'); ?></p>
<ul class="wppa-help-ul">
<li><?php _e('The revision number consists of 3 parts, Major, minor and fix revision. The current version is:', 'wp-photo-album-plus'); echo(' '.substr($wppa_revno, 0, 1).'.'.substr($wppa_revno, 1, 1).'.'.substr($wppa_revno, 2)); ?><br /></li>
<li><?php _e('When an update implies a major or minor version change and you have copied wppa-theme.php or wppa-style.css to your themes directory, you will have to remove them and make new copies and/or alterations if that should still be needed.', 'wp-photo-album-plus'); ?>
<?php _e('You will get a one-time reminder after upgrading, the first time you open a wppa admin page.', 'wp-photo-album-plus'); ?></li>
</ul>
<h3><?php _e('How to start', 'wp-photo-album-plus'); ?></h3>
<ol class="wppa-help-ol">
<li><?php _e('Install WP Photo Album Plus as described above under "Installation".', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Create at least two albums in the "Photo Albums" tab. Leave "Parent" at "--- none ---".', 'wp-photo-album-plus'); ?></li>
<li><?php _e('In the uploads tab, you can now upload you photots. Upload at least 2 photos to each album. Make sure the photos you are uploading are of reasonable size (say up to 1024x768 pixels).', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Create a new WP Page, name it something like "Photo Gallery" and put in the content:', 'wp-photo-album-plus'); ?> <tt>[wppa][/wppa]</tt></li>
<li><?php _e('Publish the page, and view the page from your WP site.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('Now, go playing with the settings in the "Settings" panel, discover all the configurable options and watch what is happening when you re-open the "Photo Gallery" page.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('If you want a "Photo of the day" sidebar widget you can use an album for that purpose. See all the options in the "Photo of the day" submenu.', 'wp-photo-album-plus'); ?></li>
</ol>
<h3><?php _e('Creating a Photo Album Page or a Post with photos - Advanced', 'wp-photo-album-plus'); ?></h3>
<p>
<?php _e('Create a page like you normally would in WordPress, using the "Default Template". In my example, give it the page title of "Photo Gallery". In the Page Content section add the following code:', 'wp-photo-album-plus'); ?><br />
<tt>[wppa][/wppa]</tt><br />
<?php _e('This will result in a gallery of all Albums that have their parent set to "--- none ---".', 'wp-photo-album-plus'); ?><br /><br />
<?php _e('If you want to display a single album - say album number 19 - in a WP page or WP post (they act exactly the same), modify the shortcode like this:', 'wp-photo-album-plus'); ?><br />
<tt>[wppa type="album" album="19"][/wppa]</tt><br />
<?php _e('This will result in the display of the <b>contents</b> of album nr 19.', 'wp-photo-album-plus'); ?><br /><br />
<?php _e('If you want to display the <b>cover</b> of the album, i.e. like one of the albums in the "Photo Gallery" as used above, use a schortcode like this:', 'wp-photo-album-plus'); ?><br />
<tt>[wppa type="cover" album="19"][/wppa]</tt><br /><br />
<?php _e('If you want to display the <b>slideshow</b> directly, use:', 'wp-photo-album-plus'); ?><br />
<tt>[wppa type="slide" album="19"][/wppa]</tt><br /><br />
<?php _e('You can add a third argument if you want the photos to be displayed at a different size than normal. You can "overrule" the "Full size" setting by adding the line (for e.g. 300px):', 'wp-photo-album-plus'); ?><br />
<tt>[wppa type="album" album="19" size="300"][/wppa]</tt><br /><br />
<?php _e('The shortcode may be used more than once in a single page or post.', 'wp-photo-album-plus'); ?><br />
<?php _e('For more information see <a href="http://wppa.opajaap.nl/shortcode-reference/" >the documentation</a>', 'wp-photo-album-plus'); ?>
<br/ ><br />
<?php _e('You can also create a custom page template by dropping the following code into a page template:', 'wp-photo-album-plus'); ?><br />
<tt><?php echo wppa_albums(); ?></tt><br /><br />
<?php _e('If you want to display the <b>contents</b> of a single album in the template - say album number 19 - the code would be:', 'wp-photo-album-plus'); ?><br />
<tt><?php echo wppa_albums(19); ?></tt> or <tt><?php echo wppa_albums(19, 'album'); ?></tt><br />
<?php _e('If you want the <b>cover</b> to be displayed instead, use the following code:', 'wp-photo-album-plus'); ?><br />
<tt><?php echo wppa_albums(19, 'cover'); ?></tt><br />
<?php _e('And to display the <b>slideshow</b> it would be:', 'wp-photo-album-plus'); ?><br />
<tt><?php echo wppa_albums(19, 'slide'); ?></tt><br /><br />
<?php _e('If you want to specify a size, add another argument:', 'wp-photo-album-plus'); ?><br />
<tt><?php echo wppa_albums(19, 'album', 300); ?></tt><br /><br />
<?php _e('In order to work properly, the wppa_albums() tag needs to be within the <a href="http://codex.wordpress.org/The_Loop" target="_blank">WordPress loop</a>.', 'wp-photo-album-plus'); ?><br />
<?php _e('For more information on creating custom page templates, click', 'wp-photo-album-plus'); ?> <a href="http://codex.wordpress.org/Pages#Creating_your_own_Page_Templates"><?php _e('here', 'wp-photo-album-plus'); ?></a>.<br />
</p>
<h3><?php _e('Facts to remember', 'wp-photo-album-plus'); ?></h3>
<ul class="wppa-help-ul">
<li><?php _e('You can remove the plugin and re-install the latest version always. This will not affect your photos or albums.', 'wp-photo-album-plus'); ?></li>
<li><?php _e('If you go back in version no, run the Setup procedure in <b>Table VIII-A1</b> of the Photo Albums->Settings admin page.', 'wp-photo-album-plus'); ?></li>
</ul>
<h3><?php _e('Plugin Support And Feature Request', 'wp-photo-album-plus'); ?></h3>
<p>
<?php _e('If you\'ve read over this readme carefully and are still having issues, if you\'ve discovered a bug,', 'wp-photo-album-plus'); ?>
<?php _e('or have a feature request, please check the <a href="http://wordpress.org/tags/wp-photo-album-plus">forum</a> for this plugin and/or leave a question there.', 'wp-photo-album-plus'); ?>
<br />
<?php _e('For hot fixes check the <a href="http://plugins.trac.wordpress.org/log/wp-photo-album-plus/">development log</a> for this plugin.', 'wp-photo-album-plus'); ?>
<br />
<?php _e('You may also visit the <a href="http://wppa.opajaap.nl/" target="_blank">WPPA+ Docs & Demos site</a> that also contains the <a href="http://wppa.opajaap.nl/?page_id=39" target="_blank">WPPA+ Tutorial</a>.', 'wp-photo-album-plus'); ?>
</p>
<p>
<?php _e('If you love this plugin, I would appreciate a donation, either in <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=OpaJaap@OpaJaap.nl&item_name=WP-Photo-Album-Plus&item_number=Support-Open-Source¤cy_code=USD&lc=US">USD</a> or in <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=OpaJaap@OpaJaap.nl&item_name=WP-Photo-Album-Plus&item_number=Support-Open-Source¤cy_code=EUR&lc=US">EURO</a>.', 'wp-photo-album-plus'); ?>
</p>
<h3><?php _e('About and credits', 'wp-photo-album-plus'); ?></h3>
<p>
<?php _e('WP Photo Album Plus is extended with many new features and is maintained by J.N. Breetvelt, a.k.a. (<a href="http://www.opajaap.nl/">OpaJaap</a>)', 'wp-photo-album-plus'); ?><br />
<?php _e('Thanx to R.J. Kaplan for WP Photo Album 1.5.1.', 'wp-photo-album-plus'); ?><br />
<?php _e('Thanx to E.S. Rosenberg for programming tips on security issues.', 'wp-photo-album-plus'); ?><br />
<?php _e('Thanx to Pavel Šorejs for the Numbar code.', 'wp-photo-album-plus'); ?><br />
<?php _e('Thanx to the users who reported bugs and asked for enhancements. Without them WPPA should not have been what it is now!', 'wp-photo-album-plus'); ?>
</p>
<h3><?php _e('Licence', 'wp-photo-album-plus'); ?></h3>
<p>
<?php _e('WP Photo Album is released under the', 'wp-photo-album-plus'); ?> <a href="http://www.gnu.org/licenses/gpl-2.0.html">GPLv2 or later</a> <?php _e('licence.', 'wp-photo-album-plus'); ?>
</p>
</div>
<?php
}