[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [sc-dev] p tags in docs

well, it's all about the literate programming spirit ..

Yes, I understand, I was exactly proposing to split literate programming from help files. Help files could go a different path and one can use cocoa webkit html formatting facilities for her files.

 What I miss is footnotes.

You' re really literate! :-)

For help files it would be ok to have a different format, but I don't think it is such a good idea really.

(why?)



(I raise my hands with cocoa webkit html...)

Best

-a-






One idea would be to have an xml format for help files.
Then it can be translated automagically into cocoa webkit html with a Helper-like mechanism.
Or in other eventually useful formats.
The xml could be more easily generated from sources (e.g. via AutoHelper).

How to generate the xml?
a. writing directly it
b. via a GUI which provides a set of predefined forms (following the stylesheet and/or generated by the Helper mechanism)

How to edit a help file?

a. directly editing it
b. via a Gui generated from the xml

Just 2c

-a-




On 18 Dec 2008, at 00:04, Julian Rohrhuber wrote:

Still, there's a major, higher issue here.
We want to maintain the domination of macosx in terms of ease of use.
That's ok (I'm on mac).
But  cocoa compatible  html generation (Helper mimics it) is really a bad trick IMHO.


if you have managed to find a stable automatic way to translate from the cocoa webkit's html format to a more human readable format that displays the same, it would be good if this script could be integrated SC on os x in a way that it works more or less in the background. It would be difficult to keep up with modifications done and resaved from os x (which will save it again in cocoa style, as far as I know).



-a-






A related question, which is just a matter of style, is the
apple-editor the reason why code-portions arent put inside nice
css'ed <pre> blocks as well?



    j> I suppose because of syntax colorization. Indeed it would be
    j> great if there were a way to have all code in a <pre> tag or a
    j> <code> tag, if there were a way to get a browser to colorize it
    j> then.

The coloring isn't a problem.  afaik you can put as much bells'n
whistles you want (at least spans with colors etc) inside pre blocks as
well.  Automatic translation would take some thinking though.

Ive run through all the html-files ive found inside Html with a sed
script, and looked at a few of them from some SC_<<Help:w3m>Help:w3m><Help:w3m>Help:w3m buffer, they
look much better now.  Ill see if i can upload an archive to a webpage.

Im not sure how various developers generate the html which gets
included, but i guess a translation-script could be handy for others as
well.  This script only substitutes the p-tags for now.

Using <pre>'s (difficult?)  and changing the Helper class (easy) comes
later.  See comments to begin with for applying to a directory-tree (ie
build//Help):

<rehtmlize>


I guess the files could be operated on 'in place', but im not too sure
about shell-programming in general, and especially escaping white-spaces
in file-names...


--------------------------------------------------
Andrea Valle
--------------------------------------------------
CIRMA - DAMS
Università degli Studi di Torino
--------------------------------------------------

- La Repubblica promuove lo sviluppo della cultura e la ricerca scientifica e tecnica.
- La Repubblica detta le norme generali sull'istruzione ed istituisce scuole statali per tutti gli ordini e gradi.
(Costituzione della Repubblica Italiana, art. 9 e 33)



--





.

_______________________________________________
sc-dev mailing list



--------------------------------------------------
Andrea Valle
--------------------------------------------------
CIRMA - DAMS
Università degli Studi di Torino
--------------------------------------------------

- La Repubblica promuove lo sviluppo della cultura e la ricerca scientifica e tecnica.
- La Repubblica detta le norme generali sull'istruzione ed istituisce scuole statali per tutti gli ordini e gradi.
(Costituzione della Repubblica Italiana, art. 9 e 33)


--





.

_______________________________________________
sc-dev mailing list


--------------------------------------------------
Andrea Valle
--------------------------------------------------
CIRMA - DAMS
Università degli Studi di Torino
--------------------------------------------------

"The objectives of SuperCollider have been taken a stage further with the development of SAOL, the fruits of a research project based at MIT, launched in 1998" 
(P. Manning, Electronic and Computer Music, revised and expanded edition, 2004)