*Documentation

Writing and using plugins for Version 5 and above.
User avatar
Ron Melby
Superstar
Posts: 323
Joined: 15 Nov 2016 15:40
Family Historian: V6.2

Documentation

Postby Ron Melby » 05 Jun 2019 00:56

I see some smail bits of documentation of code here and there. and understanding I have spent my life in bigger iron and all this evironment is new to me...

What is the frontrunner or THEESTANDARD documentation tool in LUA, is it LDOC (I see a lot of @s) or some of the other many tools?
I see ColeValleyGirl does CHM files, is there a CHM editor that is the best, or how are they easily made?

Anyone really understand and use LUArocks? I see a lot of interesting (when talked about) code on github, but dont understand the packaging, and some of the most interesting looks schleckt. dont understand how to use it.

is there a code profiler for LUA thats pretty sharp?
FH V.6.2.7 Win 7 64 bit

User avatar
ColeValleyGirl
Megastar
Posts: 1089
Joined: 28 Dec 2005 22:02
Family Historian: V6.2
Location: Cirencester, Gloucestershire
Contact:

Re: Documentation

Postby ColeValleyGirl » 05 Jun 2019 07:28

I use CHM for User Documentation because I already have a very good (and very expensive) tool for creating them, and I'm pretty familiar with using it. I don't think I'd recommend it if you aren't already set up to do it.

Haven't tried ldoc so can't comment.

I've used Luarocks occasionally, to acquire install versions of useful libraries for personal use only -- can't include them in anything I make generally available, as they won't be easily available for other users. The documentation is rubbish until and unless the light dawns on a what is being described... So I don't make extensive use of it.

I don't use a profiler but would start looking for one here

User avatar
tatewise
Megastar
Posts: 15916
Joined: 25 May 2010 11:00
Family Historian: V6.2
Location: Torbay, Devon, UK
Contact:

Re: Documentation

Postby tatewise » 05 Jun 2019 08:28

For Lua Plugins intended for FH users, the documentation goes into the Knowledge Base > Family Historian Plugins under the End User Guide in Plugin Help and Advice for published Plugins, or Work In Progress Plugins under development, or later under the Developer Guide for Code Snippets useful in Plugins. But there are no tools used to produce those guides and are up to the author to edit as necessary.
Mike Tate ~ researching the Tate and Scott family history ~ tatewise ancestry

User avatar
ColeValleyGirl
Megastar
Posts: 1089
Joined: 28 Dec 2005 22:02
Family Historian: V6.2
Location: Cirencester, Gloucestershire
Contact:

Re: Documentation

Postby ColeValleyGirl » 05 Jun 2019 08:45

For Lua Plugins intended for FH users, the documentation goes into the Knowledge Base > Family Historian Plugins under the End User Guide in Plugin Help and Advice for published Plugins, or Work In Progress Plugins under development


This is of course not written in stone. My documentation goes in Help (CHM) files and/or dedicated pages in the Knowledge Base.


Return to “Plugin Discussions”

Who is online

Users browsing this forum: No registered users and 0 guests