The documentation on the web site seems excellent, but it appears not to be in the "all-in-one" tarball. Is there a chance that you could consider putting the doc into the download as well?
Larry Troxler
hi Larry,
yes, I will eventually do that. But I am simply too ashamed of my html lameness! And, I would need to include a CSS2 style file (which causes all sorts of compatibility troubles, btw). I do not know, if this is a good idea, but otherwise everything should be rewritten, also my preprocessing tools...
Krzysztof
Larry Troxler wrote:
The documentation on the web site seems excellent, but it appears not to be in the "all-in-one" tarball. Is there a chance that you could consider putting the doc into the download as well?
Krzysztof Czaja hat gesagt: // Krzysztof Czaja wrote:
yes, I will eventually do that. But I am simply too ashamed of my html lameness! And, I would need to include a CSS2 style file (which causes all sorts of compatibility troubles, btw). I do not know, if this is a good idea, but otherwise everything should be rewritten, also my preprocessing tools...
Maybe you could just use the Linuxdoc or Docbook styles. In combination with LyX this is a very comfortable way to generate all kinds of output.
Ciao,
__ __
Frank Barknecht ____ ______ ____ __ trip\ \ / /wire ______
/ __// __ /__/ __// // __ \ / / __ \ ___\
/ / / ____/ / / / // ____// /\ \ ___\____ \
/_/ /_____/ /_/ /_//_____// / \ \_____\_____
/_/ _\
hi Frank, Yves,
thank you both for the advice. The ultimate goal is to use one source for html, ps (via TeX), and help windows available in Pd itself. I have been thinking for some time about designing a common documentation framework for Pd builtins and externals, and such was the primary purpose of my never released `spy' project, now all but abandoned due to the Pd API's recent rapid changes.
DocBook is probably the best choice, but I am not familiar with it, and the output is usually looking very rough (lack of skills?).
And...;) this excerpt from LDP page is a bit too extreme for me:
"In the end, DocBook is more concerned about the way elements work instead of the way they look. A big distinction, and one that will let you write faster, since you don't have to worry about placement of paragraphs, font sizes, font types, and so on."
Krzyszt-write-slow-read-fast-of
Frank Barknecht wrote: ...
Maybe you could just use the Linuxdoc or Docbook styles. In combination with LyX this is a very comfortable way to generate all kinds of output.
I've been wondering for years how I could make some sort of hypertext document that could have links to actual Pd patches. If anyone has a cool idea about this I'd love to hear it. For example, if there were some sort of very simple HTML browsing library that worked cross-platform???
cheers Miller
On Mon, Feb 18, 2002 at 02:28:35PM +0100, Krzysztof Czaja wrote:
hi Frank, Yves,
thank you both for the advice. The ultimate goal is to use one source for html, ps (via TeX), and help windows available in Pd itself. I have been thinking for some time about designing a common documentation framework for Pd builtins and externals, and such was the primary purpose of my never released `spy' project, now all but abandoned due to the Pd API's recent rapid changes.
DocBook is probably the best choice, but I am not familiar with it, and the output is usually looking very rough (lack of skills?).
And...;) this excerpt from LDP page is a bit too extreme for me:
"In the end, DocBook is more concerned about the way elements work instead of the way they look. A big distinction, and one that will let you write faster, since you don't have to worry about placement of paragraphs, font sizes, font types, and so on."
Krzyszt-write-slow-read-fast-of
Frank Barknecht wrote: ...
Maybe you could just use the Linuxdoc or Docbook styles. In combination with LyX this is a very comfortable way to generate all kinds of output.
On Mon, Feb 18, 2002 at 09:15:28AM -0800, Miller Puckette wrote:
I've been wondering for years how I could make some sort of hypertext document that could have links to actual Pd patches. If anyone has a cool idea about this I'd love to hear it. For example, if there were some sort of very simple HTML browsing library that worked cross-platform???
Could you give an example of how you would envision this working? (Don't worry at first about practicality, just what the user would do, see, and hear in using the link.)
Sure...
The thing would live as both a regular paper book and as hypertext. It would have a theoretical and practical guide to audio DSP with the Pd reference patches as examples, but with more diagrams showing, for instance, how to calculate desirable sizes of lookup tables.
In book form, all the patches would show up as figures with captions. In the hypertext version, they'd still look like figures but you'd be able to turn them on and hear what they do...
cheers Miller
On Mon, Feb 18, 2002 at 01:50:57PM -0600, Joseph Zitt wrote:
On Mon, Feb 18, 2002 at 09:15:28AM -0800, Miller Puckette wrote:
I've been wondering for years how I could make some sort of hypertext document that could have links to actual Pd patches. If anyone has a cool idea about this I'd love to hear it. For example, if there were some sort of very simple HTML browsing library that worked cross-platform???
Could you give an example of how you would envision this working? (Don't worry at first about practicality, just what the user would do, see, and hear in using the link.)
-- | jzitt@metatronpress.com http://www.metatronpress.com/jzitt | | New book: Surprise Me with Beauty: the Music of Human Systems | | http://www.metatronpress.com/nj/smwb.html | | Latest CDs: Collaborations/ All Souls http://www.mp3.com/josephzitt | | Comma: Voices of New Music Silence: the John Cage Discussion List |
This almost suggests adding hypertext and fancy printing to Pd, rather than hacking Pd into another documentation system. If Pd patches could be saved as XML...
On Mon, 2002-02-18 at 14:40, Miller Puckette wrote:
The thing would live as both a regular paper book and as hypertext. It would have a theoretical and practical guide to audio DSP with the Pd reference patches as examples, but with more diagrams showing, for instance, how to calculate desirable sizes of lookup tables.
In book form, all the patches would show up as figures with captions. In the hypertext version, they'd still look like figures but you'd be able to turn them on and hear what they do...
On Mon, Feb 18, 2002 at 03:06:05PM -0500, jfm3 wrote:
This almost suggests adding hypertext and fancy printing to Pd, rather than hacking Pd into another documentation system. If Pd patches could be saved as XML...
It seems to me (not having tried it) that saving patches as XML would be close to trivial, since they're already saved in a clear and well-defined ASCII format.
This also might be another benefit of doing documentation in a well-defined and well-supported format like DocBook.
I would be eager to work on developing standardized PD docs. I've been a tech writer and (a still fairly newbie) PD user, and I've had some thoughts as to how this could work. I do think that DocBook would probably be the best way to develop them for maximum flexibility (though I haven't yet used it myself).
On Mon, Feb 18, 2002 at 02:28:35PM +0100, Krzysztof Czaja wrote:
thank you both for the advice. The ultimate goal is to use one source for html, ps (via TeX), and help windows available in Pd itself. I have been thinking for some time about designing a common documentation framework for Pd builtins and externals, and such was the primary purpose of my never released `spy' project, now all but abandoned due to the Pd API's recent rapid changes.
-
Frank Barknecht -
jfm3 -
Joseph Zitt -
Krzysztof Czaja -
Larry Troxler -
Miller Puckette