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

Interactive manual #3342

Open
pthom opened this issue Jul 7, 2020 · 6 comments
Open

Interactive manual #3342

pthom opened this issue Jul 7, 2020 · 6 comments
Labels

Comments

@pthom
Copy link
Contributor

pthom commented Jul 7, 2020

This is a follow to a suggestion that was initially posted in the gallery (part 11). It will be easier to exchange ideas in a separate issue, I think.


Inital post

ImGui Manual is an attempt to make an enjoyable and efficient manual for ImGui.

The idea is to use the reference code in imgui_demo.cpp in order to make an interactive manual.

Below is a screenshot:
image

But the best way to discover it is I to use it, since it is online:

click on this link to open it

The video below gives a quick (2 minutes) introduction:

video on youtube

This is a first implementation, and I am opened to suggestions and modifications if this manual is seen as interesting for the community.

@pthom
Copy link
Contributor Author

pthom commented Jul 7, 2020

I have had another idea, which is kinda related. I called it "instant develop", i.e provide newcomers with the possibility to test ImGui without having to install anything: no IDE, no text editor, no library, no compiler. With a simple browser, you can start right away.

You can see it here, on a separate repo.

@ocornut ocornut changed the title [Suggestion] ImGui interactive manual Interactive manual Jul 7, 2020
@ocornut ocornut added the doc label Jul 7, 2020
@pthom
Copy link
Contributor Author

pthom commented Jul 7, 2020

... I just found the existing discussion at #435 (which I had not read before). I hope my proposition can be made on par with what was discussed there.

@pthom
Copy link
Contributor Author

pthom commented Jul 19, 2020

Update: I have added some code navigation features :

Hierarchical index of the demos
image

Hierarchical index of imgui.h code sections
image

Those indexes are searchable.
Example: search for code sections related to docking
image

And you can search for more information about anything with a right click
image

A short demo video (1'40") of this features: https://www.youtube.com/watch?v=5jHilwGNSmA&feature=youtu.be

@moebiussurfing
Copy link

hey, thanks a lot for this. really helpful.
just in case it helps in some way:
here in windows and Chrome, copy paste (ctrl+c or gui button neither) doesn't work and I must jump to GitHub link.

@pthom
Copy link
Contributor Author

pthom commented Jul 20, 2020

hey, thanks a lot for this. really helpful.
just in case it helps in some way:
here in windows and Chrome, copy paste (ctrl+c or gui button neither) doesn't work and I must jump to GitHub link.

Thanks!

Concerning the copy-paste issue, it is a limitation of emscripten apps in a browser. Some workarounds might be possible, but more study is required.

If this is a serious issue for you, you can also build it on your computer:

git clone https://github.com/pthom/imgui_manual.git

Then follow these build instructions

@pthom
Copy link
Contributor Author

pthom commented Jul 28, 2020

@moebiussurfing : after the last update, you should now be able to copy text from the editor to the clipboard via Ctrl-C or via the Copy button.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants