HaTeX icon indicating copy to clipboard operation
HaTeX copied to clipboard

Work on the Base.Command module documentation

Open Daniel-Diaz opened this issue 11 years ago • 3 comments

Currently, the Base.Commands module lacks documentation for a bit more than a half of its bindings, and the description of some of them is quite vague. While it may be expected for the user of HaTeX to know some LaTeX, it would be more convenient if the information about the different commands can be found in-place, as in the rest of modules. The only difference is that this module is certainly bigger.

Daniel-Diaz avatar Sep 09 '13 21:09 Daniel-Diaz

I was just thinking it would be great to have links from the function to some authoritative LaTeX documentation - for example lnbk could point to http://svn.gna.org/viewcvs/checkout/latexrefman/trunk/latex2e.html#g_t_005c_005c. I'm just not sure what the authoritative source of LaTeX documentation is on the web, though this one looks pretty good.

Though those really don't look like permalinks.

Proposed format here: https://github.com/seereason/HaTeX/commit/bb89eb8183cbe94a5774b71f019cfb5af5495a92

ddssff avatar Sep 14 '14 14:09 ddssff

Definitely, this is better than nothing. Would it be too much work to just copy the content of the links? That would solve the link permanency problem, and the user would not have to switch pages when navigating the docs.

Thanks for your collaboration, Daniel Díaz.

Daniel-Diaz avatar Sep 17 '14 02:09 Daniel-Diaz

It could probably be made easy enough. I don't love making copies of things, but maybe it is best.

ddssff avatar Sep 18 '14 15:09 ddssff