Hi All, Now that the website documentation is fully functioning on automatic builds, the old documentation methods have been reviewed and rationalised.
Some quite extensive changes have been made to how manual pages for components, utilities, GUI's and API's are rendered and how they are available to users. In common with all other documentation, manual pages have been converted to .asciidoc which enables easy conversion to .html .pdf or most other desired formats. More importantly, asciidoc is so close to markdown or even plain text, that it is easily edited without mastering the arcane formatting rules of troff, the old format for the pages. Hopefully this will encourage creation of new docs and editing of existing ones by the general user base. Removal of the manual page builds and storage of the pages, also makes the basic Machinekit footprint lighter. *The first port of call for manual pages (and all documentation) should be the website.* >From the right hand side bar - which is visible from anywhere in the 'Documentation' section, select either http://www.machinekit.io/docs/man/man1/ For information on utilities and GUIs http://www.machinekit.io/docs/man/man3/ For information on the hal and rtapi APIs http://www.machinekit.io/docs/man/man9/ For information on components and drivers *To cater for viewing locally, a second option is available*A Package called *'machinekit-manual-pages*' is now automatically created as part of the website build process. This is available from deb.machinekit.io as per any other package. The manual pages will then be available at /usr/share/doc/machinekit/man You can display the pages easily with the asciidoctor plugin for firefox https://addons.mozilla.org/en-GB/firefox/addon/asciidoctorjs-live-preview/ or for chrome https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia?hl=en Alternately, for a terminal display of manual pages, Machinekit now contains a script called *mank*. Invoking *mank debounce *for instance, will display the manual page for the component debounce mank uses asciidoctor and elinks and will prompt for their installation if not present. They were not made dependencies of the machinekit package deliberately, as the overwhelming majority of users are likely to simply use the web site and never install the local manual pages, or if they do, use the browser plugin. (NB If you are a developer and use the --view-doc option to (inst)comp, you will need asciidoctor and elinks for that to operate.) -- website: http://www.machinekit.io blog: http://blog.machinekit.io github: https://github.com/machinekit --- You received this message because you are subscribed to the Google Groups "Machinekit" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. Visit this group at https://groups.google.com/group/machinekit. For more options, visit https://groups.google.com/d/optout.
