Salut, On 9/17/07, Romain Beauxis <[EMAIL PROTECTED]> wrote: > This article should be specific to liquidsoap. My current plan is to write a > first part on the language, following the quick start, and then add a > detailled example using radiopi's configuration.
The description of the language can be quite heavy and technical. Of course you won't do that in full details. But even a simple description of the language's constructs would probably be boring. I think that it'd good to start with the quickstart: the high-level idea, the diagrams showing how to conceptualize a setup by wrapping sources with operators. Then present the language a bit more. Or even simpler (although difficult to do clearly): never focus on the language, and try to insert the information about it in the other sections as the reader needs them. For example the notion of function would be introduced when talking about transitions. > I don't know about the release that should be used. Some think 0.3.3 is ok, > but I tend to prefer the next release, I find it a good test case to write an > example while updating and checking doc and bugs.. > But it's not that bad if we use latest release, just that the article might be > outdated more quickly.. The article is due for the end of the month. This leaves us two weeks for the release. This is feasible, but I don't want to bet on that: I have other things on my list, with harder deadlines. One possibility is to write that the article is meant for "the 0.3.4 release, which should happen soon, or the SVN if it didn't happen at the time of reading". This is dangerous, and will discourage those who don't want to build from source. But actually, even if we release in 10 days, the Debian package has to spend 10 other days in testing, so the early readers might get surprised with the 0.3.3 version that they have on unstable. All in all, it's easy to write the article for 0.3.3 and describe the upcoming sexy features in the last paragraph. Anyway we can't present the most advanced stuff in details in that article. A few things will change from 0.3.3 to 0.3.4 but instead of ignoring that change, we could document the tricky points of the migration in the wiki: the most visible change will be the settings, another one (that the basic users won't notice) is the much richer script language. I hope that we can settle on the high-level details and the outline quickly. Then, feel free to ask me to write parts for which you think I'm qualified. Cheers. -- David
