SDL documentation wiki

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that we have some
way of organizing it and generating documentation that can be put in
future SDL releases.

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that we have some
way of organizing it and generating documentation that can be put in
future SDL releases.

Ok, first I need a login on the machine so I can poke around and find
out what is there. My guess is that you already have php and mysql
running on apache. What OS/Distro are you running? I’ll look for tools
that allow the documents to be extracted into a “book” format suitable
for inclusion as documentation. Hmmm… needs to extract as pure HTML.
It would be nice to have a forum for discussion of the docs as well as
the docs.

We need to register people who are going to modify the docs. Do we need
to moderate all changes and postings?

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their legal
problems with ownership? What license do you want to put on the docs?

Feel free to tell me to make up my own mind on all these issues.

		Bob PendletonOn Wed, 2004-06-09 at 11:55, Sam Lantinga wrote:

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

±-------------------------------------+

i’m feeling somehow ignored…(-> [ANN] doc project to wiki)

Sam Lantinga wrote:>Bob Pendleton wrote:

"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that we have some
way of organizing it and generating documentation that can be put in
future SDL releases.

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their legal
problems with ownership? What license do you want to put on the docs?

the owner already allowed me to use the original doc project texts.

i’m feeling somehow ignored…(-> [ANN] doc project to wiki)

I can understand that. I first talked to Sam about doing this a couple
of years ago. Since then I have written several published articles on
SDL and taught a college level game programming class using SDL. Plus,
it turns out that Sam used my first open source project as the basis for
one of his early projects. So, we have some history.

Believe me, I will not ignore you. I posted a list of questions that you
can help me answer. We need something, most likely some sort of wiki
that allows the documentation to be extracted in “book” form as standard
HTML so it can be included in the SDL distribution. It also needs to
support a forum so people can comment on individual pages of docs. And,
it must have a way to register people who are authorized to make
changes. Not to mention that it must be possible to “roll back” changes
that have been made on a per page basis so that nasty people and
spammers have as little chance to mess things up as possible. What else
must it do?

It would be nice if it works with the software that is already on
libsdl.org.

Suggestions?

	Bob PendletonOn Wed, 2004-06-09 at 13:12, Florian Hufsky wrote:

Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that we have some
way of organizing it and generating documentation that can be put in
future SDL releases.

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

±-------------------------------------+

I’ll look for tools that allow the documents to be
extracted into a “book” format suitable for inclusion as
documentation.

Some wiki implementations have the ability to export pages. Else you can
write some PHP to spider the site, parse pages and replace WikiLinks with
normal links, and shove all the pages into a zip file for offline download.
The UnrealWiki did something like this to keep people from using offline
browsers ( http://wiki.beyondunreal.com/wiki/Offline_Wiki ).

We need to register people who are going to modify the docs.
Do we need to moderate all changes and postings?

There is little point to having a wiki if it’s closed to community
contributions. All moderation can be done via the community monitoring the
recent change list.

Tom> -----Original Message-----

From: sdl-bounces+tom=sickheadgames.com at libsdl.org
[mailto:sdl-bounces+tom=sickheadgames.com at libsdl.org] On
Behalf Of Bob Pendleton
Sent: Wednesday, June 09, 2004 1:11 PM
To: A list for developers using the SDL library. (includes
SDL-announce)
Subject: Re: [SDL] SDL documentation wiki

On Wed, 2004-06-09 at 11:55, Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki
and help get
it set up on libsdl.org. My biggest concern is that we
have some way
of organizing it and generating documentation that can be put in
future SDL releases.

Ok, first I need a login on the machine so I can poke around
and find out what is there. My guess is that you already have
php and mysql running on apache. What OS/Distro are you
running? I’ll look for tools that allow the documents to be
extracted into a “book” format suitable for inclusion as
documentation. Hmmm… needs to extract as pure HTML.
It would be nice to have a forum for discussion of the docs
as well as the docs.

We need to register people who are going to modify the docs.
Do we need to moderate all changes and postings?

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their
legal problems with ownership? What license do you want to
put on the docs?

Feel free to tell me to make up my own mind on all these issues.

  	Bob Pendleton

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

±-------------------------------------+


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

Why bother dealing with all those issues? Why not just let the wiki be
the dynamic thing that it is? I’m sure anyone who downloads SDL will not
need a static version of the wiki’d docs, since they can just go to the
wiki itself. Let’s just keep it simple.

I strongly disagree with the notion of restricting access. If I read a
portion of the docs that don’t make sense to me, I’d like to be able to
note that so that someone can add a bit of clarification later. If we
want traditional, static docs, don’t bother with a wiki - They’re too
(two) different animals.

Bob Pendleton wrote:> On Wed, 2004-06-09 at 11:55, Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that we have some
way of organizing it and generating documentation that can be put in
future SDL releases.

Ok, first I need a login on the machine so I can poke around and find
out what is there. My guess is that you already have php and mysql
running on apache. What OS/Distro are you running? I’ll look for tools
that allow the documents to be extracted into a “book” format suitable
for inclusion as documentation. Hmmm… needs to extract as pure HTML.
It would be nice to have a forum for discussion of the docs as well as
the docs.

We need to register people who are going to modify the docs. Do we need
to moderate all changes and postings?

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their legal
problems with ownership? What license do you want to put on the docs?

Feel free to tell me to make up my own mind on all these issues.

  	Bob Pendleton

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

Not to mention that it must be possible to
"roll back" changes that have been made on a per page basis
so that nasty people and spammers have as little chance to
mess things up as possible.

If it doesn’t have this feature its really not a Wiki.

Tom> -----Original Message-----

From: sdl-bounces+tom=sickheadgames.com at libsdl.org
[mailto:sdl-bounces+tom=sickheadgames.com at libsdl.org] On
Behalf Of Bob Pendleton
Sent: Wednesday, June 09, 2004 1:21 PM
To: A list for developers using the SDL library. (includes
SDL-announce)
Subject: Re: [SDL] SDL documentation wiki

On Wed, 2004-06-09 at 13:12, Florian Hufsky wrote:

i’m feeling somehow ignored…(-> [ANN] doc project to wiki)

I can understand that. I first talked to Sam about doing this
a couple of years ago. Since then I have written several
published articles on SDL and taught a college level game
programming class using SDL. Plus, it turns out that Sam used
my first open source project as the basis for one of his
early projects. So, we have some history.

Believe me, I will not ignore you. I posted a list of
questions that you can help me answer. We need something,
most likely some sort of wiki that allows the documentation
to be extracted in “book” form as standard HTML so it can be
included in the SDL distribution. It also needs to support a
forum so people can comment on individual pages of docs. And,
it must have a way to register people who are authorized to
make changes. Not to mention that it must be possible to
"roll back" changes that have been made on a per page basis
so that nasty people and spammers have as little chance to
mess things up as possible. What else must it do?

It would be nice if it works with the software that is
already on libsdl.org.

Suggestions?

  Bob Pendleton

Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that
we have some

way of organizing it and generating documentation that can
be put in

future SDL releases.

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

±-------------------------------------+


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

i’m currently looking for wiki software.
user registration is somethign almost every wiki has.
i haven’t looked at rollback support yet, but i think that’s also a
standard feature.
and i’m also looking for wikis wich can be exported to html sites (book)

Bob Pendleton wrote:>On Wed, 2004-06-09 at 13:12, Florian Hufsky wrote:

i’m feeling somehow ignored…(-> [ANN] doc project to wiki)

I can understand that. I first talked to Sam about doing this a couple
of years ago. Since then I have written several published articles on
SDL and taught a college level game programming class using SDL. Plus,
it turns out that Sam used my first open source project as the basis for
one of his early projects. So, we have some history.

Believe me, I will not ignore you. I posted a list of questions that you
can help me answer. We need something, most likely some sort of wiki
that allows the documentation to be extracted in “book” form as standard
HTML so it can be included in the SDL distribution. It also needs to
support a forum so people can comment on individual pages of docs. And,
it must have a way to register people who are authorized to make
changes. Not to mention that it must be possible to “roll back” changes
that have been made on a per page basis so that nasty people and
spammers have as little chance to mess things up as possible. What else
must it do?

It would be nice if it works with the software that is already on
libsdl.org.

Suggestions?

  Bob Pendleton

Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that we have some
way of organizing it and generating documentation that can be put in
future SDL releases.

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

Bob Pendleton wrote:>On Wed, 2004-06-09 at 13:12, Florian Hufsky wrote:

i’m feeling somehow ignored…(-> [ANN] doc project to wiki)

I can understand that. I first talked to Sam about doing this a couple
of years ago. Since then I have written several published articles on
SDL and taught a college level game programming class using SDL. Plus,
it turns out that Sam used my first open source project as the basis for
one of his early projects. So, we have some history.

Believe me, I will not ignore you. I posted a list of questions that you
can help me answer. We need something, most likely some sort of wiki
that allows the documentation to be extracted in “book” form as standard
HTML so it can be included in the SDL distribution.

Well, please don’t kill the manpages. They allow me (and probably
other developpers) quick access to the documentation (I have a shortcut
under vim to access the manpage for the word currently under the
cursor). When writing kilotons of lines of codes, that’s a real timesaver.

Stephane

Tom Spilman wrote:

[snip]

There is little point to having a wiki if it’s closed to community
contributions. All moderation can be done via the community monitoring the
recent change list.

Tom

I wholeheartedly agree. The “Doc Project” need not be so much of a
"project". Lets just get the wiki up, with whatever we have for our
current docs, and we can maintain a sense of organization the just by
staying active and on top of changes that are made.

It doesn’t seem like anyone is terribly interested in building and
maintaining a monolithic, authoritative set of docs…So why try going
down that path again?>

-----Original Message-----
From: sdl-bounces+tom=sickheadgames.com at libsdl.org
[mailto:sdl-bounces+tom=sickheadgames.com at libsdl.org] On
Behalf Of Bob Pendleton
Sent: Wednesday, June 09, 2004 1:11 PM
To: A list for developers using the SDL library. (includes
SDL-announce)
Subject: Re: [SDL] SDL documentation wiki

On Wed, 2004-06-09 at 11:55, Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki

and help get

it set up on libsdl.org. My biggest concern is that we

have some way

of organizing it and generating documentation that can be put in
future SDL releases.

Ok, first I need a login on the machine so I can poke around
and find out what is there. My guess is that you already have
php and mysql running on apache. What OS/Distro are you
running? I’ll look for tools that allow the documents to be
extracted into a “book” format suitable for inclusion as
documentation. Hmmm… needs to extract as pure HTML.
It would be nice to have a forum for discussion of the docs
as well as the docs.

We need to register people who are going to modify the docs.
Do we need to moderate all changes and postings?

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their
legal problems with ownership? What license do you want to
put on the docs?

Feel free to tell me to make up my own mind on all these issues.

  	Bob Pendleton

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


±-------------------------------------+


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their legal
problems with ownership? What license do you want to put on the docs?

the owner already allowed me to use the original doc project texts.

As far as I can tell, the list of potential copyright holders includes:

Sam Lantinga
Martin Donlon
Mattias Engdeg?rd
Julian Peterson
Ken Jordan
Maxim Sobolev
Wesley Poole
Michael Vance
Andreas Umbach
Andreas Hofmeister

with

Sam Lantinga
Martin Donlon

as the primary authors. Who did you talk to and what did they say?
Are you sure they have the right to let you do what you are doing? I
think it is very important to get the legalities cleaned up first and
then to make sure that the new docs are covered under an established
license. We don’t want someone to pull a SCO on us.

I really don’t see any need to have two SDL doc wikies. I think having
one as part of libsdl.org is the best way to go.

Bob PendletonOn Wed, 2004-06-09 at 13:18, Florian Hufsky wrote:

SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

±-------------------------------------+

I agree, the man pages would have to stick around. Those would probably
be the “authoritative” docs, even if they were perpetually a bit out of
date compared to the wiki.

Stephane Marchesin wrote:> Bob Pendleton wrote:

On Wed, 2004-06-09 at 13:12, Florian Hufsky wrote:

i’m feeling somehow ignored…(-> [ANN] doc project to wiki)

I can understand that. I first talked to Sam about doing this a couple
of years ago. Since then I have written several published articles on
SDL and taught a college level game programming class using SDL. Plus,
it turns out that Sam used my first open source project as the basis for
one of his early projects. So, we have some history.

Believe me, I will not ignore you. I posted a list of questions that you
can help me answer. We need something, most likely some sort of wiki
that allows the documentation to be extracted in “book” form as standard
HTML so it can be included in the SDL distribution.

Well, please don’t kill the manpages. They allow me (and probably
other developpers) quick access to the documentation (I have a shortcut
under vim to access the manpage for the word currently under the
cursor). When writing kilotons of lines of codes, that’s a real timesaver.

Stephane


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

no.
i’m almost only using the offline documentation.
i also think that heavy restriction isn’t really necessary.
but having the documentation offline is crucial for me.

Tyler Zesiger wrote:> Why bother dealing with all those issues? Why not just let the wiki be

the dynamic thing that it is? I’m sure anyone who downloads SDL will
not need a static version of the wiki’d docs, since they can just go
to the wiki itself. Let’s just keep it simple.

I strongly disagree with the notion of restricting access. If I read a
portion of the docs that don’t make sense to me, I’d like to be able
to note that so that someone can add a bit of clarification later. If
we want traditional, static docs, don’t bother with a wiki - They’re
too (two) different animals.

Bob Pendleton wrote:

On Wed, 2004-06-09 at 11:55, Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that we have some
way of organizing it and generating documentation that can be put in
future SDL releases.

Ok, first I need a login on the machine so I can poke around and find
out what is there. My guess is that you already have php and mysql
running on apache. What OS/Distro are you running? I’ll look for tools
that allow the documents to be extracted into a “book” format suitable
for inclusion as documentation. Hmmm… needs to extract as pure HTML.
It would be nice to have a forum for discussion of the docs as well as
the docs.
We need to register people who are going to modify the docs. Do we need
to moderate all changes and postings?

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their legal
problems with ownership? What license do you want to put on the docs?
Feel free to tell me to make up my own mind on all these issues.
Bob Pendleton

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

Lets just get the wiki up, with whatever we
have for our current docs, and we can maintain a sense of
organization the just by staying active and on top of changes
that are made.

Yep. Just pick a good wiki implementation that has the features needed,
put it up, and give the link to this list. You don’t even need to add
content… The community will take over translating what’s already in the
docs over to the wiki.

Tom> -----Original Message-----

From: sdl-bounces+tom=sickheadgames.com at libsdl.org
[mailto:sdl-bounces+tom=sickheadgames.com at libsdl.org] On
Behalf Of Tyler Zesiger
Sent: Wednesday, June 09, 2004 1:30 PM
To: A list for developers using the SDL library. (includes
SDL-announce)
Subject: Re: [SDL] SDL documentation wiki

Tom Spilman wrote:

[snip]

There is little point to having a wiki if it’s closed to
community
contributions. All moderation can be done via the community
monitoring the recent change list.

Tom

I wholeheartedly agree. The “Doc Project” need not be so much
of a “project”. Lets just get the wiki up, with whatever we
have for our current docs, and we can maintain a sense of
organization the just by staying active and on top of changes
that are made.

It doesn’t seem like anyone is terribly interested in
building and maintaining a monolithic, authoritative set of
docs…So why try going down that path again?

-----Original Message-----
From: sdl-bounces+tom=sickheadgames.com at libsdl.org
[mailto:sdl-bounces+tom=sickheadgames.com at libsdl.org] On
Behalf Of Bob

Pendleton
Sent: Wednesday, June 09, 2004 1:11 PM
To: A list for developers using the SDL library. (includes
SDL-announce)
Subject: Re: [SDL] SDL documentation wiki

On Wed, 2004-06-09 at 11:55, Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki

and help get

it set up on libsdl.org. My biggest concern is that we

have some way

of organizing it and generating documentation that can be put in
future SDL releases.

Ok, first I need a login on the machine so I can poke
around and find

out what is there. My guess is that you already have php and mysql
running on apache. What OS/Distro are you running? I’ll
look for tools

that allow the documents to be extracted into a "book"
format suitable

for inclusion as documentation. Hmmm… needs to extract as
pure HTML.

It would be nice to have a forum for discussion of the docs
as well as

the docs.

We need to register people who are going to modify the docs.
Do we need to moderate all changes and postings?

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their legal
problems with ownership? What license do you want to put on
the docs?

Feel free to tell me to make up my own mind on all these issues.

  	Bob Pendleton

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


±-------------------------------------+


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

I agree, the man pages would have to stick around. Those
would probably be the “authoritative” docs, even if they were
perpetually a bit out of date compared to the wiki.

Keep them up for now… That doesn’t hurt anything, but eventually the
wiki should replace them.

Tom> -----Original Message-----

From: sdl-bounces+tom=sickheadgames.com at libsdl.org
[mailto:sdl-bounces+tom=sickheadgames.com at libsdl.org] On
Behalf Of Tyler Zesiger
Sent: Wednesday, June 09, 2004 1:33 PM
To: A list for developers using the SDL library. (includes
SDL-announce)
Subject: Re: [SDL] SDL documentation wiki

I agree, the man pages would have to stick around. Those
would probably be the “authoritative” docs, even if they were
perpetually a bit out of date compared to the wiki.

Stephane Marchesin wrote:

Bob Pendleton wrote:

On Wed, 2004-06-09 at 13:12, Florian Hufsky wrote:

i’m feeling somehow ignored…(-> [ANN] doc project to wiki)

I can understand that. I first talked to Sam about doing this a
couple of years ago. Since then I have written several published
articles on SDL and taught a college level game programming class
using SDL. Plus, it turns out that Sam used my first open source
project as the basis for one of his early projects. So, we
have some history.

Believe me, I will not ignore you. I posted a list of
questions that

you can help me answer. We need something, most likely
some sort of

wiki that allows the documentation to be extracted in
"book" form as

standard HTML so it can be included in the SDL distribution.

Well, please don’t kill the manpages. They allow me (and probably
other developpers) quick access to the documentation (I have a
shortcut under vim to access the manpage for the word
currently under
the cursor). When writing kilotons of lines of codes,
that’s a real timesaver.

Stephane


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

i talked to martin donlon.

here’s what he said:--------------------
Please, by all means. I think its a great idea.

Let me know if you need anything.

On Jun 8, 2004, at 9:27 AM, Florian Hufsky wrote:

Hi,

on the sdl mailing list the community is once again asking for someone
to port the documentation to a wiki, so it can be updated easily.
i agreed to do that (i think the documentation is a very important
part of sdl and therefore should be kept up to date).

but i need your ok to use the current doc project content.

thanks in advance, Florian Hufsky


Martin
http://akawaka.csn.ul.ie/blog.php
http://www.treyarch.com

Bob Pendleton wrote:

On Wed, 2004-06-09 at 13:18, Florian Hufsky wrote:

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their legal
problems with ownership? What license do you want to put on the docs?

the owner already allowed me to use the original doc project texts.

As far as I can tell, the list of potential copyright holders includes:

Sam Lantinga
Martin Donlon
Mattias Engdeg?rd
Julian Peterson
Ken Jordan
Maxim Sobolev
Wesley Poole
Michael Vance
Andreas Umbach
Andreas Hofmeister

with

Sam Lantinga
Martin Donlon

as the primary authors. Who did you talk to and what did they say?
Are you sure they have the right to let you do what you are doing? I
think it is very important to get the legalities cleaned up first and
then to make sure that the new docs are covered under an established
license. We don’t want someone to pull a SCO on us.

I really don’t see any need to have two SDL doc wikies. I think having
one as part of libsdl.org is the best way to go.

that’s what i want too.

Why bother dealing with all those issues? Why not just let the wiki be
the dynamic thing that it is? I’m sure anyone who downloads SDL will not
need a static version of the wiki’d docs, since they can just go to the
wiki itself. Let’s just keep it simple.

Sam specifically asked for the ability to pull static docs. So, I
included that as something I want the wiki to do.

I strongly disagree with the notion of restricting access. If I read a
portion of the docs that don’t make sense to me, I’d like to be able to
note that so that someone can add a bit of clarification later. If we
want traditional, static docs, don’t bother with a wiki - They’re too
(two) different animals.

I wasn’t talking about restricted access. Just a registration so that
spambots can’t dump stuff into the wiki. As was report recently on /.
this is starting to be a problem.

Access to the list would be no more restricted than access to this list.

		Bob PendletonOn Wed, 2004-06-09 at 13:24, Tyler Zesiger wrote:

Bob Pendleton wrote:

On Wed, 2004-06-09 at 11:55, Sam Lantinga wrote:

Bob Pendleton wrote:
"> For the love of god, won’t somebody PLEASE wiki the SDL docs?

I would be more than happy to do that.
"

Bob, I would be happy to have you create an SDL docs wiki and help
get it set up on libsdl.org. My biggest concern is that we have some
way of organizing it and generating documentation that can be put in
future SDL releases.

Ok, first I need a login on the machine so I can poke around and find
out what is there. My guess is that you already have php and mysql
running on apache. What OS/Distro are you running? I’ll look for tools
that allow the documents to be extracted into a “book” format suitable
for inclusion as documentation. Hmmm… needs to extract as pure HTML.
It would be nice to have a forum for discussion of the docs as well as
the docs.

We need to register people who are going to modify the docs. Do we need
to moderate all changes and postings?

Whew… I just realized what all this entails. Me and my big mouth.
Oh well, can we start with the existing Docs? Or are their legal
problems with ownership? What license do you want to put on the docs?

Feel free to tell me to make up my own mind on all these issues.

  	Bob Pendleton

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

±-------------------------------------+

Bob Pendleton wrote:

i’m feeling somehow ignored…(-> [ANN] doc project to wiki)

I can understand that. I first talked to Sam about doing this a couple
of years ago. Since then I have written several published articles on
SDL and taught a college level game programming class using SDL. Plus,
it turns out that Sam used my first open source project as the basis for
one of his early projects. So, we have some history.

Believe me, I will not ignore you. I posted a list of questions that you
can help me answer. We need something, most likely some sort of wiki
that allows the documentation to be extracted in “book” form as standard
HTML so it can be included in the SDL distribution.

Well, please don’t kill the manpages. They allow me (and probably
other developpers) quick access to the documentation (I have a shortcut
under vim to access the manpage for the word currently under the
cursor). When writing kilotons of lines of codes, that’s a real timesaver.

Stephane

Thanks for pointing that out. I hadn’t even thought of it. So, html and
man output.

	Bob PendletonOn Wed, 2004-06-09 at 13:31, Stephane Marchesin wrote:

On Wed, 2004-06-09 at 13:12, Florian Hufsky wrote:


SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

±-------------------------------------+

I’ve noticed that it’s not unusual to see wiki’s being run off-site of
the main project, by some enthusiastic third party. Being a wiki, it
seems that the “powers that be” have as much power over the wiki as they
need, to make changes and updates.

I agree that there shouldn’t be two wikis though.

Bob Pendleton wrote:

[snip]> I really don’t see any need to have two SDL doc wikies. I think having

one as part of libsdl.org is the best way to go.

Bob Pendleton