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.

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

User manual #1019

Open
mulfvik opened this issue Nov 12, 2020 · 10 comments · May be fixed by #1831
Open

User manual #1019

mulfvik opened this issue Nov 12, 2020 · 10 comments · May be fixed by #1831
Assignees

Comments

@mulfvik
Copy link
Contributor

mulfvik commented Nov 12, 2020

It would be nice to have a user manual connected to this repo. It could be a control that renders a manual in a modal perhaps and even only contains information about active controls and menuobjects.

@mulfvik mulfvik assigned mulfvik and unassigned mulfvik Nov 12, 2020
@tonnyandersson
Copy link
Collaborator

Perhaps something like this, instead of cramming everything into one single modal?

@mulfvik
Copy link
Contributor Author

mulfvik commented Nov 25, 2020

That looks very nice. Back to the drawing table :)
Just did one i modal for our release soon to come..
https://github.com/haninge-geodata/origo/tree/manual
haninge-geodata@eb61bb7#commitcomment-44521254

@tonnyandersson
Copy link
Collaborator

@mulfvik Just an idea. For inspiration, if you will. No need to throw all your work in the trash. :)

@mulfvik mulfvik self-assigned this Dec 1, 2020
@mulfvik
Copy link
Contributor Author

mulfvik commented Dec 3, 2020

Maybe have both a "guide" as @tonnyandersson tip and a "help" that diggs a little bit more deep into the controls and functions

@johnnyblasta
Copy link
Collaborator

Since both are working on a help function on could hope that they would collaborate @paho @mulfvik

@tonnyandersson
Copy link
Collaborator

A few suggestions:

  • Use a json file for configuration. Easier to maintain, no need to rebuild just to fix a typo, etc.
  • Automatically check for controls present in the map and only show help for those controls. No need to produce help sections for controls not available.
  • Please consider a mix between @paho's neatly organized sidebar solution and @mulfvik's concisely created control. I.e. a help control (rather than a plugin), presented in a sidebar-ish thing that does not close on map interaction and does not cover any other controls, with the information organized in groups.

@tonnyandersson
Copy link
Collaborator

Hi, @mulfvik! What's your status regarding this issue? Are you using any tools related to this in your production environment?

@mulfvik
Copy link
Contributor Author

mulfvik commented May 10, 2023

Hi @tonnyandersson, the status is its been a while since I did any on it. Got stuck on implementing oglide.js for a guide which I wanted to be a part of this PR. I was going to contact you for help in this regard... when time was available.
The manual, that this PR was refering to from the start :) has just a little more work to be done upon.

Yes, we use some of the code from the manual for a help modal.

I really would like to finish this but I understand if users wants this yesterday. If I promise to get it done during this summer?

@tonnyandersson
Copy link
Collaborator

@mulfvik No rush! We were just thinking about closing this issue but wanted to check if there's anything even remotely close to completion out there before closing. No one is pushing this issue within the project, hence the thoughts about closings, but I think it would be a waste not to have a look at what's been done before doing so.

@mulfvik
Copy link
Contributor Author

mulfvik commented May 10, 2023

@tonnyandersson I'll contact the development group and show whats been done and query about the oglide stuff

@mulfvik mulfvik linked a pull request Sep 10, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants