Imgui: Interactive manual

Created on 7 Jul 2020  路  6Comments  路  Source: ocornut/imgui

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.

doc

Most helpful comment

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

All 6 comments

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.

... I just found the existing discussion at https://github.com/ocornut/imgui/issues/435 (which I had not read before). I hope my proposition can be made on par with what was discussed there.

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

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.

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

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

SlNPacifist picture SlNPacifist  路  3Comments

noche-x picture noche-x  路  3Comments

NPatch picture NPatch  路  3Comments

bizehao picture bizehao  路  3Comments

the-lay picture the-lay  路  3Comments