Lua Scripting
|
Edward Sneithe
I am trying to learn Lua and FH functions so I can write a plugin. Is there a reference manual that lists all the FH function that are available like fhMessageBoc.
I have looked but have not found such a document or website - yet. I've looked at the FH tutorial and everything worked but are there ones that go beyond the basic things? I have looked at these two websites os far along with the User group forums and Knowledgebase. https://www.family-historian.co.uk/help/fh7-plugins/tutorial/tutorial.htm https://www.family-historian.co.uk/help/fh7-plugins/ |
|
|
|
BillH <bhtemp99@...>
In FH go to Tools > Plugins.
toggle quoted message
Show quoted text
Click on the Help button in the Plugins Window. In the section titled "How to write you own plugins", click on "Family Historian Plugin Help". At the second paragraph click on "Family Historian API". At the bottom of the page click on "Understanding Data References". In the paragraph right after the yellow box labeled "Lua", click on "Function Index". You would think there would be an easier way to get to this list, but in my searches I couldn't find a way. Bill On Sun, Oct 16, 2022, at 05:04 PM,
Edward Sneithe via groups.io wrote:
I am trying to learn Lua and FH functions so I can write a plugin. Is there a reference manual that lists all the FH function that are available like fhMessageBoc. |
|
|
|
colevalleygirl@colevalleygirl.co.uk
The information is at that same site – see https://www.family-historian.co.uk/help/fh7-plugins/hh_start.htm#api/api.htm
From: family-historian@groups.io <family-historian@groups.io> On Behalf Of Edward Sneithe via groups.io
Sent: 17 October 2022 01:05 To: family-historian@groups.io Subject: [family-historian] Lua Scripting
I am trying to learn Lua and FH functions so I can write a plugin. Is there a reference manual that lists all the FH function that are available like fhMessageBoc. |
|
|
|
See the FHUG Knowledge Base section on Plugins and in particular Getting Started Writing Plugins: https://fhug.org.uk/kb/kb-article/getting-started-writing-plugins/ That not only cross-refers to those FH Help pages but also Lua User Guides and Libraries.
When you are editing a Plugin, the Help menu lists many useful references including the FH API functions and Lua Reference Manual.
|
|
|
|
Edward Sneithe
Mike
If I look at https://www.family-historian.co.uk/help/fh7-plugins/ there is a long list of functions preceded by fh which I assume means that they are FH specific. When I click on a particular function the link appears to be broken so I don't get any idea about the function, what parameters are used and what the function returns.. I was hoping to find a reference that would list the functions, what they do and perhaps how to use them. If I follow https://pluginstore.family-historian.co.uk/fhutils/files/fhUtils.html#comparestring I get more about some function but not the fh functions. It has been a long tine since i wrote any lines of code so I am very rusty. I'm just trying to learn how to use Lua in FH. Thanks for all the help I get form this group. |
|
|
|
colevalleygirl@colevalleygirl.co.uk
Edward,
Use the help file from within the FH plugin editor; I’ll report the bug in the online help.
Helen
From: family-historian@groups.io <family-historian@groups.io> On Behalf Of Edward Sneithe via groups.io
Sent: 17 October 2022 14:48 To: family-historian@groups.io Subject: Re: [family-historian] Lua Scripting
Mike |
|
|
|
colevalleygirl@colevalleygirl.co.uk
Alternatively, for the HTML version, click on Function Index within the API section and then on the links for each function you’ll find on that page..
From: colevalleygirl@... <Colevalleygirl@...>
Sent: 17 October 2022 15:00 To: 'family-historian@groups.io' <family-historian@groups.io> Subject: RE: [family-historian] Lua Scripting
Edward,
Use the help file from within the FH plugin editor; I’ll report the bug in the online help.
Helen
|
|
|
|
Edward Sneithe
Colevalleygirl Thank you that resolved the issue now I can find the info I want.
On Monday, October 17, 2022 at 10:02:41 AM EDT, colevalleygirl@... <colevalleygirl@...> wrote:
Alternatively, for the HTML version, click on Function Index within the API section and then on the links for each function you’ll find on that page..
From: colevalleygirl@... <Colevalleygirl@...>
Sent: 17 October 2022 15:00 To: 'family-historian@groups.io' <family-historian@groups.io> Subject: RE: [family-historian] Lua Scripting
Edward,
Use the help file from within the FH plugin editor; I’ll report the bug in the online help.
Helen
|
|
|
|
colevalleygirl@colevalleygirl.co.uk
The bug should now be fixed, if you want to try it.
From: colevalleygirl@... <Colevalleygirl@...>
Sent: 17 October 2022 15:00 To: 'family-historian@groups.io' <family-historian@groups.io> Subject: RE: [family-historian] Lua Scripting
Edward,
Use the help file from within the FH plugin editor; I’ll report the bug in the online help.
Helen
From: family-historian@groups.io <family-historian@groups.io> On Behalf Of Edward Sneithe via groups.io
Mike |
|
|
|
Edward Sneithe
Colevalleygirl, All fixed. Thank you. This group is so very responsive. One of the things that attracted me to FH.
On Tuesday, October 18, 2022 at 11:16:27 AM EDT, colevalleygirl@... <colevalleygirl@...> wrote:
The bug should now be fixed, if you want to try it.
From: colevalleygirl@... <Colevalleygirl@...>
Sent: 17 October 2022 15:00 To: 'family-historian@groups.io' <family-historian@groups.io> Subject: RE: [family-historian] Lua Scripting
Edward,
Use the help file from within the FH plugin editor; I’ll report the bug in the online help.
Helen
From: family-historian@groups.io <family-historian@groups.io> On Behalf Of Edward Sneithe via groups.io
Mike |
|
|