[Cuis] [4.1] Porting need: HelpSystem

[Germán Arduino]

Make sense to me.....Never considered this option because I don't know a
lot of GitHub. Only use it to store code.

But if we have here a possiblity of have complete documentation, images,
etc, look good, because is searchable (it is?)

Doing a google search for CobolScript Hello World don't seems to find
exactly the doc page....

But not having tons of text help in the image, look good....specially if we
think that not all the dev/contributors write the doc in the help format.

-- 
Sincerely,
Germán Arduino
about.me/garduino


2013/1/5 Angel Java Lopez <ajlopez2000 at gmail.com>

> Hi people!
>
> I'm the "non-smalltalk dev" in this list ;-)  And I want to say something.
>
> Yes, I know there is the "Smalltalk way" of doing many things... but... in
> other technologies, no help system is practically used (since last decade?
> more?). The flow is:
>
> - Google search
> - Giving post resulst, or stack overflow question, answers
>
> For samples, if the project is hosted in GitHub, usually there is a
> samples folder in the project. (well, I'm very proud of my samples in
> CobolScript
> https://github.com/ajlopez/CobolScript/tree/master/samples
> ;-)
>
> The main use cases are usually described in .md pages at GitHub project
> site. You can add images too (see the raw version of
> https://github.com/ajlopez/CobolScript/tree/master/samples/templateweb to
> see how to link to a image hosted in the same GitHub project site).
>
> You have the option of having a site, the branch gh-page, with an static
> site. And there are static sites generators, like Octopress.
>
> I put simple online demo of my AjTalkJs (Smalltalk in JavaScript) in the
> gh-page branch of:
> https://github.com/ajlopez/AjTalkJs
> it was published as
> http://ajlopez.github.com/AjTalkJs/
>
> As another branches, it can received pull request for improvements.
>
> There is an administration option to create that branch with an initial
> style, and there are third--parties GitHub styles.
>
> My 2 cents
>
> Angel "Java" Lopez
> @ajlopez
> github:ajlopez
>
> On Sat, Jan 5, 2013 at 9:20 AM, H. Hirzel <hannes.hirzel at gmail.com> wrote:
>
>> Hello
>>
>> On 1/5/13, Germán Arduino <garduino at gmail.com> wrote:
>> > This is always a challenge, I mean collect all the knowledge disperse on
>> > the mailing lists.
>>
>> Yes.
>>
>> > Don't think you that more than tons of workspaces we should port the
>> Help
>> > System? Someone looked into it to understand if is a big job?
>> >
>>
>> Yes, I think as well that mid term we need the help system from Squeak
>> ported.
>> It is included in Squeak and was done by Torsten Bergmann. It is on
>> www.squeaksource.com but as it is now part of the Squeak image I
>> suggest to take that version.
>>
>> As for now having a few workspaces more (see the current help menu in
>> the screen shot) is not an issue, I think.
>>
>>      5 entries so far
>>
>> Maybe we can have a dividing bar after them so separate the five
>> entries from 'VM statistics' and 'Space left'.
>>
>> Let's focus on more tests, useful expressions, code snippets to adapt and
>> notes.
>> (see the other mails of mine today)
>>
>> Another area to give some example code is "File operations".
>>
>> However it is probably not a big effort to port the HelpSystem (I did
>> not check, maybe between 1....10 hours :-)   ),
>>
>> It might be a good starting point for somebody who wants to get into
>> porting packages to Cuis. So if anybody wants to take this one, that
>> is very fine.
>>
>> Kind regards
>>
>> --Hannes
>>
>> _______________________________________________
>> Cuis mailing list
>> Cuis at jvuletich.org
>> http://jvuletich.org/mailman/listinfo/cuis_jvuletich.org
>>
>
>
> _______________________________________________
> Cuis mailing list
> Cuis at jvuletich.org
> http://jvuletich.org/mailman/listinfo/cuis_jvuletich.org
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://jvuletich.org/pipermail/cuis_jvuletich.org/attachments/20130105/9bbaacc0/attachment-0003.html>