Hi,
Andraz sorry for the extra noise.
could you please try getting the docbook working?
makeinfo --docbook cinelerra.texi
once it works, try:
yelp file://$PWD/cinelerra.xml
and if you move the cinelerra.xml to
/usr/share/gnome/help/cinelerra/C/cinelerra.xml one can do:
yelp ghelp:cinelerra?THE-PATCHBAY
If this gets implemented I'd like to set up help buttons throughout
cinelerra's gui.. that execute the appropriate command line..
Pierre
Nicolas wrote:
Hello,
Here are the opinions about "British English vs. American English":
Kurt Georg Hooss: prefers British English
Gour: has no preference
Pierre Dumuid: prefers American English
Stefan de Konink: prefers British English
Mack Allison: prefers American English (doesn't he?)
Julian Oliver: prefers British English
Nicolas Maufrais: prefers British English
- British English: 4 votes
- American English: 2 votes
- No preference: 1 votes
So, we'll use British English for the documentation... unless more
people give their opinion!
Mack Allison wants to participate to the documentation.
So, here is the list of people interested:
- Nicolas Maufrais
- gour
- Mack Allison
On Thu, Nov 02, 2006 at 09:08:51AM +0100, Gour wrote:
Do we want to add more deps to Cinelerra build process or we can just
ship produced pdf manual along with the html one from the doc branch?
I am thinking that we won't immediately update manual with the every
revision number, but, let's say, periodically when tagging some bigger
release like e.g. 2.1-merge, quarterly...and therefore it is, imho,
better to just have ready manual in doc/ which clearly states for which
revision it is up to date.
In such situation, there would not be need for adding additional
dependencies.
What do you think?
IMO, we shouldn't ship pdf or html manuals with the source. Those
manuals can be generated from the cinelerra.texi texinfo files, and the
png images. Generating the manuals takes only a few seconds. IMO, the
same principle than source distribution applies. I mean, does
cinelerra-cv ships with binaries? It ships with sources, which can be
compiled. We should use the same method for the documentation.
We will upload the manual to the SVN official branch 1 time per month I
think.
On Thu, Nov 02, 2006 at 08:48:59PM +1030, Pierre Marc Dumuid wrote:
I'd prefer to have a configure option
configure --makedocumentation
so dependencies depend on your configure arguments.
That configure option is a good idea. We should use that.
I could create one shell script to do all of these tasks. But I don't
think that's the way to go. I assume make should handle the process. Can
someone help me with that issue? That would avoid me to RTFM about
makefiles, and I could concentrate my efforts on working on the manual's
contents.
This can be done with autoconf tools. Can you give me url where I can
get manual's tarball?
Here's the tarball:
http://www.europephoto.com/info/cinelerra/200611/CV_Manual_20061102.tgz
Instructions to generate the manual are in the README_MANUAL.txt file.
Right now, I RTFM about the GPL licence, and how to make reference to it
in the manual (precise rules apply).
I ask Herman for an SVN account, in order to be able to upload the
manual, 1 time per month approximately.
Now, how can we work together on the manual?
There're some possibilities:
1 - use SVN or git or another VCS
2 - set up a wiki, where people can edit the cinelerra.texi file
directly (one chapter per page)
3 - set up a wiki, where people can edit the manual without formatting.
I would regularly select the new parts added by people, and put them
into the cinelerra.texi file.
Solution 1 is the most rigorous.
Solution 2 is fine but editing a texinfo file isn't as easy and
"beautiful" than editing the manual in another form.
Solution 3 is easy for people, but I (or someone else) will have to
regularly update the cinelerra.texi file. That solution allows a better
control over what's written in the texinfo file. I'd add typesetting
commands, and correct possible texinfo errors.
You can have a look at the cinelerra.texi file by downloading the .tgz
(see URL below in this email). Do you think that's easy to edit? Do you
prefer to edit a plain text page without formatting?
Gour suggested on the ML to use DocBookWiki:
http://doc-book.sourceforge.net/homepage/
However I'm not satisfied at all with the PDF manual quality it
produces. And we use texinfo as Heroine Virtual Ltd does.
I prefer solution 2. People can easily edit the manual, and me and other
people who want to do it will select and format the contents into the
cinelerra.texi file. However, if some of you think the texinfo file can
easily be edited by *any* people (I mean people not really wishing to
RTFM a bit about texinfo), we can edit the texinfo file directly.
OK, that's a wiki. And there's already Alex's one. But its layout isn't
appropriate for our need right now. We only need to edit 10 pages at the
most (1 per chapter as I said). And it's really too slow... :-/
Alex, did you get an answer about its hosting? Is it possible to have a
higher bandwith? If Alex's wiki can be hosted on a better server, we
could edit the manual on it.
If that's not possible, is it possible to host a small wiki on
cinelerra.org?
A last solution would be to host a small wiki on my personnal website,
which is damn fast. But I would prefer us to edit the manual on Alex's
Wiki, because:
1-he already made a great job with improving cinelerra documentation
2-having another place with cinelerra documentation scatters information
Ideally, I'd like Alex's wiki to be on cinelerra.org! =)
OK. Here are my thought. Now, let's talk about those subjects, let's try
to find the better solution together.
Nicolas.
_______________________________________________
Cinelerra mailing list
[email protected]
https://init.linpro.no/mailman/skolelinux.no/listinfo/cinelerra
_______________________________________________
Cinelerra mailing list
[email protected]
https://init.linpro.no/mailman/skolelinux.no/listinfo/cinelerra
