zirias (on snac) on Nostr: It just came to my mind that another thing should probably go on the V1.0 roadmap for ...
It just came to my mind that another thing should probably go on the V1.0 roadmap for #Xmoji: A #manpage. But then, this reminds me of doubts I had ever so often: #Documentation should have a single source of truth (otherwise it will go out of sync eventually).
I could just declare that's the manpage now, which would mean to remove everything I put there from the README.md. Not ideal though, this markdown file is accessible for direct reading on github (and would be on other "hosted git" solutions), while it's still well readable as plain text. This certainly isn't true for some roff-like markup. 😞 There's the additional problem of which markup flavor to choose: the modern mandoc (which is native on #FreeBSD), or the classic troff man macro package (which still seems "native" in #GNU's man-db)... Modern installations support both flavors, but conversions aren't "perfect".
There are also many "document generators" around that typically allow output as html, pdf, man, ... but I didn't find one so far that really gave satisfactory results for man. A while ago, I wrote my own tool which can generate #C source for "help" output, man (in both flavors) and html, and this worked pretty nicely, but the key was a very limited scope, it only supports a few sections (general description, options, environment variables) and only options in the classic #POSIX style (single letter, collapsible). So, it wouldn't fit the bill for Xmoji.
Great ideas anyone? 😁
I could just declare that's the manpage now, which would mean to remove everything I put there from the README.md. Not ideal though, this markdown file is accessible for direct reading on github (and would be on other "hosted git" solutions), while it's still well readable as plain text. This certainly isn't true for some roff-like markup. 😞 There's the additional problem of which markup flavor to choose: the modern mandoc (which is native on #FreeBSD), or the classic troff man macro package (which still seems "native" in #GNU's man-db)... Modern installations support both flavors, but conversions aren't "perfect".
There are also many "document generators" around that typically allow output as html, pdf, man, ... but I didn't find one so far that really gave satisfactory results for man. A while ago, I wrote my own tool which can generate #C source for "help" output, man (in both flavors) and html, and this worked pretty nicely, but the key was a very limited scope, it only supports a few sections (general description, options, environment variables) and only options in the classic #POSIX style (single letter, collapsible). So, it wouldn't fit the bill for Xmoji.
Great ideas anyone? 😁