Documentation of Gallery 3

hukoeth

Joined: 2009-03-20
Posts: 127
Posted: Mon, 2010-09-27 12:39

Hi all,
I have started documenting Gallery 3 on codex: http://codex.gallery2.org/Gallery3:User_guide. I am starting this thread for feedback and to coordinate efforts on getting this done.

Any help is greatly appreciated.

Regards,
Uli

---
Build bridges not barriers.

 
bharat
bharat's picture

Joined: 2002-05-21
Posts: 7994
Posted: Tue, 2010-09-28 01:53

OMG, dude that totally rocks! Keep up the great work!
---
Problems? Check gallery3/var/logs
bugs/feature req's | upgrade to the latest code | use git

 
hukoeth

Joined: 2009-03-20
Posts: 127
Posted: Tue, 2010-09-28 06:33

Hi bharat,
Thank you for the kind words. I was wondering if you could help me with three questions:
1. Modules can have an uninstall function but I couldn't find any code that calls this function nor could I find anything on trac that actually mentions if this will be implemented at one point (at least it's not 100% clear to me from the description of the ticket and changeset I found related to this)
2. What are the exact PHP requirements for Gallery 3 to work? I found that the version has to to be 5.2.3 and that short ini tags is a must as well as the configuration set by .htaccess but want to be sure before I put this into the documentation.
3. What MySQL version is required?

Thank you,
Uli

---
Build bridges not barriers.

 
bharat
bharat's picture

Joined: 2002-05-21
Posts: 7994
Posted: Tue, 2010-09-28 17:56

1) We don't have a UI for uninstall yet. I'm thinking of doing it the way that Drupal does and have a separate "Uninstall" tab which lists all the modules that are currently active and have uninstall code available. It's not in 3.0 mainly because there's no strong need for it yet.

Requirements:
PHP 5.2.3+ with short_open_tag enabled
Unix
MySQL 5+
PHP must have the following extensions:
Perl Compatible Regular Expressions (PCRE) - http://php.net/pcre
Standard PHP Library (SPL) - http://php.net/spl
Reflection - http://php.net/reflection
Filter - http://php.net/filter
Iconv - http://php.net/iconv
SimpleXML - http://php.net/simplexml
Multibyte String (mbstring) - http://php.net/mbstring
JavaScript Object Notation (JSON) - http://php.net/manual/en/book.json.php

All of those extensions are shipped with PHP by default, so most installs should have them. We also check for all of those things in the G3 installer.

---
Problems? Check gallery3/var/logs
bugs/feature req's | upgrade to the latest code | use git

 
rlparadise

Joined: 2009-12-27
Posts: 65
Posted: Fri, 2010-10-01 16:17

Just a couple of thoughts and I can make any mods (if you like). However, I didn't want to make a mess of your hard work.

On the upgrade section, I believe it is worth adding that if you have any non-codex themes OR modules installed that they will get in the way of an upgrade. G3 does just fine on the process you listed until it cannot find the default theme or a missing module. Not sure the best way to describe/handle that OR if that would best go under a common troubleshooting/problems section.

On the videos section, it may be worth noting a few things about ffmpeg and FLV/MP4 file playback. There seems to be a lot of things that can cause streaming/playback issues. Some thoughts are captured on these threads (and there are more):

http://gallery.menalto.com/node/97138
http://gallery.menalto.com/node/97915

Like I said, I'll be happy to update the documents myself. I just don't want to get in your way.

 
hukoeth

Joined: 2009-03-20
Posts: 127
Posted: Fri, 2010-10-01 18:44

Hi rlparadise,
All valid points thanks for the feedback. Please feel free to modify whatever you want. I am thankful for any help / feedback / criticism / ideas etc. anyone has to offer. Feels good not to be alone on this :-)

Regards,
Uli

---
Build bridges not barriers.

 
3.14159

Joined: 2010-03-25
Posts: 64
Posted: Mon, 2010-10-04 17:03

Hi, outstanding work! How about adding a list of third-party apps that can communicate with Gallery3, like the one for Gallery2 somewhere in there? I don't know if that would be a good place for something like this, but I think it would be helpful to have such a list, I found the G2 one to be really useful. What is more, the REST api is a major feature and people ought to know how to make use of it. I'd be glad to help with that if needed, so .. what do you think?

- Three

 
thesaxinfo

Joined: 2010-04-15
Posts: 8
Posted: Tue, 2010-10-05 17:15

I can't commit to it right now, but I'll see if I can help out with documentation; it's one of my many former jobs. Might not be able to help until Jan., tho.

 
Joe Siegler
Joe Siegler's picture

Joined: 2005-09-14
Posts: 54
Posted: Tue, 2010-10-19 14:32

One question about G3. Can it do a complete replacement for G2 insofar as URL's and image resizes? I ask because I have two sites whose images are driven by G2 images. If G3 can't respect the same URL's used for pictures by G2, I can't upgrade, it would immediately break too many places on my sites.

That's fine, G2 works, I don't have a problem staying there, but I would like to go to G3.

 
nivekiam
nivekiam's picture

Joined: 2002-12-10
Posts: 16504
Posted: Tue, 2010-10-19 15:52

Right now it looks like to get G2 URLs to fully rewrite to G3, G3 needs to be installed in a different directory. Please tell me you're a rewriting expert so we can figure out the right rules :)

For image reseizes, G3 only supports 1 resized version. That's it and there are no plans to implement anything further for that in the core product. I believe it could be extended with a module, but the vast majority of people only use 1 resize so we're not going to complicate the UI or the code base with having multiple resizes.
____________________________________________
Like Gallery? Like the support? Donate now!!! See G2 live here

 
Joe Siegler
Joe Siegler's picture

Joined: 2005-09-14
Posts: 54
Posted: Tue, 2010-10-19 15:57

Then I guess I'm sticking with G2, as I HAVE to have the resizes - all of them.

 
nivekiam
nivekiam's picture

Joined: 2002-12-10
Posts: 16504
Posted: Tue, 2010-10-19 16:04

At least for now. I'm sure someone from the community at some point will create a "multi resize" module or something like that.
____________________________________________
Like Gallery? Like the support? Donate now!!! See G2 live here

 
BlakJak

Joined: 2010-12-05
Posts: 2
Posted: Mon, 2010-12-06 08:14

For the record I was looking for multiple-resize as well, I often create multiple versions, for example:

~400-450px for website embedding
~640-800px for general viewing
~1024-1600 for higher res viewing
+ original

Having gone to G3 it looks like i'll have to have an additional stage of offline processing - to produce something around 1024px - and not publish the high res versions. That's quite annoying....

 
quatermass

Joined: 2004-10-13
Posts: 14
Posted: Tue, 2010-12-21 22:19

I'd like to see a section on configuring G3 to edit the emails that get sent out by G3.

--
Stuart Halliday

 
Librum
Librum's picture

Joined: 2011-01-16
Posts: 10
Posted: Tue, 2011-01-18 07:48

Posting here, as directed in the Gallery 3 User guide, via the link there.

Two minor edits for Gallery3:Modules:serveradd.

The first one is a nomenclature one. Nitpicky, I admit, but it threw me for a bit. Under Description, 'from the local server'. For many large content sites, like ours, 'local server' is a development server, while 'remote server' is the 'live' server. Suggest changing 'local' to 'web' to remove any ambiguity.

The second one is under Installation/Configuration, #2. This path statement is misleading. One can not address a path 'under' the directory that Gallery3 is installed in. Below, in the graphic, it is '/var/uploads', which is recognized, not the full server path.

Sarah.

"Ever wish to know what thy grandparents knew? Thee CAN!"

 
nivekiam
nivekiam's picture

Joined: 2002-12-10
Posts: 16504
Posted: Wed, 2011-01-19 20:48
Quote:
The second one is under Installation/Configuration, #2. This path statement is misleading. One can not address a path 'under' the directory that Gallery3 is installed in. Below, in the graphic, it is '/var/uploads', which is recognized, not the full server path.

Perhaps I should have used a better path, but that is in fact a full path. It is in fact /var/upload on my server that I created those screenshots from. I'm root on the server and am able to use and create directories under /var (at the root of the server).

I can see how that can be misleading since we use a "var" directory under gallery3, however, I can't possibly think of any "proper" path for an example there that won't confuse people. If I were to use /usr/www/users/nivekiam/upload that would throw people off because they wouldn't be able to find /usr/www/users on their system.

I think I may create a dummy path on my system /path/to/your/upload/directory or something like that and recreate that screenshot. Does that look/sound better to you?

As for your other edits, feel free to create an account on the Codex and edit the pages as you see fit. The docs are for users by users. What makes sense to us who are intimately familiar with the product doesn't necessarily make sense to someone else.
____________________________________________
Like Gallery? Like the support? Donate now!

 
Librum
Librum's picture

Joined: 2011-01-16
Posts: 10
Posted: Wed, 2011-01-19 22:38

nivekiam,

The graphic is fine, it is the statement that is the problem.

And, again, as this is a 'community contributed module', I do not want to step on the author's toes by editing his 'baby'. Yes, I see that it is 'core', but my reservations still applies. I am NOT a programmer, just a research librarian.

Here is the statement:

"The path is a server file structure, not a url. eg to use the uploads directory you would input home/<username>/sitename/htdocs/var/uploads"

Wouldn't that be: home/<username>/sitename/htdocs/<gallery3 directory>/var/uploads?

But it is not. You can not get it to recognize anything below home/<username>/sitename/htdocs/<gallery3 directory>, and I suspect this is a site safety/security issue, which should not be tinkered with.

Try this language, and see if it makes more sense to you.

"The path is a server file structure, not a url, based off the directory you installed Gallery3 in. During installation, Gallery3 created an uploads directory under the directory you installed Gallery3 into. To use this directory, you would input /var/uploads"

Sarah
"Ever wish to know what thy grandparents knew? Thee CAN!"

 
nivekiam
nivekiam's picture

Joined: 2002-12-10
Posts: 16504
Posted: Wed, 2011-01-19 23:01
Quote:
I am NOT a programmer, just a research librarian.

GREAT! Seriously, that's really great! Please feel free to update any and all documentation you have access to or you run across that you see needs to be updated/corrected. If we don't want someone editing it (like this page http://codex.gallery2.org/Main_Page) it gets locked down. Other than that, it's wide open.

Please you have my permission, not only as someone who's been around here for over 8 years, but as a core team member, moderator of these forums, "super user/admin" of the codex and a member of the doc team (though I tend to fail miserably at that task).

Quote:
"The path is a server file structure, not a url. eg to use the uploads directory you would input home/<username>/sitename/htdocs/var/uploads"

Wouldn't that be: home/<username>/sitename/htdocs/<gallery3 directory>/var/uploads?

No, not necessarily. It could be, but then your "upload" directory would be web-accessible. I wouldn't put it under Gallery's "var" directory. I've just edited that comment. Please let me know if that clears things up.

Quote:
"The path is a server file structure, not a url, based off the directory you installed Gallery3 in. During installation, Gallery3 created an uploads directory under the directory you installed Gallery3 into. To use this directory, you would input /var/uploads"

That would be fine, however, G3 doesn't create any such directory, and /var/uploads would refer to the /var directory at the very root of the server. It's the full system path that's needed for that, it's not relative to where Gallery is installed.

EDIT: I also updated the other comment to read:
Note: Only a Gallery 3 user with administrator privileges is able to import files from the local file system of the server where Gallery 3 is installed.

However, reading over that again, it's a bit "wordy". I hope it's not confusing to users, if you can think of a clearer way to express that, please post it here or update the page :)
____________________________________________
Like Gallery? Like the support? Donate now!

 
Librum
Librum's picture

Joined: 2011-01-16
Posts: 10
Posted: Thu, 2011-01-20 21:17

I am talking 'relative' path and you are talking 'absolute'. OK, I can work with that, but your first example is not an absolute path but a relative one. There is no 'fronting slash'. "The path is a server file structure, not a url. eg to use the uploads directory you would input home/<username>/sitename/htdocs/var/uploads". Put a slash in front of "home/...".

That would fix the confusion, if one only wanted to do absolute.

Wait, no it would not, as I have not discovered the true path. And so others would not. I have been using relative path.

Relative works somewhat.

Anything after the gallery install directory will have its directory recognized by the system. Again, my example of 'var/uploads' does see the <document root>/<gallery install>/var/uploads, and has no problem seeing and adopting the files.

But if you use '../' as the path, you are seeing <document root>, and while the system does not complain about not being able to see the directory, it does see it, but will not find the files there. Or, you can go back further with '../../', but same issue.

Is this a bug? Oversight? Am I doing something wrong? Relative should be documented, even if it only works right of the <gallery directory>.

Sarah

"Ever wish to know what thy grandparents knew? Thee CAN!"

 
Librum
Librum's picture

Joined: 2011-01-16
Posts: 10
Posted: Fri, 2011-01-21 19:03

nivekiam,

I am awaiting a response from a *nix guru. Will be back...

Sarah

"Ever wish to know what thy grandparents knew? Thee CAN!"

 
nivekiam
nivekiam's picture

Joined: 2002-12-10
Posts: 16504
Posted: Fri, 2011-01-21 19:28

I don't think the Server add module is intended to work correctly with relative paths. I'd have to either look at the code or ask the author to be sure, but I think that would just be a really confusing concept for most people.

IMO and I'm pretty sure it's only expecting the full system path.
/home/librum/public_html/upload

/var/random_stuff/uploads

/usr/www/users/librum/upload

etc
____________________________________________
Like Gallery? Like the support? Donate now!

 
Librum
Librum's picture

Joined: 2011-01-16
Posts: 10
Posted: Tue, 2011-01-25 20:16

"The path is a server file structure, not a url. eg to use the uploads directory you would input home/<username>/sitename/uploads"

Change to:
"The path is a server file structure, not a url. eg to use the uploads directory you would input /<home>/<username>/sitename/uploads. This is the absolute path addressing, which is recommended over relative path addressing. Due to some server limitations relative path addressing may not work."

Tests show that two of the servers I have access to have no problem with the relative path addressing, but the three others, to include the web server does.

Well, we have finished our testing. Alas, we will have to pass. No AUP-like functions.

Sarah.

"Ever wish to know what thy grandparents knew? Thee CAN!"

 
sluggy

Joined: 2006-09-25
Posts: 7
Posted: Sat, 2011-08-27 18:20

I'm upgrading to gallery3. I wanted to have the same effect in my album that I was able to configure in gallery2. It looks like this: http://slugsoft.com/photos/main.php?g2_itemId=772. How can I get this collage effect with the wind theme?

 
floridave
floridave's picture

Joined: 2003-12-22
Posts: 27300
Posted: Sat, 2011-08-27 23:21

sluggy, please start a new thread, your question has little to do with the topic.

Dave
_____________________________________________
Blog & G2 || floridave - Gallery Team