Documentation site

Read important announcements about Group-Office here

Moderator: Developers

mschering
Site Admin
Site Admin
Posts: 8154
Joined: Tue Apr 20, 2004 1:06 pm
Location: The Netherlands - Den Bosch
Contact:

Documentation site

Postby mschering » Wed Feb 14, 2007 4:54 pm

I'm starting a new documentation site for GO at http://docs.group-office.com

I wonder is there are people that are willing to contribute to this site and add documentation. If you are please let me know.
Last edited by mschering on Thu Oct 30, 2008 1:32 pm, edited 1 time in total.
Best regards,

Merijn Schering
Intermesh
User avatar
dkittell
Site Admin
Site Admin
Posts: 808
Joined: Tue May 25, 2004 10:32 pm
Location: Michigan, USA
Contact:

Postby dkittell » Wed Feb 14, 2007 5:21 pm

What kind of help are you looking for?
David Kittell
Owner / Developer
Kittell.net
mschering
Site Admin
Site Admin
Posts: 8154
Joined: Tue Apr 20, 2004 1:06 pm
Location: The Netherlands - Den Bosch
Contact:

Postby mschering » Thu Feb 15, 2007 8:36 am

Well maybe people already have written some howto documents or manuals for their own use and want to contribute that to the docs site.
Best regards,



Merijn Schering

Intermesh
ComSubVie
Group-Office Developer
Group-Office Developer
Posts: 214
Joined: Tue Apr 20, 2004 1:45 pm
Location: Vienna, Austria
Contact:

Postby ComSubVie » Fri Feb 23, 2007 10:27 am

That's great! I'd like to contribute at least LDAP HowTo, once written.

btw: wouldn't it be better to use a wiki for this?
User avatar
lonesomewalker
Posts: 320
Joined: Wed Sep 15, 2004 9:15 am
Location: everywhere
Contact:

Postby lonesomewalker » Tue Feb 27, 2007 9:17 pm

Well, usually i like the idea of a wiki.

But who will controll, who has written what?

I think, only developers should be able to edit.
Others can send their stuff to them.
ComSubVie
Group-Office Developer
Group-Office Developer
Posts: 214
Joined: Tue Apr 20, 2004 1:45 pm
Location: Vienna, Austria
Contact:

Postby ComSubVie » Wed Feb 28, 2007 12:55 pm

Some short comments to the coding guidelines:

In the phpDoc comments the *'s in the lines after /** should be under the first star of /**, the guidelines are missing a space here. In the lines where no star is (so that these lines are not included in the generated documentation) the text should be indented as it would have been with a star (there are also missing spaces in the guidelines).

The "@version $Revision: 1.44 $ $Date: 2006/11/14 12:56:56 $" part of the header is great, however $%&@%$&§ subversion doesn't support these. I don't think that a manual modification will work, so i'd just leave it as is, and make a release-script which changes these values to the current version when the release-package/archive is generated. This can be included in the release-script that run's all testcases before the package is generated (as far as i know this doesn't exist at the moment).
mschering
Site Admin
Site Admin
Posts: 8154
Joined: Tue Apr 20, 2004 1:06 pm
Location: The Netherlands - Den Bosch
Contact:

Postby mschering » Wed Feb 28, 2007 4:16 pm

Yes I noticed that too. Will subversion support it in the future or something like it?
Best regards,



Merijn Schering

Intermesh
ComSubVie
Group-Office Developer
Group-Office Developer
Posts: 214
Joined: Tue Apr 20, 2004 1:45 pm
Location: Vienna, Austria
Contact:

Postby ComSubVie » Thu Mar 01, 2007 7:55 am

No, subversion does not have and will not have support for this, because subversion works different from cvs - in cvs the version id is different for each file, therefore it is easy to include the current version of a file when checking out/updating.
in subversion there is no version id for the file, there is only the version id of the whole project. to include this version in the file, you would have to check out all files again, so that this string can be included.

However I just read that $Revision$ and $Date$ work with subversion, they just don't include the global version, but Revision and Date of the last change of this file. We just have to enable this for the file (I'm not sure if this is a local or a remote setting). I've just executed the following command in my svn directory:

Code: Select all

svn propset svn:keywords "Date Revision" -R www/ scripts/

when I delete a file and check it out again the revision and date is now set. I think we need to set these properties for a new file again, since there doesn't seem to be a global setting for this - or I just haven't found it.
ComSubVie
Group-Office Developer
Group-Office Developer
Posts: 214
Joined: Tue Apr 20, 2004 1:45 pm
Location: Vienna, Austria
Contact:

Postby ComSubVie » Thu Mar 01, 2007 2:38 pm

Me again ;)
What I wrote before does only rewrite the strings on each checkout on the local system. On other systems the strings will not be rewritten. However there is a solution to it:

Code: Select all

svn propset svn:keywords --revprop -r HEAD "Date Revision"

This stores the properties on the server, so that they will work with each checkout. However, there's still a problem: I cannot do this, because the svn on sf.net is missing the corresponding hook script (see http://svnbook.red-bean.com/en/1.0/ch05 ... 5-sect-2.1 - pre-revprop-change). It is possible to create this script (an empty one should do fine) using the sf.net account, but I do not have enough privileges: http://sourceforge.net/docs/E09#scripts

Please could you try this so that we have our Code-Tags working again?
mschering
Site Admin
Site Admin
Posts: 8154
Joined: Tue Apr 20, 2004 1:06 pm
Location: The Netherlands - Den Bosch
Contact:

Postby mschering » Thu Mar 01, 2007 3:11 pm

This particular hook script is not available at Sourceforge. You can't create your own. You can only select a few :(
Best regards,



Merijn Schering

Intermesh
ComSubVie
Group-Office Developer
Group-Office Developer
Posts: 214
Joined: Tue Apr 20, 2004 1:45 pm
Location: Vienna, Austria
Contact:

Postby ComSubVie » Fri Mar 02, 2007 8:04 am

:(
let us create a feature request ;)
mschering
Site Admin
Site Admin
Posts: 8154
Joined: Tue Apr 20, 2004 1:06 pm
Location: The Netherlands - Den Bosch
Contact:

Postby mschering » Tue Mar 20, 2007 1:56 pm

Check out this new getting started tutorial:

http://docs.group-office.com/index.php? ... &file_id=0
Best regards,



Merijn Schering

Intermesh
j0hn
Posts: 65
Joined: Tue Jan 24, 2006 3:21 am
Contact:

finally did some videos - just getting started

Postby j0hn » Thu Apr 12, 2007 1:28 am

Hi,
I have 120+ users - I just made these intros today..

http://www.youtube.com/view_play_list?p ... 617F8969B2

John
mschering
Site Admin
Site Admin
Posts: 8154
Joined: Tue Apr 20, 2004 1:06 pm
Location: The Netherlands - Den Bosch
Contact:

Postby mschering » Thu Apr 12, 2007 6:37 am

Hi John,

Great job! I could link to those video's from the docs site.
What software did you use to create those video's?
Best regards,



Merijn Schering

Intermesh
rz
Posts: 57
Joined: Thu Mar 02, 2006 1:09 pm

Postby rz » Thu Apr 12, 2007 1:41 pm

For my part i use wink to make flash video.
-> http://www.debugmode.com/wink/
I've done a few about GO. Works great.

Return to “Announcements”

Who is online

Users browsing this forum: No registered users and 1 guest

cron