[PD-dev] pddp style guide

Krzysztof Czaja czaja at chopin.edu.pl
Sat Apr 30 17:30:29 CEST 2005


hi Hans-Christoph,

firstly -- I am very grateful for yours and Dave's work.

Secondly, imho it is better to rethink pddp now, before adding
new contents.  The original idea was that pddp should provide
a consistent framework for at least three kinds of media:
patches, html, and ps/pdf.  The choice then was to either
base it on docbook, or to design a very simple custom format.
The latter never materialized, and certainly never will.  Hardly
being a docbook fan myself, I do not see any alternative...

Anyway, the worst thing that could happen, would be having all
the reference pages, and ``more info'' propaganda embedded in Pd
comments.  There would be no other way of putting those on
other media, than many days of hard manual work.  The likely
result of which would be forking of the pddp source.

Let us use patches as patches, and comments as comments.

A tricky part, besides tailoring docbook styles, is deciding about
a mechanism for opening patches in Pd by invoking links in a html
browser.  The easiest way is including a simple httpd server in
pd-gui.  There is a ready to use 250-liner at
http://cvs.sourceforge.net/viewcvs.py/tclhttpd/tclhttpd/bin/mini/

Krzysztof

Hans-Christoph Steiner wrote:
...
> If anyone is interested, it'd be great if we could work together to 
> create the style guides. The way I currently see it there are two kinds 
> of patches "all_about_" which has lots of text and examples, and the 
> basic help patch, which should be a reference with a link to the 
> relevant "all_about_" pages. float-help.pd from PDDP is a decent example 
> of a reference patch.




More information about the Pd-dev mailing list