Class comments rendered in Nautilus (through Pillar)
Hi, Kasper Ãsterbye has just finished a proof-of-concept that renders Pillar text inside a class comment pane.
From the view, the developer can press $ (dollar) to edit the document in Pillar.
Best regards, -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill
Cool! This is the way to go. Thierry 2015-04-15 17:52 GMT+02:00 Damien Cassou <damien.cassou@gmail.com>:
Hi,
Kasper Ãsterbye has just finished a proof-of-concept that renders Pillar text inside a class comment pane.
From the view, the developer can press $ (dollar) to edit the document in Pillar.
Best regards,
-- Damien Cassou http://damiencassou.seasidehosting.st
"Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill
You want it for class comment , I want it for the Help Browser tool for the Morphic documentation project I am doing . This could not come at a better time, cant wait to look at the code, Thank you very much :) On Wed, Apr 15, 2015 at 6:52 PM, Damien Cassou <damien.cassou@gmail.com> wrote:
Hi,
Kasper Ãsterbye has just finished a proof-of-concept that renders Pillar text inside a class comment pane.
From the view, the developer can press $ (dollar) to edit the document in Pillar.
Best regards,
-- Damien Cassou http://damiencassou.seasidehosting.st
"Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill
Thanks Damien for putting this on the mailing list. A few words about the state of that Pillar-TextRenderer. The TextRenderer accepts at least the commands shown by the screenshot noted by Damien. In addition I would like to point to a special link type I added: *LinkText>pharo://Classname[/methodname]* which will render a link which when clicked will open a new Nautilus browser on said class and method. (I think that link syntax migh actually be useful in both the HTML and Latex Pillar exporters as well, perhaps just extracting the source and inserting it inline in the produced document. - but perhaps that is already done using some other feature I overlooked). I am rather overwhelmed by the PluggableTextView and other TextMorphs, so please understand that the supplied functionality is most likely not the right way to do this, but it seems to work. And Kilon, you are more than welcome to contact me and introduce me to this project of yours. As new to the morphic system I can tell you that documentation is really needed here. -- Kasper -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
Kasper Osterbye wrote
I am rather overwhelmed by the PluggableTextView and other TextMorphs
Welcome to the club! The only members are brave souls who dare to fight with the current editor mess before Tx brings us (hopefully soon) a beautiful design. ----- Cheers, Sean -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
You might also consider Rubric instead of raw Morphic. Peter On Wed, Apr 15, 2015 at 6:58 PM, Sean P. DeNigris <sean@clipperadams.com> wrote:
Kasper Osterbye wrote
I am rather overwhelmed by the PluggableTextView and other TextMorphs
Welcome to the club! The only members are brave souls who dare to fight with the current editor mess before Tx brings us (hopefully soon) a beautiful design.
----- Cheers, Sean -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
Just pop open the Configuration Browser and choose to install MorphicDoc. I am now trying to understand how layout policies for morphs works which is what I will be documenting next. Your link feature is also very important for me because I am taking advantage of the examples methods of Nautilus to provide an easy way for people to run examples based on documentation , having a link makes my life even easier. Together with MorphicDoc its my desire to develop a secondary project I have talked about in the past but did not have the confidence to pursue, called "Prometheas". I was thinking 2 things for the near future a) Better Pillar support for help tool (it already support very basic pillar) , already your work makes my life a lot easier b) better integration with GTSpotter for help tool. So if you can provide me a link to your code, even if your code is far from final it will at least give me a good idea how things work. Suffice to see I am very fresh with Morphic myself but I love to learn it, document it and improve it. On Wed, Apr 15, 2015 at 7:27 PM, KasperOsterbye <kasper@itu.dk> wrote:
Thanks Damien for putting this on the mailing list.
A few words about the state of that Pillar-TextRenderer.
The TextRenderer accepts at least the commands shown by the screenshot noted by Damien. In addition I would like to point to a special link type I added: *LinkText>pharo://Classname[/methodname]* which will render a link which when clicked will open a new Nautilus browser on said class and method. (I think that link syntax migh actually be useful in both the HTML and Latex Pillar exporters as well, perhaps just extracting the source and inserting it inline in the produced document. - but perhaps that is already done using some other feature I overlooked).
I am rather overwhelmed by the PluggableTextView and other TextMorphs, so please understand that the supplied functionality is most likely not the right way to do this, but it seems to work.
And Kilon, you are more than welcome to contact me and introduce me to this project of yours. As new to the morphic system I can tell you that documentation is really needed here.
-- Kasper
-- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
kilon.alios wrote
So if you can provide me a link to your code, even if your code is far from final it will at least give me a good idea how things work. Suffice to see I am very fresh with Morphic myself but I love to learn it, document it and improve it.
The packages are named Pillar-TextRenderer (to be loaded first) and Pillar-NautilusProofOfConcept (goes second). The proof of concept overrides one method in the nautilus browser, so to go back you need to revert that change (versions is your friend here). The key method in the Pillar-TextRenderer is: PRDecoratedTextWriter class>>on: aParsedPillarDoc -- Kasper -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
ok, but where and which repo ? Smalltalkhub ? GitHub ? Is part of Pillar ? How I install these packages ? On Wed, Apr 15, 2015 at 9:15 PM, Kasper Osterbye <kasper@itu.dk> wrote:
kilon.alios wrote
So if you can provide me a link to your code, even if your code is far from final it will at least give me a good idea how things work. Suffice to see I am very fresh with Morphic myself but I love to learn it, document it and improve it.
The packages are named Pillar-TextRenderer (to be loaded first) and Pillar-NautilusProofOfConcept (goes second). The proof of concept overrides one method in the nautilus browser, so to go back you need to revert that change (versions is your friend here).
The key method in the Pillar-TextRenderer is: PRDecoratedTextWriter class>>on: aParsedPillarDoc
-- Kasper
-- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
kilon alios <kilon.alios@gmail.com> writes:
ok, but where and which repo ? Smalltalkhub ? GitHub ? Is part of Pillar ? How I install these packages ?
load a Pillar image from https://ci.inria.fr/pharo-contribution/job/Pillar (using the launcher for example :-)) and load Pillar-TextRenderer and Pillar-NautilusProofOfConcept in this order from the pillar repository (already in monticello). -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill
thank you Damien, will give a look , may I also use configuration browser ? is it up to date ? On Thu, Apr 16, 2015 at 11:16 AM, Damien Cassou <damien.cassou@gmail.com> wrote:
kilon alios <kilon.alios@gmail.com> writes:
ok, but where and which repo ? Smalltalkhub ? GitHub ? Is part of Pillar ? How I install these packages ?
load a Pillar image from https://ci.inria.fr/pharo-contribution/job/Pillar (using the launcher for example :-)) and load Pillar-TextRenderer and Pillar-NautilusProofOfConcept in this order from the pillar repository (already in monticello).
-- Damien Cassou http://damiencassou.seasidehosting.st
"Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill
kilon alios <kilon.alios@gmail.com> writes:
thank you Damien, will give a look , may I also use configuration browser ? is it up to date ?
you can use the configuration browser to get Pillar, but not the nautilus patch. -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill
Kasper an idea: what about a version of FileSystem that can be used to navigate classes? Thanks for the renderer and yes these classes suck Stef Le 15/4/15 18:27, KasperOsterbye a écrit :
Thanks Damien for putting this on the mailing list.
A few words about the state of that Pillar-TextRenderer.
The TextRenderer accepts at least the commands shown by the screenshot noted by Damien. In addition I would like to point to a special link type I added: *LinkText>pharo://Classname[/methodname]* which will render a link which when clicked will open a new Nautilus browser on said class and method. (I think that link syntax migh actually be useful in both the HTML and Latex Pillar exporters as well, perhaps just extracting the source and inserting it inline in the produced document. - but perhaps that is already done using some other feature I overlooked).
I am rather overwhelmed by the PluggableTextView and other TextMorphs, so please understand that the supplied functionality is most likely not the right way to do this, but it seems to work.
And Kilon, you are more than welcome to contact me and introduce me to this project of yours. As new to the morphic system I can tell you that documentation is really needed here.
-- Kasper
-- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
stepharo wrote
an idea: what about a version of FileSystem that can be used to navigate classes?
I assume there is some tooling you would like to re-use? If that is the case, I would think it would be more useful to look into what might be the right common abstraction between filesystem and class/method hierarchy - but it is hard to say without knowing the problem you were thinking of (and was it related to the text-renderer in some way I did not see?) -- Kasper -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
Is the highlighting happening live? Could you please look at what already exists in the inspector integration. There you already have syntax highlighting as you type. I think it would be more useful to consolidate the live highlighting around Rubric than to invest in TextMorph: http://www.humane-assessment.com/blog/writing-pillar-books-with-the-gtinspec... This road would be even better if we would get a better parser (in my view based on PetitParser) for Pillar. Cheers, Doru On Wed, Apr 15, 2015 at 9:42 PM, Kasper Osterbye <kasper@itu.dk> wrote:
stepharo wrote
an idea: what about a version of FileSystem that can be used to navigate classes?
I assume there is some tooling you would like to re-use?
If that is the case, I would think it would be more useful to look into what might be the right common abstraction between filesystem and class/method hierarchy - but it is hard to say without knowing the problem you were thinking of (and was it related to the text-renderer in some way I did not see?)
-- Kasper
-- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
-- www.tudorgirba.com "Every thing has its own flow"
In short, no, it is not live, you switch between the two modes. Iâll look at the link you sendt me later. Best, Kasper On 16 apr., 2015, at 07:56 , Tudor Girba-2 [via Smalltalk] <ml-node+s1294792n4819813h11@n4.nabble.com<mailto:ml-node+s1294792n4819813h11@n4.nabble.com>> wrote: Is the highlighting happening live? Could you please look at what already exists in the inspector integration. There you already have syntax highlighting as you type. I think it would be more useful to consolidate the live highlighting around Rubric than to invest in TextMorph: http://www.humane-assessment.com/blog/writing-pillar-books-with-the-gtinspec... This road would be even better if we would get a better parser (in my view based on PetitParser) for Pillar. Cheers, Doru On Wed, Apr 15, 2015 at 9:42 PM, Kasper Osterbye <[hidden email]<x-msg://9/user/SendEmail.jtp?type=node&node=4819813&i=0>> wrote: stepharo wrote
an idea: what about a version of FileSystem that can be used to navigate classes?
I assume there is some tooling you would like to re-use? If that is the case, I would think it would be more useful to look into what might be the right common abstraction between filesystem and class/method hierarchy - but it is hard to say without knowing the problem you were thinking of (and was it related to the text-renderer in some way I did not see?) -- Kasper -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com<http://Nabble.com>. -- www.tudorgirba.com<http://www.tudorgirba.com/> "Every thing has its own flow" ________________________________ If you reply to this email, your message will be added to the discussion below: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... To unsubscribe from Class comments rendered in Nautilus (through Pillar), click here<http://forum.world.st/template/NamlServlet.jtp?macro=unsubscribe_by_code&nod...>. NAML<http://forum.world.st/template/NamlServlet.jtp?macro=macro_viewer&id=instant...> -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
I was just thinking about an experiment to map our world into a kind of file system and use it to navigate because in your link you want to refer to the class/method and in fact it could be package/class/method package/resource or package/class/resources (that we may have one day) but this was just an idea Le 15/4/15 21:42, Kasper Osterbye a écrit :
stepharo wrote
an idea: what about a version of FileSystem that can be used to navigate classes? I assume there is some tooling you would like to re-use?
If that is the case, I would think it would be more useful to look into what might be the right common abstraction between filesystem and class/method hierarchy - but it is hard to say without knowing the problem you were thinking of (and was it related to the text-renderer in some way I did not see?)
-- Kasper
-- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
stepharo wrote
I was just thinking about an experiment to map our world into a kind of file system and use it to navigate because in your link you want to refer to the class/method and in fact it could be package/class/method package/resource or package/class/resources (that we may have one day)
He he - yes, I have had all kinds of thoughts in that direction. But at the moment it is most likely not where I will look. If anything - I would rather take a look on how one can use pillar-markup inside method comments, and try to see if one can find a way to make the interaction work. It should somehow be possible to hack into the syntax highlighter to do this, but I am not sure. Right now, I will try to consolidate what I did. But Damien suggested I just hold back until the Tx work is further progressed. -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
KasperOsterbye <kasper@itu.dk> writes:
The TextRenderer accepts at least the commands shown by the screenshot noted by Damien. In addition I would like to point to a special link type I added: *LinkText>pharo://Classname[/methodname]* which will render a link which when clicked will open a new Nautilus browser on said class and method.
I'm a bit skeptical about this syntax has it is heavyweight and I'm not sure developers will want to use it. What about either: 1- let the developer simply write "TheClass" or "TheClass>>method" of "#method" and get links (when target entity exists)? That's the simplest. 2- or let the developer write ${pharo:TheClass}$, ${pharo:TheClass>>method}$ or ${pharo:#method}$? This is more complex but also more explicit. -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill
Damien Cassou wrote
The TextRenderer accepts at least the commands shown by the screenshot noted by Damien. In addition I would like to point to a special link type I added: *LinkText>pharo://Classname[/methodname]* which will render a link which when clicked will open a new Nautilus browser on said class and method.
I'm a bit skeptical about this syntax has it is heavyweight and I'm not sure developers will want to use it. What about either:
1- let the developer simply write "TheClass" or "TheClass>>method" of "#method" and get links (when target entity exists)? That's the simplest.
2- or let the developer write ${pharo:TheClass}$, ${pharo:TheClass>>method}$ or ${pharo:#method}$? This is more complex but also more explicit.
I like it to be a link, and hence the * syntax. A short version could be *>pharo://Class/method* - with auto picking the class or method name as link text as no other links (atm) will be without link text, it might default to *>Class/method* It depends a bit on the parser if it will be able to read it, I cannot try it right now. -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
Kasper Osterbye <kasper@itu.dk> writes:
*>pharo://Class/method*
you don't need the $>. This should be fine: *pharo://Class/method* -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill
On 16 apr., 2015, at 12:36 , Damien Cassou [via Smalltalk] <ml-node+s1294792n4819911h49@n4.nabble.com> wrote: you don't need the $>. This should be fine:
*pharo://Class/method* Cool - as long as the visitor will visit a link with this text I can work with that.
Best, Kasper -- View this message in context: http://forum.world.st/Class-comments-rendered-in-Nautilus-through-Pillar-tp4... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
participants (9)
-
Damien Cassou -
Kasper Osterbye -
KasperOsterbye
-
kilon alios -
Peter Uhnák -
Sean P. DeNigris -
stepharo -
Thierry Goubier -
Tudor Girba