README
author Dan
Thu, 26 Jul 2007 14:43:45 -0400 (2007-07-26)
changeset 8 8490ce0cdd8c
parent 7 44a94a3214b8
permissions -rw-r--r--
Added sample image (Snapr logo) to the gallery on a clean installation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     1
Snapr - Image gallery in a snap!
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     2
Another fine plugin for Enano CMS
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     3
--------------------------------------------------
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     4
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     5
Welcome and thanks for downloading Snapr, the Enano plugin designed to make
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     6
turning your site into a photo or image gallery a snap.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     7
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     8
Copyright
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
     9
--------------------------------------------------
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    10
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    11
This program is free software; you can redistribute it and/or modify
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    12
it under the terms of the GNU General Public License as published by
7
44a94a3214b8 Readme said GPLv2 only, Snapr is supposed to be v2 or later at the user's option
Dan
parents: 6
diff changeset
    13
the Free Software Foundation; either version 2 of the License, or
44a94a3214b8 Readme said GPLv2 only, Snapr is supposed to be v2 or later at the user's option
Dan
parents: 6
diff changeset
    14
(at your option) any later version.
6
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    15
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    16
This program is distributed in the hope that it will be useful,
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    17
but WITHOUT ANY WARRANTY; without even the implied warranty of
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    18
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    19
GNU General Public License for more details.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    20
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    21
You should have received a copy of the GNU General Public License
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    22
along with this program; if not, write to the Free Software
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    23
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    24
02111-1307, USA.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    25
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    26
Alternatively, you may view a copy of the GNU General Public License in the
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    27
file "COPYING" included with this distribution, or at the following URL:
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    28
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    29
  <http://enanocms.org/Special:GNU_General_Public_License>
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    30
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    31
If you already have Enano set up, you can view a copy of the GPL by searching
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    32
for "GNU General Public License" on your Enano site.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    33
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    34
Installing Snapr
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    35
--------------------------------------------------
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    36
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    37
To install the Snapr plugin on your site, just extract the zip or tarball file
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    38
into your Enano root folder. If you need to upload Snapr manually, upload the
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    39
file plugins/Gallery.php and the entire folder plugins/gallery/ to the
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    40
plugins/ folder inside your Enano root.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    41
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    42
To enable Snapr plugin, go to the Administration panel, expand General, click
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    43
Manage Plugins, and click Enable in the row showing the Snapr plugin.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    44
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    45
Snapr was developed to be compatible with Enano 1.0, however the copy of Enano
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    46
it was developed under was a 1.0.1 Mercurial pull. If you experience
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    47
compatibility issues with Snapr, they'll probably be fixed with an upgrade to
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    48
the latest copy of Enano in the official Mercurial repository:
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    49
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    50
  <http://nighthawk.enanocms.org/hg/enano>
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    51
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    52
Using Snapr
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    53
--------------------------------------------------
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    54
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    55
The first thing you should do once you get the plugin enabled is go to Edit the
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    56
Sidebar and add a link to Special:Gallery (or Special.Gallery if you use the
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    57
Windows compatibility patch) using normal wikilink syntax. This will enable
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    58
users to access your gallery browser without having to search around. From
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    59
there, you can browse through the gallery (it's empty by default) and create
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    60
folders as needed. Images can be moved in between folders using the Edit Image
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    61
links on each image page or through the drop-down menu that shows when you
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    62
hover over an image title in the gallery browser.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    63
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    64
Snapr also hooks into the sidebar and search subsystems. You can add a block to
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    65
your sidebar that shows a random image from Snapr's gallery by going to Edit
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    66
The Sidebar -> Create New Block, selecting Use Code from a Plugin, and
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    67
selecting "Random Image" from the dropdown menu. The search hook is automatic;
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    68
whenever you perform a search, image results will be displayed on the search
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    69
page.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    70
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    71
Obtaining support
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    72
--------------------------------------------------
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    73
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    74
Support for Snapr is available via the same support channels as Enano, as it
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    75
is developed and maintained by the official Enano team. For support options,
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    76
both free and commercial, please see <http://enanocms.org/Contact_us>.
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    77
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    78
Have fun!
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    79
6c753cf22ee8 Included XCFs and SVGs for most images, which probably count as "corresponding source" under the GPL
Dan
parents: 1
diff changeset
    80
-- The Enano team