ocornut/imgui

Interactive manual

pthom opened this issue · 6 comments

pthom commented

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 commented

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.

pthom commented

... 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 commented

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 commented

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 commented

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

  • 👍1
pthom commented

@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.

  • 👍2