I’d be interested in your feedback. Do you think this is something that is going in the right direction?
In the long run, I’d like to elaborate on the descriptions a little more. Compared to the previous version of the reference documentation, I have also included the commands documented in the gmic-community repository.
I am surprised about the gmic-community things. Still consider your “system” routines as a bit more important, hence I would recommend to put the user functions from gmic-community in one separate category, possibly still grouped by user and by already given subtitles.
Formally I would prefer the boxes more regular and not centered.
If the documentation generator could be used by the gmic-community users directly, I think documentation parts could be easier improved, corrected and extended.
Been waiting for a change. My ideal doc interface would be to have a search box with suggestions, and then another more traditional link or list view. E.g. when we press the / key in GIMP. It would search not only the name but also the description. Right now we are given #@cli comments only. Maybe a new tag for description or keywords would help because I sometimes included other details that won’t be relevant for search.
I know I try to be funny most of the time but I am not sure Funny One-Liners is a good category in name and purpose.
I agree. I really want a way to have more influence over the documentation. I mean play with it to see what works and doesn’t. It will be a way to move this forward because I have lots of ideas. Giving us some mobility would help us think through this problem together and improve the docs even more in the future.
A search field that helps filter out possibilities, searches and highlights in both function name and function content… and tolerates typographic mistakes thanks to levenshtein distance. Results would be command name + command description first letters.
Sphinx (the doc generator for gmic-py) does some JS-based indexing and searching without any database instance up and I have seen in the past JS-levenshtein matchers already… For Ctrl+F is OK but it does not search in descriptions and does not tolerate mistakes…
Here is a small tutorial on how to generate the new (WIP) reference pages, for testing.
This requires several steps. The instructions below should work for any Linux distribution, as well as MSYS2 for Windows users.
The CLI tool gmic of G’MIC is used to generate the pages, so make sure it is already installed and available from your executable PATH.
Clone the git repo of the G’MIC project and activate the develop branch.
$ cd gmic
$ git checkout develop
Go to the html folder, and create an empty test directory where all the generated files will be put.
$ cd gmic/html
$ mkdir test_ref
$ cd test_ref
Generate all the images for the reference documentation (beware, this takes some time!).
$ mkdir img
$ cd img # Go to 'gmic/html/test_ref/img/'
$ gmic up parse_cli images
Generate the HTML files of the documentation (one file per command).
$ cd .. # Go back to 'gmic/html/test_ref/'
$ gmic parse_cli html
Open your web browser, and go to URL : file://PATH_TO_GMIC/gmic/html/test_ref/categories.html.
You should be able then to browse the doc.
Note that this is still work in progress. Any feedback welcome. I’ve recently learnt how CSS works, and I’ve not used it a lot in the doc. This is gonna be improved in the future.
Finalize the structure of the HTML reference documentation, and put it on the website to replace the older one.
Do the same for the .pdf version (which means I have to write a parse_cli_latex command, quite a pain).
At this point, I’ll be able to remove the document_gmic command that won’t be used anymore.
Write a post about the difference between stylize and fx_stylize for @lesolorzanov.
Then I’ll be able to start writing more detailed stuffs about the commands in the reference documentation.
Note that these are priorities concerning G’MIC, but I have of course other things that are inserted into this list, about my research work, the management of my research team, things to do for home and kids (xmas presents…). Sometimes I feel G’MIC is eating too much of my time.
About the doc: I’ve been working on it intensively the last days, and I think the improvements are really great. G’MIC has now its own light Markdown syntax that is used in the reference documentation and command description. It’s not as complete as the reference markdown, but at least it is entirely managed by G’MIC itself, so I don’t need external dependencies to generate the G’MIC documentation.
Hopefully, I’ll share more news when it’s ready.