Søren Hauberg schrieb:
> søn, 18 10 2009 kl. 11:15 +0200, skrev Thomas Treichl:
>> Ok, some questions:
>>
>>   - What do you mean by Doxygen documentation? Is it the Coda script?
> 
> No, I mean class descriptions generated by doxygen. We have these on the
> current site at
> 
>   http://octave.sourceforge.net/doxygen/html/index.html

Where are the sources of the doxygen docu, are they included in Octave's source 
files or are they at OF?

>>   - My opinion is that the Octave manual should _not_ be part of OF, but
>>     there should be a link to the website of the Octave project where the
>>     manual can be found.
> 
> I both agree and disagree. I think it is nice to have all the
> documentation available in one place where everything looks the same.

Yes this is true but it must not look the same, I'd say.

> If
> we link to www.octave.org the user will get something that looks
> different from Octave-Forge. I think that will just create confusion.

YesNo, I partially agree because I also often see people asking for the usage 
of 
a special command on the wrong list, eg. a command that belongs to OF and not 
to 
Octave - then people always are encouraged to ask again at the OF mailing 
list...
What I'd like to say is, if we make separation clearer (what is OF and what is 
GNU Ocatve) then people also better can separate between OF and GNU Octave and 
maybe are less confused.

> That being said, I think it is silly to duplicate the documentation on
> multible sites. Personally, I'd like to merge www.octave.org and
> octave.sf.net into one site, so there is less to maintain. 

It's not just that, but people do already get documentation enough (at least 
I'd 
say). I can't talk for the Windows colleagues but eg. I'm packing 
liboctave.pdf, 
octave-faq.pdf, octave.pdf and refcard-{a4,legal,letter}.pdf into the GNU 
Octave 
Mac binary dmg. I think that people also get all that documentation with Fink, 
HMUG or Macports on a Mac. On Linux systems I'd say that you can install all 
the 
GNU Octave documentation that you want...

And finally, we need another maintainer at OF for posting the GNU Octave manual.

>>   - The help texts of all functions that come with the core Octave should be
>>     part of the GNU Octave website, not of the OF website, too. Maybe it is
>>     useful to create another link to the Octave website then.
> 
> The problem is the 'See also's in the function help texts. If you look
> at a help text for a function from a package that references some
> function in core Octave, where should you go when you click on said
> link? If it'll be confusing if you get sent of to www.octave.org.

That definitely is a problem I was not thinking about...

   Thomas

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay 
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Octave-dev mailing list
Octave-dev@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/octave-dev

Reply via email to