[Pharo-project] [ANN] Pharo Online Help 1.1. for Pharo 2.0 (now with Markdown support and tutorials)
Hi, the Pharo Online Help project for Pharo 2.0 now also supports markdown [1] for writing documentation and tutorials. Markdown is an easy-to-read, easy-to-write plain text format that is translated into X(HTML). If you are in Pharo 2.0 just go to Tools -> ConfigurationBrowser and load PharoOnlineHelp. In the panel select a port or just click on "Start server". Now point your browser http://localhost:8080 Attached you will find some screenshots. The help system also includes an intro to Pharo and a start for a simple Smalltalk introduction (based on the old beginners workspace). Next steps: - maybe we can extend the integrated API browser to support webdoc [2] - move to SmalltalkHub project [3] - continue with Pharo and Smalltalk tutorials for beginners - better support for resources like images, js, css, ... (currently hard coded in OHFileRequestHandler) Feel free to help, code is on http://ss3.gemstone.com/ss/PharoOnlineHelp.html Thanks T. [1] http://daringfireball.net/projects/markdown/ [2] http://lists.gforge.inria.fr/pipermail/pharo-project/2013-February/074993.ht... [3] http://smalltalkhub.com/#!/~TorstenBergmann/PharoOnlineHelp
On 24 Feb 2013, at 10:36, "Torsten Bergmann" <astares@gmx.de> wrote:
Hi,
the Pharo Online Help project for Pharo 2.0 now also supports markdown [1] for writing documentation and tutorials.
Absolutely awesome, great work, Torsten. Looking at it right now. Sven
Markdown is an easy-to-read, easy-to-write plain text format that is translated into X(HTML).
If you are in Pharo 2.0 just go to Tools -> ConfigurationBrowser and load PharoOnlineHelp. In the panel select a port or just click on "Start server". Now point your browser http://localhost:8080
Attached you will find some screenshots.
The help system also includes an intro to Pharo and a start for a simple Smalltalk introduction (based on the old beginners workspace).
Next steps: - maybe we can extend the integrated API browser to support webdoc [2] - move to SmalltalkHub project [3] - continue with Pharo and Smalltalk tutorials for beginners - better support for resources like images, js, css, ... (currently hard coded in OHFileRequestHandler)
Feel free to help, code is on http://ss3.gemstone.com/ss/PharoOnlineHelp.html
Thanks T.
[1] http://daringfireball.net/projects/markdown/ [2] http://lists.gforge.inria.fr/pipermail/pharo-project/2013-February/074993.ht... [3] http://smalltalkhub.com/#!/~TorstenBergmann/PharoOnlineHelp<pharo_help_markdown.png><pharo_help.png><pharo_help_smalltalk_tuorial.png>
-- Sven Van Caekenberghe http://stfx.eu Smalltalk is the Red Pill
Yes, very nice! 2013/2/24 Sven Van Caekenberghe <sven@stfx.eu>:
On 24 Feb 2013, at 10:36, "Torsten Bergmann" <astares@gmx.de> wrote:
Hi,
the Pharo Online Help project for Pharo 2.0 now also supports markdown [1] for writing documentation and tutorials.
Absolutely awesome, great work, Torsten. Looking at it right now.
Sven
Markdown is an easy-to-read, easy-to-write plain text format that is translated into X(HTML).
If you are in Pharo 2.0 just go to Tools -> ConfigurationBrowser and load PharoOnlineHelp. In the panel select a port or just click on "Start server". Now point your browser http://localhost:8080
Attached you will find some screenshots.
The help system also includes an intro to Pharo and a start for a simple Smalltalk introduction (based on the old beginners workspace).
Next steps: - maybe we can extend the integrated API browser to support webdoc [2] - move to SmalltalkHub project [3] - continue with Pharo and Smalltalk tutorials for beginners - better support for resources like images, js, css, ... (currently hard coded in OHFileRequestHandler)
Feel free to help, code is on http://ss3.gemstone.com/ss/PharoOnlineHelp.html
Thanks T.
[1] http://daringfireball.net/projects/markdown/ [2] http://lists.gforge.inria.fr/pipermail/pharo-project/2013-February/074993.ht... [3] http://smalltalkhub.com/#!/~TorstenBergmann/PharoOnlineHelp<pharo_help_markdown.png><pharo_help.png><pharo_help_smalltalk_tuorial.png>
-- Sven Van Caekenberghe http://stfx.eu Smalltalk is the Red Pill
Torsten, On 24 Feb 2013, at 11:14, Sven Van Caekenberghe <sven@stfx.eu> wrote:
Looking at it right now.
Works great, beautiful web pages. I am particularly interested in the Markdown conversion, but I can't find it immediately. Where does the conversion from .md to .html happen in the code ? Thx, Sven PS: The - UNCOMMENTED - in the API browser is a great way to force comments on methods ;-) -- Sven Van Caekenberghe http://stfx.eu Smalltalk is the Red Pill
It loads in my image. But the "Browse button" invokes a NBWin32Shell class, which doesn't works too well on my Mac. Then, even is the server says it is started, it doesn't seems to work. I'll check later on my windows machine. Phil 2013/2/24 Torsten Bergmann <astares@gmx.de>:
Hi,
the Pharo Online Help project for Pharo 2.0 now also supports markdown [1] for writing documentation and tutorials.
Markdown is an easy-to-read, easy-to-write plain text format that is translated into X(HTML).
If you are in Pharo 2.0 just go to Tools -> ConfigurationBrowser and load PharoOnlineHelp. In the panel select a port or just click on "Start server". Now point your browser http://localhost:8080
Attached you will find some screenshots.
The help system also includes an intro to Pharo and a start for a simple Smalltalk introduction (based on the old beginners workspace).
Next steps: - maybe we can extend the integrated API browser to support webdoc [2] - move to SmalltalkHub project [3] - continue with Pharo and Smalltalk tutorials for beginners - better support for resources like images, js, css, ... (currently hard coded in OHFileRequestHandler)
Feel free to help, code is on http://ss3.gemstone.com/ss/PharoOnlineHelp.html
Thanks T.
[1] http://daringfireball.net/projects/markdown/ [2] http://lists.gforge.inria.fr/pipermail/pharo-project/2013-February/074993.ht... [3] http://smalltalkhub.com/#!/~TorstenBergmann/PharoOnlineHelp
nice work! On 2013-02-24, at 10:36, Torsten Bergmann <astares@gmx.de> wrote:
Hi,
the Pharo Online Help project for Pharo 2.0 now also supports markdown [1] for writing documentation and tutorials.
Markdown is an easy-to-read, easy-to-write plain text format that is translated into X(HTML).
If you are in Pharo 2.0 just go to Tools -> ConfigurationBrowser and load PharoOnlineHelp. In the panel select a port or just click on "Start server". Now point your browser http://localhost:8080
Attached you will find some screenshots.
The help system also includes an intro to Pharo and a start for a simple Smalltalk introduction (based on the old beginners workspace).
very nice! Maybe we can serialize the whole content and put it online on our gforge. Like that we would have google on our side! :)
Next steps: - maybe we can extend the integrated API browser to support webdoc [2]
I will try to look into it this weekend and extract the parts that depend on seasisde (of which I use zero functionality but the dsl to generate html)
- move to SmalltalkHub project [3] - continue with Pharo and Smalltalk tutorials for beginners - better support for resources like images, js, css, ... (currently hard coded in OHFileRequestHandler)
Feel free to help, code is on http://ss3.gemstone.com/ss/PharoOnlineHelp.html
Thanks T.
[1] http://daringfireball.net/projects/markdown/ [2] http://lists.gforge.inria.fr/pipermail/pharo-project/2013-February/074993.ht... [3] http://smalltalkhub.com/#!/~TorstenBergmann/PharoOnlineHelp<pharo_help_markdown.png><pharo_help.png><pharo_help_smalltalk_tuorial.png>
participants (4)
-
Camillo Bruni -
phil＠highoctane.be -
Sven Van Caekenberghe -
Torsten Bergmann