Re: [PD] should I use pddp/link in help patches?

[Dan Wilcox]

Check how the rjlib OVERVIEW.pd patch works: 
https://github.com/rjdj/rjlib/tree/master/rj 
<https://github.com/rjdj/rjlib/tree/master/rj>

> On Jun 2, 2017, at 6:08 AM, pd-list-requ...@lists.iem.at wrote:
> 
> From: Liam Goodacre <liamg...@hotmail.com <mailto:liamg...@hotmail.com>>
> Subject: Re: [PD] should I use pddp/link in help patches?
> Date: June 2, 2017 at 5:42:51 AM CDT
> To: PD list <pd-list@lists.iem.at <mailto:pd-list@lists.iem.at>>
> 
> 
> Hi Roman
> 
> Context, the system I'm documenting, is far too big to be explained in a 
> single help-patch, so I want the 'context-help.pd' file to function more like 
> a Table of Contents for the rest of the documentation (plus a few quick 
> examples). It would be nice if the TOC could link to other files.
> 
> -Liam


Dan Wilcox
@danomatika <http://twitter.com/danomatika>
danomatika.com <http://danomatika.com/>
robotcowboy.com <http://robotcowboy.com/>



___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list

Re: [PD] should I use pddp/link in help patches?

[Jonathan Wilkes via Pd-list]

 > The [link] object is 
great for linking between help files, but I don't know how many people use it 
now that Extended has gone. By way of a survey, how many people have this 
external installed already? Seems like it will just be a nuisance if people 
have to download it just to read a help patch, but on the other hand it's a 
shame to give up on it since it's such a useful tool.
Is it really named "link"? That name clashes with pmpd/link

In Purr Data/Pd-l2ork (and Pd-extended) there are these:pddp/pddplink: link to 
a pd patch or external text/html filepddp/helplink: link to the help patch for 
a Pd object
helplink lets you cross-reference other objects 
without having to load their libraries or instantiate them.

For example: imagine that the [bar] help patch author has a 
"related objects" subpatch with another author's object 
[foo] in it. Now, imagine the author of [foo] changes the 
implementation of [foo] so that it allocates hundreds of 
megabytes when [foo] gets created.
If you use [helplink], then only users who are interested 
in [foo] will experience crashes. If not, any user who opens 
a help patch with a "related object" [foo] may experience a 
crash. The first group is almost always smaller than the 
second group, and that's why helplink was created.

-Jonathan
p.s.-- this (now fixed) out-of-memory bug is a true story


> Assuming that it's not widely used any more, are there any other ways of 
> opening a relative path from within PD?
___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list


   ___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list

Re: [PD] should I use pddp/link in help patches?

[Roman Haefeli]

On Fre, 2017-06-02 at 10:42 +, Liam Goodacre wrote:
> Hi Roman
> 
> Context, the system I'm documenting, is far too big to be explained
> in a single help-patch, so I want the 'context-help.pd' file to
> function more like a Table of Contents for the rest of the
> documentation (plus a few quick examples). It would be nice if the
> TOC could link to other files.


When you want to use [pddplink], I'd simply do so and declare it a
dependency of your system. I wouldn't care so much about what users
have already installed, I'd rather care whether dependencies are easily
available/installable. If [pddplink] is in deken, the most important
thing is to document that Context requires pddplink (or whatever the
library is called).

Roman




> From: Pd-list <pd-list-boun...@lists.iem.at> on behalf of Roman
> Haefeli <reduz...@gmail.com>
> Sent: 02 June 2017 11:03
> To: pd-list@lists.iem.at
> Subject: Re: [PD] should I use pddp/link in help patches?
>  
> On Fre, 2017-06-02 at 09:45 +, Liam Goodacre wrote:
> > Hi José
> > 
> > This will only work with a pre-loaded abstraction or subpatch. I'm
> > talking about opening a new file that isn't already loaded.
> > 
> > You can open files like this:
> > 
> > [; pd open file.pd my/directory(
> > 
> > but it will only work with absolute, not relative directory paths.
> 
> It works with relative paths, too, but relative to Pd's start
> locaction
> and not relative to calling patch (which basically boils down to
> absolute in practice).
> 
> 
> Why not simply create the object/abstraction, so that you just right-
> click -> help when you want to follow the 'link'? It's how many help-
> patches, including the ones of Pd, reference other objects.
> 
> Roman
> 
> 
> 
> > From: José de Abreu <abreubace...@gmail.com>
> > Sent: 02 June 2017 10:21
> > To: Liam Goodacre; PD list
> > Subject: Re: [PD] should I use pddp/link in help patches?
> >  
> > Maybe
> > |; pd-nameOfSubpatch vis 1(
> > 
> > Em Sex, 2 de jun de 2017 03:03, Liam Goodacre <liamg...@hotmail.com
> >
> > escreveu:
> > > The [link] object is great for linking between help files, but I
> > > don't know how many people use it now that Extended has gone. By
> > > way of a survey, how many people have this external installed
> > > already? Seems like it will just be a nuisance if people have to
> > > download it just to read a help patch, but on the other hand it's
> a
> > > shame to give up on it since it's such a useful tool.
> > > 
> > > Assuming that it's not widely used any more, are there any other
> > > ways of opening a relative path from within PD?
> > > ___
> > > Pd-list@lists.iem.at mailing list
> > > UNSUBSCRIBE and account-management -> https://lists.puredata.info
> /l
> > > istinfo/pd-list
> > > 
> > ___
> > Pd-list@lists.iem.at mailing list
> > UNSUBSCRIBE and account-management -> https://lists.puredata.info/l
> is
> > tinfo/pd-list
> ___
> Pd-list@lists.iem.at mailing list
> UNSUBSCRIBE and account-management -> https://lists.puredata.info/lis
> tinfo/pd-list

signature.asc
Description: This is a digitally signed message part
___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list

Re: [PD] should I use pddp/link in help patches?

[Roman Haefeli]

On Fre, 2017-06-02 at 10:42 +, Liam Goodacre wrote:
> Hi Roman
> 
> Context, the system I'm documenting, is far too big to be explained
> in a single help-patch, so I want the 'context-help.pd' file to
> function more like a Table of Contents for the rest of the
> documentation (plus a few quick examples). It would be nice if the
> TOC could link to other files.


Hm...still sounds to like the patch you get when you right-click ->
help on an empty space in a Pd canvas:

doc/5.reference/help-intro.pd

It references all available objects by instantiating them. You can
righ-click -> select help on any of them.


Roman



signature.asc
Description: This is a digitally signed message part
___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list

Re: [PD] should I use pddp/link in help patches?

[Liam Goodacre]

Hi Roman


Context, the system I'm documenting, is far too big to be explained in a single 
help-patch, so I want the 'context-help.pd' file to function more like a Table 
of Contents for the rest of the documentation (plus a few quick examples). It 
would be nice if the TOC could link to other files.


-Liam



From: Pd-list <pd-list-boun...@lists.iem.at> on behalf of Roman Haefeli 
<reduz...@gmail.com>
Sent: 02 June 2017 11:03
To: pd-list@lists.iem.at
Subject: Re: [PD] should I use pddp/link in help patches?

On Fre, 2017-06-02 at 09:45 +, Liam Goodacre wrote:
> Hi José
>
> This will only work with a pre-loaded abstraction or subpatch. I'm
> talking about opening a new file that isn't already loaded.
>
> You can open files like this:
>
> [; pd open file.pd my/directory(
>
> but it will only work with absolute, not relative directory paths.

It works with relative paths, too, but relative to Pd's start locaction
and not relative to calling patch (which basically boils down to
absolute in practice).


Why not simply create the object/abstraction, so that you just right-
click -> help when you want to follow the 'link'? It's how many help-
patches, including the ones of Pd, reference other objects.

Roman



> From: José de Abreu <abreubace...@gmail.com>
> Sent: 02 June 2017 10:21
> To: Liam Goodacre; PD list
> Subject: Re: [PD] should I use pddp/link in help patches?
>
> Maybe
> |; pd-nameOfSubpatch vis 1(
>
> Em Sex, 2 de jun de 2017 03:03, Liam Goodacre <liamg...@hotmail.com>
> escreveu:
> > The [link] object is great for linking between help files, but I
> > don't know how many people use it now that Extended has gone. By
> > way of a survey, how many people have this external installed
> > already? Seems like it will just be a nuisance if people have to
> > download it just to read a help patch, but on the other hand it's a
> > shame to give up on it since it's such a useful tool.
> >
> > Assuming that it's not widely used any more, are there any other
> > ways of opening a relative path from within PD?
> > ___
> > Pd-list@lists.iem.at mailing list
> > UNSUBSCRIBE and account-management -> https://lists.puredata.info/l
> > istinfo/pd-list
> >
> ___
> Pd-list@lists.iem.at mailing list
> UNSUBSCRIBE and account-management -> https://lists.puredata.info/lis
> tinfo/pd-list
___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list

Re: [PD] should I use pddp/link in help patches?

[Roman Haefeli]

On Fre, 2017-06-02 at 09:45 +, Liam Goodacre wrote:
> Hi José
> 
> This will only work with a pre-loaded abstraction or subpatch. I'm
> talking about opening a new file that isn't already loaded.
> 
> You can open files like this:
> 
> [; pd open file.pd my/directory(
> 
> but it will only work with absolute, not relative directory paths.

It works with relative paths, too, but relative to Pd's start locaction
and not relative to calling patch (which basically boils down to
absolute in practice).


Why not simply create the object/abstraction, so that you just right-
click -> help when you want to follow the 'link'? It's how many help-
patches, including the ones of Pd, reference other objects.

Roman



> From: José de Abreu <abreubace...@gmail.com>
> Sent: 02 June 2017 10:21
> To: Liam Goodacre; PD list
> Subject: Re: [PD] should I use pddp/link in help patches?
>  
> Maybe
> |; pd-nameOfSubpatch vis 1(
> 
> Em Sex, 2 de jun de 2017 03:03, Liam Goodacre <liamg...@hotmail.com>
> escreveu:
> > The [link] object is great for linking between help files, but I
> > don't know how many people use it now that Extended has gone. By
> > way of a survey, how many people have this external installed
> > already? Seems like it will just be a nuisance if people have to
> > download it just to read a help patch, but on the other hand it's a
> > shame to give up on it since it's such a useful tool.
> > 
> > Assuming that it's not widely used any more, are there any other
> > ways of opening a relative path from within PD?
> > ___
> > Pd-list@lists.iem.at mailing list
> > UNSUBSCRIBE and account-management -> https://lists.puredata.info/l
> > istinfo/pd-list
> > 
> ___
> Pd-list@lists.iem.at mailing list
> UNSUBSCRIBE and account-management -> https://lists.puredata.info/lis
> tinfo/pd-list

signature.asc
Description: This is a digitally signed message part
___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list

Re: [PD] should I use pddp/link in help patches?

[Liam Goodacre]

Hi José


This will only work with a pre-loaded abstraction or subpatch. I'm talking 
about opening a new file that isn't already loaded.


You can open files like this:


[; pd open file.pd my/directory(


but it will only work with absolute, not relative directory paths.




From: José de Abreu <abreubace...@gmail.com>
Sent: 02 June 2017 10:21
To: Liam Goodacre; PD list
Subject: Re: [PD] should I use pddp/link in help patches?


Maybe

|; pd-nameOfSubpatch vis 1(

Em Sex, 2 de jun de 2017 03:03, Liam Goodacre 
<liamg...@hotmail.com<mailto:liamg...@hotmail.com>> escreveu:

The [link] object is great for linking between help files, but I don't know how 
many people use it now that Extended has gone. By way of a survey, how many 
people have this external installed already? Seems like it will just be a 
nuisance if people have to download it just to read a help patch, but on the 
other hand it's a shame to give up on it since it's such a useful tool.


Assuming that it's not widely used any more, are there any other ways of 
opening a relative path from within PD?

___
Pd-list@lists.iem.at<mailto:Pd-list@lists.iem.at> mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list
___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list

Re: [PD] should I use pddp/link in help patches?

[José de Abreu]

Maybe

|; pd-nameOfSubpatch vis 1(

Em Sex, 2 de jun de 2017 03:03, Liam Goodacre 
escreveu:

> The [link] object is great for linking between help files, but I don't
> know how many people use it now that Extended has gone. By way of a survey,
> how many people have this external installed already? Seems like it will
> just be a nuisance if people have to download it just to read a help patch,
> but on the other hand it's a shame to give up on it since it's such a
> useful tool.
>
>
> Assuming that it's not widely used any more, are there any other ways of
> opening a relative path from within PD?
> ___
> Pd-list@lists.iem.at mailing list
> UNSUBSCRIBE and account-management ->
> https://lists.puredata.info/listinfo/pd-list
>
___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list

[PD] should I use pddp/link in help patches?

[Liam Goodacre]

The [link] object is great for linking between help files, but I don't know how 
many people use it now that Extended has gone. By way of a survey, how many 
people have this external installed already? Seems like it will just be a 
nuisance if people have to download it just to read a help patch, but on the 
other hand it's a shame to give up on it since it's such a useful tool.


Assuming that it's not widely used any more, are there any other ways of 
opening a relative path from within PD?
___
Pd-list@lists.iem.at mailing list
UNSUBSCRIBE and account-management -> 
https://lists.puredata.info/listinfo/pd-list