[ANN] MorphicDoc : A project to document Morphic
One of the frequent questions we get asked is how to use Morphic. Unfortunately there is very little documentation for Morphic around and barely touches the most interesting concepts. I decided to start my own project called MorphicDoc . MorphicDoc is very easy to install with Configuration Browser and it works in 2 ways. a) open the Help tool (World Menu => Help => Help Browser ) and there you will find a new section called "Morphic Doc by Kilon" b) open System Browser go to MorphicDoc package and look at the class side of MorphicDocExamples class , each method is an example taken from the tutorial in help tool and you can easily execute by clicking the green arrow next to its name. Right now only 3 pages have been added but slowly and steadily more will be added. To get new pages and even new chapters make sure you reinstall the same very simple way like installing just open Configuration Browser and click "Install Stable Version" after you selected MorphicDoc. I will try to add 1 page per day and at least 1 page per week depending on my free time. So make sure you update at least once per week to get the latest version of MorphicDoc. You can report issues , advice and requests at the project page in https://github.com/kilon/MorphicDoc. Of course pull requests are more than welcomed.
Hey Kilon ! I would like to contribute to your new project. Started learning Morphic on Mr. Martin Bahr's suggestion. Looking forward to a positive reply. Thanks Jigyasa Grover -- View this message in context: http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062... Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
sure any help is welcomed . Contributing is the usual github workflow, you fork and send me pull requests (I would like to use this opportunity to test to see how well pull request works with gitfiletree). Creating the documentation is also quite simple, if you open the help tool has a section of how to make documentation. To put simply, just take a look at the MorphDoc class , hellworld method and use that as template to create your own page , then add the page (name of the method) to the array returned by pages method. Then after you add the page you add your example code that you use in that page in the MorphDocExamples class (also found in MorphDoc package) the name of the method should start with example follow with name of the method use for the page in MorphDoc. Each page should contain a simple image and should be no more than one page long. I try to brake documentation to small pages easy to follow and understand instead of lengthy descriptions. I am on easter vacation in my father's village and the internet here is very weak so its hard for me to be online so if you need any help just email me. On Sat, Apr 11, 2015 at 7:50 PM, Jigyasa Grover <grover.jigyasa1@gmail.com> wrote:
Hey Kilon ! I would like to contribute to your new project. Started learning Morphic on Mr. Martin Bahr's suggestion. Looking forward to a positive reply. Thanks Jigyasa Grover
-- View this message in context: http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062... Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
Hi Kilon, Le 11/04/2015 19:42, kilon alios a écrit :
sure any help is welcomed .
Contributing is the usual github workflow, you fork and send me pull requests (I would like to use this opportunity to test to see how well pull request works with gitfiletree).
You'll tell me :) Just remember that github may not be able to merge because of conflicts in the filetree metadata. In this case, you need to merge on your system with the merge driver, and push to github. Thierry
Creating the documentation is also quite simple, if you open the help tool has a section of how to make documentation. To put simply, just take a look at the MorphDoc class , hellworld method and use that as template to create your own page , then add the page (name of the method) to the array returned by pages method. Then after you add the page you add your example code that you use in that page in the MorphDocExamples class (also found in MorphDoc package) the name of the method should start with example follow with name of the method use for the page in MorphDoc.
Each page should contain a simple image and should be no more than one page long. I try to brake documentation to small pages easy to follow and understand instead of lengthy descriptions.
I am on easter vacation in my father's village and the internet here is very weak so its hard for me to be online so if you need any help just email me.
On Sat, Apr 11, 2015 at 7:50 PM, Jigyasa Grover <grover.jigyasa1@gmail.com <mailto:grover.jigyasa1@gmail.com>> wrote:
Hey Kilon ! I would like to contribute to your new project. Started learning Morphic on Mr. Martin Bahr's suggestion. Looking forward to a positive reply. Thanks Jigyasa Grover
-- View this message in context: http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062... Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
yes I am aware of your merge driver, will give it a try of course. I am certainly curious to see how well it works in practice. If not I will blame you of course and just copy paste the code and commit it myself. Good opportunity to learn more about git too. On Sat, Apr 11, 2015 at 8:49 PM, Thierry Goubier <thierry.goubier@gmail.com> wrote:
Hi Kilon,
Le 11/04/2015 19:42, kilon alios a écrit :
sure any help is welcomed .
Contributing is the usual github workflow, you fork and send me pull requests (I would like to use this opportunity to test to see how well pull request works with gitfiletree).
You'll tell me :)
Just remember that github may not be able to merge because of conflicts in the filetree metadata. In this case, you need to merge on your system with the merge driver, and push to github.
Thierry
Creating the documentation is also quite simple, if you open the help
tool has a section of how to make documentation. To put simply, just take a look at the MorphDoc class , hellworld method and use that as template to create your own page , then add the page (name of the method) to the array returned by pages method. Then after you add the page you add your example code that you use in that page in the MorphDocExamples class (also found in MorphDoc package) the name of the method should start with example follow with name of the method use for the page in MorphDoc.
Each page should contain a simple image and should be no more than one page long. I try to brake documentation to small pages easy to follow and understand instead of lengthy descriptions.
I am on easter vacation in my father's village and the internet here is very weak so its hard for me to be online so if you need any help just email me.
On Sat, Apr 11, 2015 at 7:50 PM, Jigyasa Grover <grover.jigyasa1@gmail.com <mailto:grover.jigyasa1@gmail.com>> wrote:
Hey Kilon ! I would like to contribute to your new project. Started learning Morphic on Mr. Martin Bahr's suggestion. Looking forward to a positive reply. Thanks Jigyasa Grover
-- View this message in context: http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic- tp4819062p4819074.html Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
Le 11 avr. 2015 20:00, "kilon alios" <kilon.alios@gmail.com> a écrit :
yes I am aware of your merge driver, will give it a try of course. I am
certainly curious to see how well it works in practice. Works nicely here but I am doing FileTree with external git tooling. Great initiative on Morphic. Phil If not I will blame you of course and just copy paste the code and commit it myself. Good opportunity to learn more about git too.
On Sat, Apr 11, 2015 at 8:49 PM, Thierry Goubier <
thierry.goubier@gmail.com> wrote:
Hi Kilon,
Le 11/04/2015 19:42, kilon alios a écrit :
sure any help is welcomed .
Contributing is the usual github workflow, you fork and send me pull requests (I would like to use this opportunity to test to see how well pull request works with gitfiletree).
You'll tell me :)
Just remember that github may not be able to merge because of conflicts
in the filetree metadata. In this case, you need to merge on your system with the merge driver, and push to github.
Thierry
Creating the documentation is also quite simple, if you open the help tool has a section of how to make documentation. To put simply, just take a look at the MorphDoc class , hellworld method and use that as template to create your own page , then add the page (name of the method) to the array returned by pages method. Then after you add the page you add your example code that you use in that page in the MorphDocExamples class (also found in MorphDoc package) the name of the method should start with example follow with name of the method use for the page in MorphDoc.
Each page should contain a simple image and should be no more than one page long. I try to brake documentation to small pages easy to follow and understand instead of lengthy descriptions.
I am on easter vacation in my father's village and the internet here is very weak so its hard for me to be online so if you need any help just email me.
On Sat, Apr 11, 2015 at 7:50 PM, Jigyasa Grover <grover.jigyasa1@gmail.com <mailto:grover.jigyasa1@gmail.com>> wrote:
Hey Kilon ! I would like to contribute to your new project. Started learning Morphic on Mr. Martin Bahr's suggestion. Looking forward to a positive reply. Thanks Jigyasa Grover
-- View this message in context:
http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062...
Sent from the Pharo Smalltalk Users mailing list archive at
Nabble.com.
Thanks I was joking about gitfiletree I am sure I will be fine ΣÏÎ¹Ï 12 ÎÏÏ 2015 10:18 Ï.μ., ο ÏÏήÏÏÎ·Ï "phil@highoctane.be" < phil@highoctane.be> ÎγÏαÏε:
Le 11 avr. 2015 20:00, "kilon alios" <kilon.alios@gmail.com> a écrit :
yes I am aware of your merge driver, will give it a try of course. I am
certainly curious to see how well it works in practice.
Works nicely here but I am doing FileTree with external git tooling.
Great initiative on Morphic.
Phil
If not I will blame you of course and just copy paste the code and commit it myself. Good opportunity to learn more about git too.
On Sat, Apr 11, 2015 at 8:49 PM, Thierry Goubier <
thierry.goubier@gmail.com> wrote:
Hi Kilon,
Le 11/04/2015 19:42, kilon alios a écrit :
sure any help is welcomed .
Contributing is the usual github workflow, you fork and send me pull requests (I would like to use this opportunity to test to see how well pull request works with gitfiletree).
You'll tell me :)
Just remember that github may not be able to merge because of conflicts
in the filetree metadata. In this case, you need to merge on your system with the merge driver, and push to github.
Thierry
Creating the documentation is also quite simple, if you open the help tool has a section of how to make documentation. To put simply, just take a look at the MorphDoc class , hellworld method and use that as template to create your own page , then add the page (name of the method) to the array returned by pages method. Then after you add the page you add your example code that you use in that page in the MorphDocExamples class (also found in MorphDoc package) the name of the method should start with example follow with name of the method use for the page in MorphDoc.
Each page should contain a simple image and should be no more than one page long. I try to brake documentation to small pages easy to follow and understand instead of lengthy descriptions.
I am on easter vacation in my father's village and the internet here is very weak so its hard for me to be online so if you need any help just email me.
On Sat, Apr 11, 2015 at 7:50 PM, Jigyasa Grover <grover.jigyasa1@gmail.com <mailto:grover.jigyasa1@gmail.com>> wrote:
Hey Kilon ! I would like to contribute to your new project. Started learning Morphic on Mr. Martin Bahr's suggestion. Looking forward to a positive reply. Thanks Jigyasa Grover
-- View this message in context:
http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062...
Sent from the Pharo Smalltalk Users mailing list archive at
Nabble.com.
That's great ! Good luck with your project ! Thank you ! On 12 April 2015 at 18:19, kilon alios <kilon.alios@gmail.com> wrote:
Thanks I was joking about gitfiletree I am sure I will be fine
ΣÏÎ¹Ï 12 ÎÏÏ 2015 10:18 Ï.μ., ο ÏÏήÏÏÎ·Ï "phil@highoctane.be" <phil@highoctane.be> ÎγÏαÏε:
Le 11 avr. 2015 20:00, "kilon alios" <kilon.alios@gmail.com> a écrit :
yes I am aware of your merge driver, will give it a try of course. I am certainly curious to see how well it works in practice.
Works nicely here but I am doing FileTree with external git tooling.
Great initiative on Morphic.
Phil
If not I will blame you of course and just copy paste the code and commit it myself. Good opportunity to learn more about git too.
On Sat, Apr 11, 2015 at 8:49 PM, Thierry Goubier <thierry.goubier@gmail.com> wrote:
Hi Kilon,
Le 11/04/2015 19:42, kilon alios a écrit :
sure any help is welcomed .
Contributing is the usual github workflow, you fork and send me pull requests (I would like to use this opportunity to test to see how well pull request works with gitfiletree).
You'll tell me :)
Just remember that github may not be able to merge because of conflicts in the filetree metadata. In this case, you need to merge on your system with the merge driver, and push to github.
Thierry
Creating the documentation is also quite simple, if you open the help tool has a section of how to make documentation. To put simply, just take a look at the MorphDoc class , hellworld method and use that as template to create your own page , then add the page (name of the method) to the array returned by pages method. Then after you add the page you add your example code that you use in that page in the MorphDocExamples class (also found in MorphDoc package) the name of the method should start with example follow with name of the method use for the page in MorphDoc.
Each page should contain a simple image and should be no more than one page long. I try to brake documentation to small pages easy to follow and understand instead of lengthy descriptions.
I am on easter vacation in my father's village and the internet here is very weak so its hard for me to be online so if you need any help just email me.
On Sat, Apr 11, 2015 at 7:50 PM, Jigyasa Grover <grover.jigyasa1@gmail.com <mailto:grover.jigyasa1@gmail.com>> wrote:
Hey Kilon ! I would like to contribute to your new project. Started learning Morphic on Mr. Martin Bahr's suggestion. Looking forward to a positive reply. Thanks Jigyasa Grover
-- View this message in context:
http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062... Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
-- Cheers Cyril Ferlicot
kilon.alios wrote
I decided to start my own project called MorphicDoc
Great! Thanks :) ----- Cheers, Sean -- View this message in context: http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062... Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
my pleasure ΣÏÎ¹Ï 11 ÎÏÏ 2015 9:19 μ.μ., ο ÏÏήÏÏÎ·Ï "Sean P. DeNigris" < sean@clipperadams.com> ÎγÏαÏε:
kilon.alios wrote
I decided to start my own project called MorphicDoc
Great! Thanks :)
----- Cheers, Sean -- View this message in context:
http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062...
Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
kilon -- That's awesome! How would you feel about also adding some of those docs into the Morphic chapter of PBE? (Or, if you dont have the bandwidth, would you be opposed to someone else doing that?) On Saturday, April 11, 2015, kilon alios <kilon.alios@gmail.com> wrote:
One of the frequent questions we get asked is how to use Morphic. Unfortunately there is very little documentation for Morphic around and barely touches the most interesting concepts.
I decided to start my own project called MorphicDoc . MorphicDoc is very easy to install with Configuration Browser and it works in 2 ways. a) open the Help tool (World Menu => Help => Help Browser ) and there you will find a new section called "Morphic Doc by Kilon" b) open System Browser go to MorphicDoc package and look at the class side of MorphicDocExamples class , each method is an example taken from the tutorial in help tool and you can easily execute by clicking the green arrow next to its name.
Right now only 3 pages have been added but slowly and steadily more will be added. To get new pages and even new chapters make sure you reinstall the same very simple way like installing just open Configuration Browser and click "Install Stable Version" after you selected MorphicDoc.
I will try to add 1 page per day and at least 1 page per week depending on my free time. So make sure you update at least once per week to get the latest version of MorphicDoc.
You can report issues , advice and requests at the project page in https://github.com/kilon/MorphicDoc. Of course pull requests are more than welcomed.
If someone wants to add it to UPBE he is more than welcomed to do so. My goal is quite diffirent I want a more dynamic documentation. That means I will fork and improve the help tool. I want to offer a more interactive experience. Time will tell if my ideas are practical and usefull but I want to focus there. kilon -- That's awesome! How would you feel about also adding some of those docs into the Morphic chapter of PBE? (Or, if you dont have the bandwidth, would you be opposed to someone else doing that?) On Saturday, April 11, 2015, kilon alios <kilon.alios@gmail.com> wrote:
One of the frequent questions we get asked is how to use Morphic. Unfortunately there is very little documentation for Morphic around and barely touches the most interesting concepts.
I decided to start my own project called MorphicDoc . MorphicDoc is very easy to install with Configuration Browser and it works in 2 ways. a) open the Help tool (World Menu => Help => Help Browser ) and there you will find a new section called "Morphic Doc by Kilon" b) open System Browser go to MorphicDoc package and look at the class side of MorphicDocExamples class , each method is an example taken from the tutorial in help tool and you can easily execute by clicking the green arrow next to its name.
Right now only 3 pages have been added but slowly and steadily more will be added. To get new pages and even new chapters make sure you reinstall the same very simple way like installing just open Configuration Browser and click "Install Stable Version" after you selected MorphicDoc.
I will try to add 1 page per day and at least 1 page per week depending on my free time. So make sure you update at least once per week to get the latest version of MorphicDoc.
You can report issues , advice and requests at the project page in https://github.com/kilon/MorphicDoc. Of course pull requests are more than welcomed.
kilon.alios wrote
My goal is quite diffirent I want a more dynamic documentation
Yeeees!! It is a shame that the documentation for our Dynabook is written almost exclusively in old media :/ With a not-too-unimaginable enhancement to our tools (which I think is much more plausible once we have Tx), we could write in WYSIWYG to be viewed, manipulated, evaluated, hot linked, etc in-image. Have you read "Active Essays on the Web" [1]? [1] http://www.vpri.org/pdf/tr2009002_active_essays.pdf ? ----- Cheers, Sean -- View this message in context: http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062... Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
Thanks will read for now as first feature will be to connect gtspotter to help tool ΣÏÎ¹Ï 12 ÎÏÏ 2015 4:40 μ.μ., ο ÏÏήÏÏÎ·Ï "Sean P. DeNigris" < sean@clipperadams.com> ÎγÏαÏε:
kilon.alios wrote
My goal is quite diffirent I want a more dynamic documentation
Yeeees!! It is a shame that the documentation for our Dynabook is written almost exclusively in old media :/ With a not-too-unimaginable enhancement to our tools (which I think is much more plausible once we have Tx), we could write in WYSIWYG to be viewed, manipulated, evaluated, hot linked, etc in-image. Have you read "Active Essays on the Web" [1]?
[1] http://www.vpri.org/pdf/tr2009002_active_essays.pdf ?
----- Cheers, Sean -- View this message in context: http://forum.world.st/ANN-MorphicDoc-A-project-to-document-Morphic-tp4819062... Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.
participants (7)
-
Cyril Ferlicot -
Dmitri Zagidulin -
Jigyasa Grover -
kilon alios -
phil＠highoctane.be -
Sean P. DeNigris -
Thierry Goubier