atom feed65 messages in at.iem.pd-list[PD] [pd REFERENCE] format [was: Re: ...
FromSent OnAttachments
MaxAug 27, 2009 6:21 pm 
Miller PucketteAug 27, 2009 8:34 pm 
Jonathan WilkesAug 27, 2009 8:50 pm 
Hans-Christoph SteinerAug 28, 2009 7:36 am 
MaxAug 28, 2009 7:46 am 
Jonathan WilkesAug 28, 2009 10:10 am 
Miller PucketteAug 28, 2009 10:53 am 
Miller PucketteAug 28, 2009 10:54 am 
MaxAug 28, 2009 11:32 am 
Miller PucketteAug 28, 2009 11:35 am 
Kyle KlipowiczAug 28, 2009 12:18 pm 
fred-ordiAug 31, 2009 12:43 am 
Hans-Christoph SteinerAug 31, 2009 7:16 am 
Hans-Christoph SteinerAug 31, 2009 7:17 am 
Jonathan WilkesAug 31, 2009 10:39 am 
Hans-Christoph SteinerAug 31, 2009 12:20 pm 
fred-ordiAug 31, 2009 4:16 pm 
fred-ordiAug 31, 2009 4:46 pm 
Jonathan WilkesAug 31, 2009 4:55 pm.pd, .pd
fred-ordiAug 31, 2009 5:48 pm.tar
Hans-Christoph SteinerAug 31, 2009 8:00 pm.pd
Jonathan WilkesAug 31, 2009 9:40 pm 
marius schebellaSep 1, 2009 12:39 am 
Thomas GrillSep 1, 2009 5:26 am 
MaxSep 1, 2009 5:56 am 
Hans-Christoph SteinerSep 1, 2009 7:05 am 
Frank BarknechtSep 1, 2009 7:20 am 
Miller PucketteSep 1, 2009 8:09 am 
Jonathan WilkesSep 1, 2009 8:46 am 
marius schebellaSep 1, 2009 9:08 am 
Jonathan WilkesSep 1, 2009 10:07 am.pd, .pd
marius schebellaSep 1, 2009 10:13 am 
Hans-Christoph SteinerSep 1, 2009 10:14 am 
fred-ordiSep 1, 2009 10:46 am 
fred-ordiSep 1, 2009 11:06 am.zip
Jonathan WilkesSep 1, 2009 11:20 am.pd, .pd
Hans-Christoph SteinerSep 1, 2009 12:21 pm 
Jonathan WilkesSep 1, 2009 2:36 pm 
Mathieu BouchardSep 2, 2009 8:05 am 
Hans-Christoph SteinerSep 2, 2009 8:13 am 
Jonathan WilkesSep 2, 2009 8:32 am 
Frank BarknechtSep 2, 2009 8:52 am 
Mathieu BouchardSep 2, 2009 9:37 am 
Mathieu BouchardSep 2, 2009 10:42 am 
Mathieu BouchardSep 2, 2009 10:54 am 
João PaisSep 2, 2009 3:07 pm 
Jonathan WilkesSep 2, 2009 4:49 pm.pd
Frank BarknechtSep 3, 2009 6:55 am 
João PaisSep 4, 2009 5:05 am 
Jonathan WilkesSep 4, 2009 11:26 am 
Frank BarknechtSep 5, 2009 2:45 am 
Mathieu BouchardSep 5, 2009 11:58 am 
Jonathan WilkesSep 5, 2009 1:22 pm 
Mathieu BouchardSep 5, 2009 2:39 pm 
Mathieu BouchardSep 5, 2009 2:49 pm 
Jonathan WilkesSep 5, 2009 3:44 pm 
Mathieu BouchardSep 5, 2009 4:34 pm 
Jonathan WilkesSep 5, 2009 5:31 pm 
Jonathan WilkesSep 5, 2009 6:06 pm 
Martin PeachSep 5, 2009 7:17 pm 
MaxSep 19, 2009 4:27 am 
Mathieu BouchardSep 19, 2009 12:02 pm 
Mathieu BouchardSep 19, 2009 12:42 pm 
Jonathan WilkesSep 20, 2009 1:05 am 
JohannesFeb 20, 2010 3:16 pm 
Subject:[PD] [pd REFERENCE] format [was: Re: Pd META: Author/Help Patch Authors]
From:Frank Barknecht (fb@footils.org)
Date:Sep 3, 2009 6:55:59 am
List:at.iem.pd-list

Hallo, João Pais hat gesagt: // João Pais wrote:

Is there any place where it's explained what are the meta patches, and what should be in each patch? I never understood the meaning of them, and therefore, have never made any.

I could find any clear docs about that myself. I can however send you the specification for "pd REFERENCE" supbatches in RjDj help files. Note that this is not dealing with META information like lices, author, etc. Think of it as an alternative implementation of the main pddp help patch area into a parsable format. The RjDj helpfiles can be got here: http://trac.rjdj.me ("Browse
source")

Embedding parsable reference info into a subpatch =================================================

Each help file includes a subpatch called "REFERENCE" with graph on parent (GOP) enabled. The subpatch's GOP area is 450 px wide. The subpatch contains only comments.

The comments will generally consist of a colon-separated key:value pair. Also allowed are "free" comments that don't use any of the following key names. These will be appended to the "Description" field as separate paragraphs, ordered by the value of their "y"-coordinate. (We can think about adding them to the previously encountered field instead.)

Required key names:

Name: the name of the object Summary: short description of the object Description: Longer description of the object

Optional key names:

Argument <x>: argument x, where x is an integer index of the arg, zero-based. Inlet <x>: message or audio inlet x, where x is an integer index of the inlet,
zero-based. Outlet <x>: message or audio outlet x, where x is an integer index of the
outlet, zero-based. Tags: dash-separated list of key words (was "comma-separated" before)

Quick awk-oneliner to filter out the subpatch:

$ cat file-help.pd | awk 'BEGIN {RS=";"} /canvas .* REFERENCE/,/restore .*
REFERENCE/ { for (i=4; i<=NF; i++) printf("%s ", $i); print ""}' | grep -v
REFE | sort

Ciao