Csound Csound-dev Csound-tekno Search About

Re: [Cs-dev] API documentation

Date2006-09-11 19:58
FromVictor Lazzarini
SubjectRe: [Cs-dev] API documentation
Andres,

thanks. I'll perhaps try emacs, as I use it for
other things. Do I need to get a 'psgml mode' or
something or does it come with it?

Regards

Victor

>
> Hi Victor,
> Some time ago I tried an almost WYSIWYG editor which is
> available as an  eclipse plugin, but I found it lacking
> other things, don't quite recall  which. I've found two
> other methods which were good for editing these  files.
> One is using kate and the other using emacs with psgml.
> Both  provide autocompletion, and validity checking and
> both can work with  DTDs (however kate must use something
> called KDE-docbook or something  which is not exactly the
> same as docbook). Using these tools the pain of  editing
> is greatly minimized. You can also do cvs commits from
> emacs  which is nice.
>
> Cheers,
> Andrés
>
>
> Victor Lazzarini wrote:
> > I am hoping to make a start on a proper API reference,
> > but would like to ask opinions on what would be the
> > simplest way of doing it.
> >
> > I suppose in order to keep with the existing manual, I
> > would have to do it in XML, using one of the existing
> > pages as templates. However, writing in XML by hand is a
> > little tedious and error-inducing. Is there a tool that
> > I can use to do a more WYSIWYG job? What I have done in
> > the past is just writing docs in MS-Word and then PDFing
> > them. But that's not really maintanable, so I would like
> > to hear some suggestions.
> >
> > Also how could we integrate the C/C++ API docs with the
> > Python and Java reference, so that we don't need to
> > write three separate documents? Perhaps we can work out
> > a template?
> >
> > Victor Lazzarini
> > Music Technology Laboratory
> > Music Department
> > National University of Ireland, Maynooth
> >
> >
> >
> ----------------------------------------------------------
> > --------------- Using Tomcat but need to do more? Need
> > to support web services, security? Get stuff done
> quickly with pre-integrated technology to make your job
> > easier Download IBM WebSphere Application Server v.1.0.1
> > based on Apache Geronimo
>
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> > _______________________________________________
> > Csound-devel mailing list
> > Csound-devel@lists.sourceforge.net
> >
> https://lists.sourceforge.net/lists/listinfo/csound-devel
> > >
> >
> >
>
>
> ----------------------------------------------------------
> --------------- Using Tomcat but need to do more? Need to
> support web services, security? Get stuff done quickly
> with pre-integrated technology to make your job easier
> Download IBM WebSphere Application Server v.1.0.1 based on
> Apache Geronimo
>
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel

-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2006-09-12 15:03
FromAndres Cabrera
SubjectRe: [Cs-dev] API documentation
Hi Victor,
It came installed with my system, but you may need to activate it. Here 
are some references.

http://openacs.org/doc/openacs-4/psgml-mode.html
http://www.galassi.org/mark/mydocs/docbook-intro/emacs-psgml-mode-tips.html

Cheers,
Andres

Victor Lazzarini wrote:
> Andres,
>
> thanks. I'll perhaps try emacs, as I use it for
> other things. Do I need to get a 'psgml mode' or
> something or does it come with it?
>
> Regards
>
> Victor
>
>   
>> Hi Victor,
>> Some time ago I tried an almost WYSIWYG editor which is
>> available as an  eclipse plugin, but I found it lacking
>> other things, don't quite recall  which. I've found two
>> other methods which were good for editing these  files.
>> One is using kate and the other using emacs with psgml.
>> Both  provide autocompletion, and validity checking and
>> both can work with  DTDs (however kate must use something
>> called KDE-docbook or something  which is not exactly the
>> same as docbook). Using these tools the pain of  editing
>> is greatly minimized. You can also do cvs commits from
>> emacs  which is nice.
>>
>> Cheers,
>> Andrés
>>
>>
>> Victor Lazzarini wrote:
>>     
>>> I am hoping to make a start on a proper API reference,
>>> but would like to ask opinions on what would be the
>>> simplest way of doing it.
>>>
>>> I suppose in order to keep with the existing manual, I
>>> would have to do it in XML, using one of the existing
>>> pages as templates. However, writing in XML by hand is a
>>> little tedious and error-inducing. Is there a tool that
>>> I can use to do a more WYSIWYG job? What I have done in
>>> the past is just writing docs in MS-Word and then PDFing
>>> them. But that's not really maintanable, so I would like
>>> to hear some suggestions.
>>>
>>> Also how could we integrate the C/C++ API docs with the
>>> Python and Java reference, so that we don't need to
>>> write three separate documents? Perhaps we can work out
>>> a template?
>>>
>>> Victor Lazzarini
>>> Music Technology Laboratory
>>> Music Department
>>> National University of Ireland, Maynooth
>>>
>>>
>>>
>>>       
>> ----------------------------------------------------------
>>     
>>> --------------- Using Tomcat but need to do more? Need
>>> to support web services, security? Get stuff done
>>>       
>> quickly with pre-integrated technology to make your job
>>     
>>> easier Download IBM WebSphere Application Server v.1.0.1
>>> based on Apache Geronimo
>>>       
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
>   
>>> _______________________________________________
>>> Csound-devel mailing list
>>> Csound-devel@lists.sourceforge.net
>>>
>>>       
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>>     
>>>       
>> ----------------------------------------------------------
>> --------------- Using Tomcat but need to do more? Need to
>> support web services, security? Get stuff done quickly
>> with pre-integrated technology to make your job easier
>> Download IBM WebSphere Application Server v.1.0.1 based on
>> Apache Geronimo
>>
>>     
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
>   
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>>     
>
> -------------------------------------------------------------------------
> Using Tomcat but need to do more? Need to support web services, security?
> Get stuff done quickly with pre-integrated technology to make your job easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>
>
>
>   


-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net