[Sc-devel] autoHelp?

[Scott Wilson]

If you want to do this, I'd recommend using the generated html as a  
template. It's ugly, but you'll be consistent with its approach, etc.  
When you load the file into SC it stores it internally as a  
NSAttributedString, and regenerates it when you save.

It wouldn't be too hard btw to implement methods for tabs, margins,  
etc. I could look at this in a few days.

S.

On 4 Nov 2007, at 14:07, Andrea Valle wrote:

> Hmm, I'll take the second way and then back to the list...
>
> Best
>
> -a-
>
> On 4 Nov 2007, at 13:57, Scott Wilson wrote:
>
>> This idea has been mentioned, and it's a good one.
>>
>> The problem is that the template uses rulers (which I think is  
>> desirable) so I think you would need to either add that  
>> functionality to Document (probably not too hard), or generate the  
>> html directly.
>>
>> S.
>>
>> On 4 Nov 2007, at 11:56, Andrea Valle wrote:
>>
>>> Hi to all,
>>>
>>> I was writing some docs for a project trying to follow the guide  
>>> lines. I appreciate a lot their presence, no problem with UGen  
>>> and Topic, but I find extremely boring to write all the stuff
>>> related to Class help files, respecting the required format.
>>> I see there's been a lot of work in automatic documentation (I  
>>> mean: Help.gui, Class.browse).
>>> Is there anyone working on a Class method generating the html  
>>> help file (e.g. Collection.makeHelp)? So that you have all  
>>> methods and args listed in the opportune layout following the  
>>> guide line, and you have to to complete/clean the resulting  
>>> document (e.g. removing the private or not relevant methods,  
>>> replacing dummy lines with real content etc).
>>>
>>> I think it could greatly help the consistency of new documentation.
>>> I was starting working at it, but maybe there's something already  
>>> done. More, I know nothing about help file  creation from rtf etc.
>>>
>>> Best
>>>
>>> -a-
>>>
>>>
>>> --------------------------------------------------
>>> Andrea Valle
>>> --------------------------------------------------
>>> CIRMA - DAMS
>>> Università degli Studi di Torino
>>> --> http://www.cirma.unito.it/andrea/
>>> --> andrea.valle at unito.it
>>> --------------------------------------------------
>>>
>>>
>>> I did this interview where I just mentioned that I read Foucault.  
>>> Who doesn't in university, right? I was in this strip club giving  
>>> this guy a lap dance and all he wanted to do was to discuss  
>>> Foucault with me. Well, I can stand naked and do my little dance,  
>>> or I can discuss Foucault, but not at the same time; too much  
>>> information.
>>> (Annabel Chong)
>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> Sc-devel mailing list
>>> Sc-devel at create.ucsb.edu
>>> http://www.create.ucsb.edu/mailman/listinfo/sc-devel
>>
>> _______________________________________________
>> Sc-devel mailing list
>> Sc-devel at create.ucsb.edu
>> http://www.create.ucsb.edu/mailman/listinfo/sc-devel
>
> --------------------------------------------------
> Andrea Valle
> --------------------------------------------------
> CIRMA - DAMS
> Università degli Studi di Torino
> --> http://www.cirma.unito.it/andrea/
> --> andrea.valle at unito.it
> --------------------------------------------------
>
>
> I did this interview where I just mentioned that I read Foucault.  
> Who doesn't in university, right? I was in this strip club giving  
> this guy a lap dance and all he wanted to do was to discuss  
> Foucault with me. Well, I can stand naked and do my little dance,  
> or I can discuss Foucault, but not at the same time; too much  
> information.
> (Annabel Chong)
>
>
>
>
> _______________________________________________
> Sc-devel mailing list
> Sc-devel at create.ucsb.edu
> http://www.create.ucsb.edu/mailman/listinfo/sc-devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.create.ucsb.edu/pipermail/sc-devel/attachments/20071104/f36b1bf9/attachment-0001.htm