Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is an offline-copy of the documentation available? #8

Closed
rochus-keller opened this issue Jan 13, 2022 · 4 comments
Closed

Is an offline-copy of the documentation available? #8

rochus-keller opened this issue Jan 13, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation work-in-progress We are working on this issue

Comments

@rochus-keller
Copy link

E.g. in HTML or PDF format? Not critical, but would be useful.

@frang75
Copy link
Owner

frang75 commented Jan 13, 2022

Hi @rochus-keller!

Yes its possible. I use ndoc (my own doc generator) for NAppGUI. It create two outputs.

  • HTML: Website format. A webserver is not required. Yo can browse the same web in local. Here you have the entire site. https://nappgui.com/doc/nappgui_html.zip. I can mantain this link (1 at month more or less)

  • LaTeX/PDF. I don't have this update (but I can do for next version). Here you can download an out-of-date copy. https://nappgui.com/doc/nappgui_en.pdf. ndoc offers several eBook posibilities:

    • User Guide format (not Function Reference).
    • User Guide + Function Reference (at the end of the book).
    • User Guide + Function Reference (mixed in chapters).
    • Full (+ demo applications).

@rochus-keller
Copy link
Author

Thank you very much; once more impressive work! The PDF is exactly what I was looking for, also a local copy of the navigable HTML API ref is very useful. I'm currently trying to migrate the Bode app to Oberon+ and in parallel extend the language and compiler if need be.

@frang75
Copy link
Owner

frang75 commented Mar 11, 2022

@rochus-keller
I'm still working on creating DLLs and also:

  • Make a full review the non-public headers (inl) since I took certain licenses when dealing with static libraries.
  • Upgrade the ebook
  • Improve the build system to create user-projects DLLs
  • Generate new doc chapter about DLLs

@frang75 frang75 self-assigned this Mar 19, 2022
@frang75 frang75 added documentation Improvements or additions to documentation work-in-progress We are working on this issue labels Mar 19, 2022
@frang75
Copy link
Owner

frang75 commented Dec 26, 2022

PDF Ebook version of documentation has been updated in NAppGUI 1.3

https://nappgui.com/ebook/ndoc_en.pdf

@frang75 frang75 closed this as completed Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation work-in-progress We are working on this issue
Projects
None yet
Development

No branches or pull requests

2 participants