Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

How to make help accessible - workaround for bug #61 #174

Open
LisaAlmarode opened this issue Jan 7, 2025 · 3 comments
Open

How to make help accessible - workaround for bug #61 #174

LisaAlmarode opened this issue Jan 7, 2025 · 3 comments
Assignees
@LisaAlmarode @ericwinger
Labels
F1-Required Feature A feature that needs to be there

Comments

@LisaAlmarode
Copy link
Member

Users are going to need some documentation since at minimum, the meanings of project browser font colors and styles is not intuitive. Since online help going to a web page isn't working, we need an alternative way for them to get there.

Perhaps we can hook into Pharo's help mechanism. This appears to be from github files in markdown,
https://github.com/pharo-project/pharo/tree/Pharo12/doc. Although I really hate working in markdown, I do have a framemaker-to-html-to-github-compatible-markdown tool. Eric, assigning this to you to determine if it's feasible.

We also need to update the help files. Lisa will work on that once a format is decided.
@LisaAlmarode LisaAlmarode added the F1-Required Feature A feature that needs to be there label Jan 7, 2025
@ericwinger
Copy link
Member

The web page opening bug is recorded as,
#61

@ericwinger
Copy link
Member

ericwinger commented Jan 15, 2025 •
edited
Loading

I haven't found an html browser within pharo yet. Looks like the closest is a markdown presenter. Doing a convert of the jadeitehelp.html into markdown, I was able to display this. Doesn't look terrible. @LisaAlmarode Would this be an acceptable stop-gap measure?

image

ericwinger added a commit that referenced this issue Jan 16, 2025
@ericwinger
Fixes #177 - git functionality broken
b93c51a 
Hadn't yet made the git branch and git tag functionality RSR-compliant. The "halt" message is a message to me that I left a nil completion block in as part of the grand RSR-required infrastructure rework. Fixed. 
Also, made a tiny help display for testing how .md files would look for #174 - #174
Added little test, too. 
#177
ericwinger added a commit that referenced this issue Jan 28, 2025
@ericwinger
Work in progress - #174 make help available
2e263e5 
Expose the markdown help file for improvement by docs. 
#174
ericwinger added a commit that referenced this issue Jan 28, 2025
@ericwinger
work in progress - copy jadeitehelp.md file when loading baseline
fb6de98 
#174
@ericwinger
Copy link
Member

ericwinger commented Jan 28, 2025 •
edited
Loading

A rudimentary help browser can be found by clicking "Jadeite Help" on the Consol'es Help menu. It will open a file jadeitehelp.md which has been copied to your pharo working directory by the startup.st script. The file on disk can be edited as needed and committed to the JfP github repository.

Ready for docs work by @LisaAlmarode
Image

Image

ericwinger added a commit that referenced this issue Feb 6, 2025
@ericwinger
restore guards against arrays in ListModel collection & install help
ec60c69 
The help package wasn't installed in the baseline. Fixed. 
There is a long-standing bug that ListModel's were getting Array's not OrderedCollection's. Restore guardrails until the source of that bug can be found. 
open debugger in morphic ui thread

#209
#174
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@LisaAlmarode LisaAlmarode

@ericwinger ericwinger

Labels
F1-Required Feature A feature that needs to be there
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@LisaAlmarode @ericwinger