Hey guys,
First of all: Sorry for the delay. Basically I wanted to start this
before my vacation, but it just didn't work out. But now I have finally
found the time to go for it.
Now if you're asking yourself: What the **** is he talking about? -
Well, there was a conversation here on this list about RIFE's
documentation and how it misses a quick structured manual for just
looking things up. I promised to go ahead and get something going.
I hereby present to you.... *drumroll* ... RIFE's new Quick Reference:
>> http://rifers.org/wiki/display/RIFE/Quick+Reference <<
*applause* ;)
I think it's a solid foundation to build on. I'm pretty tired right now,
so it's not really the best quality yet, but hey, it's a Wiki. Improve
it. Extend it. Add new things. Whatever you want.
Hopefully I will have some time tomorrow, too, to write some more
sections. But the basic idea/format should come across if you take a
look at the sections about Element Definition and Site Structure. What
I'm trying to do with this is create a *repository of short,
straightforward examples which are ordered by topic and explained*. So
anyone who forgot the exact syntax for a submission bean can look it up
without having to search the Cookbook, the Live Users Guide, the Tips
and Tricks, etc or look through the mailing list.
At some point in the future the reference should also aim for
completeness. I think it's a lot easier for those who develop to write a
short example + explanation about a small new feature in the reference
than to demonstrate it in a tutorial. Tutorials are great to get your
foot into the door in a new topic, but eventually you just want to know
the one precise piece of information that you are looking for and get
back to work. That's when you need a reference.
So now, take a look, give me your feedback, start working on it,
whatever you want and lets see whether this develops into something useful.
Cheers,
Stefan :)
_______________________________________________
Rife-users mailing list
[email protected]
http://lists.uwyn.com/mailman/listinfo/rife-users
