<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=Content-Type content="text/html; charset=iso-8859-1">
<META content="MSHTML 6.00.2713.1100" name=GENERATOR>
<STYLE></STYLE>
</HEAD>
<BODY bgColor=#ffffff>
<DIV><FONT face=Arial size=2>Hello all,</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>As you may be aware, I've been working on new
reference files for PD. I've run into a 'snag' however and I'd like some
advice.</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>The 'snag':</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>It's my personal opinion that detailed and specific
documentation is always best. It's also my opinion that it's impossible to
provide "too much" information about anything. Hence, it's also my opinion
that every object in PD should have its own documentation. I'd like to
build new documents for the MATH objects in PD but:</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>1. The binary operators, when right-clicked
and "Help" is selected from the sub-menu, open a file called "operators.pd" or
"otherbinops.pd". Similar problems also exist with objects like [dbtorms]
and [mtof]; those files all open a file called "acoustics.pd".</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>2. I would like to build a help document for
[+] and [==] for example, but those object names may not be good file
names. ==.pd ?? I think that operating systems may not like those
file names.</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>So the questions I have are these:</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>1. Do you all agree that each object in PD
should have its own documentation?</FONT></DIV>
<DIV><FONT face=Arial size=2>2. If so, then what changes need to be made
to PD source code to open the appropriate help documents in the reference
folder?</FONT></DIV>
<DIV><FONT face=Arial size=2>3. Is it possible to build a subroutine in
PD's source code which will:</FONT></DIV>
<DIV><FONT face=Arial size=2>- search first for a document in the reference
folder which corresponds to the object name</FONT></DIV>
<DIV><FONT face=Arial size=2>- search for a document called "plus.pd" for the
[+] object instead of a document called "+.pd"</FONT></DIV>
<DIV><FONT face=Arial size=2>- search for a document called "operators.pd" only
if a 'dedicated' help document does not exist in the folder (and for backwards
compatibility for PD users who haven't downloaded my help
documents.</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>Any and all comments are welcome and greatly
appreciated.</FONT></DIV>
<DIV><FONT face=Arial size=2></FONT> </DIV>
<DIV><FONT face=Arial size=2>Regards,</FONT></DIV>
<DIV><FONT face=Arial size=2>Dave Sabine</FONT></DIV>
<DIV> </DIV></BODY></HTML>