thoughts
[ikiwiki.git] / doc / plugins / contrib / album / discussion.mdwn
1 thanks for this plugin.  it might help me in my application, which is to provide album/galleries which can be edited (ie. new images added, taken away, etc.) through web interface.
2
3 > That's my goal eventually, too. Perhaps you can help to
4 > design/write this plugin? At the moment I'm mostly
5 > waiting for a design "sanity check" from [[Joey]],
6 > but any feedback you can provide on the design would
7 > also be helpful. --[[smcv]]
8
9 i have two challenges: firstly, for installation, i'm not sure what all the files are that need to be downloaded (because of my setup i can't easily pull the repo).  so far i have Ikiwiki/Plugins/album.pm; ikiwiki-album; and 4 files in templates/  any others?
10
11 > Those are all the added files; ikiwiki-album isn't strictly
12 > needed (IkiWiki itself doesn't use that code, but you can
13 > use it to turn a directory full of images into correct
14 > input for the album plugin).
15 >
16 > You probably also want the album plugin's expanded version of
17 > style.css (or put its extra rules in your local.css).
18 > Without that, your albums will be quite ugly.
19 >
20 > There aren't currently any other files modified by my branch.
21 > --[[smcv]]
22
23 secondly: barring the CGI interface for editing the album, which would be great, is there at least a way to use attachment plugin or any other to manually add images and then create viewers for them?
24
25 > Images are just attachments, and viewers are pages (any supported
26 > format, but .html will be fastest to render). Attach each image,
27 > then write a page for each image containing the
28 > \[[!albumimage]] directive (usually it will *only* contain that
29 > directive).
30 >
31 > The script ikiwiki-album can help you to do this in a git/svn/etc.
32 > tree; doing it over the web will be a lot of work (until I get
33 > the CGI interface written), but it should already be possible!
34 >
35 > The structure is something like this:
36
37 > * album.mdwn (contains the \[[!album]] directive, and perhaps also
38 >   some \[[!albumsection]] directives)
39 > * album/a.jpg
40 > * album/a.html (contains the \[[!albumimage]] directive for a.jpg)
41 > * album/b.jpg
42 > * album/b.html (contains the \[[!albumimage]] directive for b.jpg)
43 >
44 > Have a look at ikiwiki-album to see how the directives are meant to
45 > work in practice.
46 >
47 > --[[smcv]]
48
49 i'm new to ikiwiki, apologies if this is dealt with elsewhere.  -brush
50
51 > This plugin is pretty ambitious, and is unfinished, so I'd recommend
52 > playing with  a normal IkiWiki installation for a bit, then trying
53 > out this plugin when you've mastered the basics of IkiWiki. --[[smcv]]
54
55 ----
56
57 You had wanted my feedback on the design of this. I have not looked at the
58 code or tried it yet, but here goes. --[[Joey]] 
59
60 * Needing to create the albumimage "viewer" pages for each photo
61   seems like it will become a pain. Everyone will need to come up
62   with their own automation for it, and then there's the question
63   of how to automate it when uploading attachments.
64 * With each viewer page having next/prev links, I can see how you
65   were having the scalability issues with ikiwiki's data structures
66   earlier!
67 * And doesn't each viewer page really depend on every other page in the
68   same albumsection? If a new page is added, the next/prev links
69   may need to be updated, for example. If so, there will be much
70   unnecessary rebuilding.
71 * One thing I do like about having individual pages per image is
72   that they can each have their own comments, etc.
73 * Seems possibly backwards that the albumimage controls what album
74   an image appears in. Two use cases -- 1: I may want to make a locked
75   album, but then anyone who can write to any other page on the wiki can
76   add an image to it. 2: I may want an image to appear in more than one
77   album. Think tags. So it seems it would be better to have the album
78   directive control what pages it includes (a la inline).
79 * Putting a few of the above thoughts together, my ideal album system
80   seems to be one where I can just drop the images into a directory and
81   have them appear in the album index, as well as each generate their own wiki
82   page. Plus some way I can, later, edit metadata for captions,
83   etc. (Real pity we can't just put arbitrary metadata into the images
84   themselves.) This is almost pointing toward making the images first-class
85   wiki page sources. Hey, it worked for po! :) But the metadata and editing
86   problems probably don't really allow that.