search

bastibe / org-journal

A simple org-mode based journaling mode
BSD 3-Clause "New" or "Revised" License
1.24k stars 123 forks source link

Texinfo documentation #313

Open DSMasterson opened 3 years ago

DSMasterson commented 3 years ago

Is your feature request related to a problem? Please describe. A clear and concise description of the problem.

Finding the org-journal documentation on Github is not the Emacs way. It would be easier if there was Info documentation to go with org-journal.

Describe the solution you'd like A clear and concise description of what you want to happen.

Since you already have a README.org for documentation, it should be easy to add a Makefile rule to export the Org file as a Texi file and, from that, generate the Info file with makeinfo . Then add a simple 'dir' file and wrap this into the package release for org-journal. I believe Emacs will do the rest when org-journal package is installed.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Didn't consider other approaches -- the above is very easy to do.

casch-at commented 3 years ago

Sounds good to me!

Thanks!

On December 12, 2020 9:17:14 PM UTC, David Masterson notifications@github.com wrote:

Is your feature request related to a problem? Please describe. A clear and concise description of the problem.

Finding the org-journal documentation on Github is not the Emacs way. It would be easier if there was Info documentation to go with org-journal.

Describe the solution you'd like A clear and concise description of what you want to happen.

Since you already have a README.org for documentation, it should be easy to add a Makefile rule to export the Org file as a Texi file and, from that, generate the Info file with makeinfo . Then add a simple 'dir' file and wrap this into the package release for org-journal. I believe Emacs will do the rest when org-journal package is installed.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Didn't consider other approaches -- the above is very easy to do.

-- Christian Schwarzgruber T: +43 699 194 166 34 E: c.schwarzgruber.cs@gmail.com

casch-at commented 3 years ago

Memo: Remove usage description in file header once the texinfo has been written, because we don't like to repeat ourself.

DSMasterson commented 3 years ago

You'll have to look up standards for package documentation (where it should be and what it shuld look like). I think there is an Info dile on writing packages in the Emacs release. Be careful what you remove or package-list-packages may not be able to find a description for org-journal.