ACF how to write - Revision history

John3-16: /* See also */ "Legacy ACF view patterns - web elements.lua – For historical reference only." Page was orphaned and is obsolete.

2026-01-03T04:19:13Z

See also: "Legacy ACF view patterns - web elements.lua – For historical reference only." Page was orphaned and is obsolete.

← Older revision		Revision as of 04:19, 3 January 2026
Line 229:		Line 229:

	=See Also=		=See Also=
	*[[Acf-core-0.15_Release_Notes]] - Separation between ACF functionality and web interface.		* [[Acf-core-0.15_Release_Notes]] - Separation between ACF functionality and web interface.
			* [[Web_elements.lua\|Legacy ACF view patterns - web elements.lua]] – For historical reference only.

	[[Category:ACF]]		[[Category:ACF]]

Sertonix: use https links

2023-08-07T11:19:10Z

use https links

← Older revision		Revision as of 11:19, 7 August 2023
Line 3:		Line 3:
	For some examples please see the Web Configuration Framework projects in the Alpine Linux git repository		For some examples please see the Web Configuration Framework projects in the Alpine Linux git repository

	~~http~~://git.alpinelinux.org/		https://git.alpinelinux.org/

	*acf-unbound - a simple ACF to control a service		*acf-unbound - a simple ACF to control a service
Line 13:		Line 13:

	===Step 1 - The Programming Language===		===Step 1 - The Programming Language===
	* ACF uses lua as its programming language. Have a look at [~~http~~://www.lua.org/ lua.org] before starting.		* ACF uses lua as its programming language. Have a look at [https://www.lua.org/ lua.org] before starting.

	===Step 2 - The Application Environment===		===Step 2 - The Application Environment===

Zcrayfish: Removed a hyperlink to a hypothetical URL.

2021-12-20T21:19:09Z

Removed a hyperlink to a hypothetical URL.

← Older revision		Revision as of 21:19, 20 December 2021
Line 199:		Line 199:
	Once you have completed all the above mentioned steps, go on with:		Once you have completed all the above mentioned steps, go on with:
	* sudo make install (this will install your app)		* sudo make install (this will install your app)
	* point your browser to https://ip-of-your-dev-host/		* point your browser to <nowiki>https://ip-of-your-dev-host/</nowiki>

	===More Info===		===More Info===

John3-16: Added See Also: Separation between ACF functionality and web interface.

2017-09-15T13:31:27Z

Added See Also: Separation between ACF functionality and web interface.

← Older revision		Revision as of 13:31, 15 September 2017
Line 228:		Line 228:
	Please see [[ACF_core_principles]] for further details on CFEs.		Please see [[ACF_core_principles]] for further details on CFEs.

			=See Also=
			*[[Acf-core-0.15_Release_Notes]] - Separation between ACF functionality and web interface.

	[[Category:ACF]]		[[Category:ACF]]

Fab: Reverted edits by RuthHughes (talk) to last revision by Ttrask

2016-03-07T12:30:31Z

Reverted edits by RuthHughes (talk) to last revision by Ttrask

← Older revision		Revision as of 12:30, 7 March 2016
Line 185:		Line 185:

	=====myapp.roles=====		=====myapp.roles=====
	This file determines which users have access to which controllers and views. A ~~separa~~ ... \n		This file determines which users have access to which controllers and views. A separate ''roles'' file is generally defined for each ACF. The format of the file is as follows:
			group=controller:action[,controller:action]
			Each line defines controller:action combinations that are permitted for a particular group. '''GUEST''' is a special group to which all users, including anonymous users, are members.

	== ~~private label cosmetics~~, ~~custom made cosmetic~~, ~~custom made cream, custom lip stick lip balm ==~~		=====myapp.menu=====
			In this file you define:
			* '''The Category''' in which a menu entry for your program will appear
			* '''The Group''' menu name under Category for this controller
			* '''The Tab''' name on the controller page
			* '''The Action''' with-in your controller that will be called once the user clicks on the menu entry or tab defined by Category, Group, and Tab.

	~~Offers private label cosmetics~~ with ~~custom design. We produce lip balms, serum, creams and more. Easy~~ to ~~buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm~~		===Step 7 - How To Get It Going?===
			Once you have completed all the above mentioned steps, go on with:
			* sudo make install (this will install your app)
			* point your browser to https://ip-of-your-dev-host/

	~~[[http://ultra-high-end~~.~~com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream~~, ~~custom lip stick lip balm]]~~		===More Info===
			====Where is the View?====
			The above example does not contain any code for a view. So, how is the action getting displayed?

	~~[[http~~:~~//ultra~~-~~high~~-~~end.com/custom-made~~.~~html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~		For every action that you define in myapp-controller.lua, you can define a separate view file named: myapp-''action''-html.lsp

	~~== private label cosmetics~~, ~~custom made cosmetic, custom made cream, custom lip stick lip balm ==~~		If there is no view file for a specific action, the application will look for a generic view file for the controller named: myapp-html.lsp

	~~Offers private label cosmetics with custom design~~. ~~We produce lip balms, serum~~, ~~creams~~ and ~~more. Easy~~ to ~~buy with eshop~~. ~~Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm~~		If that file does not exist, the ACF controller will attempt to display the 'CFE' using the built-in library functions. This works well for forms, and is what allows us to display our view here.

	~~[[http://ultra~~-~~high-end~~.~~com/custom-made~~.~~html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~		Here is a ''view'' file that displays our action using the built-in library functions. It looks exactly the same as when no view exists.

	~~[[http://ultra~~-~~high~~-~~end~~.~~com/custom-made.html private label cosmetics~~, ~~custom made cosmetic~~, ~~custom made cream~~, ~~custom lip stick lip balm]]~~		'''myapp-myaction-html.lsp:'''
			<%
			local form, viewlibrary, page_info, session = ...
			htmlviewfunctions = require("htmlviewfunctions")

			htmlviewfunctions.displayitem(form, page_info)
			%>

	~~== private label cosmetics~~, ~~custom made cosmetic~~, ~~custom made cream~~, ~~custom lip stick lip balm ==~~		The view receives the data to be displayed from the ''controller''. The view has access to the table returned by the controller action along with a helper library, a table of page information, and the session data ''(see the second line)''. The view can also load other libraries, but it should not directly access the ''controller'', ''model'', or any global variables.

	~~Offers private label cosmetics with custom design. We produce lip balms~~, ~~serum~~, ~~creams~~ and ~~more. Easy to buy with eshop~~. ~~Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm~~		====How to exchange data between model-view-controller?====
			To exchange data between model, view, and controller ACF uses ''Configuration Framework Entities (CFEs)''.

	[[~~http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm~~]]		Please see [[ACF_core_principles]] for further details on CFEs.

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==~~		[[Category:ACF]]

	Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

	[[~~http~~:~~//ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==~~

	Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm~~]]

RuthHughes: minor updates

2016-03-07T03:10:42Z

minor updates

← Older revision		Revision as of 03:10, 7 March 2016
Line 185:		Line 185:

	=====myapp.roles=====		=====myapp.roles=====
	This file determines which users have access to which controllers and views. A ~~separate ''roles'' file is generally defined for each ACF~~. ~~The format of the file is as follows:~~		This file determines which users have access to which controllers and views. A separa ... \n
	~~group=controller:action[,controller:action]~~
	~~Each line defines controller:action combinations that are permitted for a particular group~~. ~~'''GUEST''' is a special group to which all users, including anonymous users, are members~~.

	====~~=myapp.menu=====~~		== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==
	~~In this file you define:~~
	* '''The Category''' in which a menu entry for your program will appear
	* '''The Group''' menu name under Category for this controller
	* '''The Tab''' name on the controller page
	* '''The Action''' with-in your controller that will be called once the user clicks on the menu entry or tab defined by Category, Group, and Tab.

	~~===Step 7 - How To Get It Going?===~~		Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm
	~~Once you have completed all the above mentioned steps~~, ~~go on~~ with:
	* sudo make install (this will install your app)
	* point your browser to https://ip-of-your-dev-host/

	~~===More Info===~~		[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]
	~~====Where is the View?====~~
	~~The above example does not contain any code for a view~~. So, ~~how is the action getting displayed?~~

	~~For every action that you define in myapp~~-~~controller~~.~~lua, you can define a separate view file named: myapp-''action''~~-html~~.lsp~~		[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

	~~If there is no view file for a specific action~~, ~~the application will look for a generic view file for the controller named: myapp-html.lsp~~		== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

	~~If that file does not exist~~, ~~the ACF controller will attempt to display the 'CFE' using the built-in library functions. This works well for forms~~, and ~~is what allows us~~ to ~~display our view here~~.		Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

	~~Here is a ''view'' file that displays our action using the built~~-~~in library functions~~. ~~It looks exactly the same as when no view exists~~.		[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

	~~'''myapp~~-~~myaction~~-html~~.lsp:'''~~		[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]
	<%
	~~local form~~, ~~viewlibrary~~, ~~page_info, session = ...~~
	~~htmlviewfunctions = require("htmlviewfunctions")~~

	~~htmlviewfunctions.displayitem(form~~, ~~page_info)~~
	%>

	~~The view receives the data to be displayed from the ''controller''. The view has access to the table returned by the controller action along with a helper library~~, ~~a table of page information~~, ~~and the session data ''(see the second line)''. The view can also load other libraries~~, ~~but it should not directly access the ''controller'', ''model'', or any global variables.~~		== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

	~~====How to exchange data between model-view-controller?====~~		Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm
	~~To exchange data between model~~, ~~view~~, and ~~controller ACF uses ''Configuration Framework Entities (CFEs)''~~.

	~~Please see~~ [[~~ACF_core_principles~~]] ~~for further details on CFEs.~~		[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

	[[~~Category~~:~~ACF~~]]		== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

			Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

			Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

Ttrask: Update to latest style

2015-03-09T19:34:23Z

Update to latest style

Show changes

Ncopa at 04:43, 12 March 2012

2012-03-12T04:43:15Z

← Older revision		Revision as of 04:43, 12 March 2012
Line 1:		Line 1:
			{{Draft}}

	=How to Write an ACF <span style="color:red"> Under Construction</span> =		=How to Write an ACF <span style="color:red"> Under Construction</span> =

Ncopa: added to ACF category

2012-03-12T04:42:33Z

added to ACF category

← Older revision		Revision as of 04:42, 12 March 2012
Line 226:		Line 226:
	* sudo make install (this will install your app with the http server)		* sudo make install (this will install your app with the http server)
	* point your browser to http://ip-of-your-dev-host/		* point your browser to http://ip-of-your-dev-host/


			[[Category:ACF]]

Fab: /* Step 1 - The Programming Language */ link fixed

2011-06-17T06:55:44Z

Step 1 - The Programming Language: link fixed

← Older revision		Revision as of 06:55, 17 June 2011
Line 12:		Line 12:

	===Step 1 - The Programming Language===		===Step 1 - The Programming Language===
	* ACF uses lua as its programming language. Have a look at ~~lua.org~~ [http://www.lua.org/] before starting.		* ACF uses lua as its programming language. Have a look at [http://www.lua.org/ lua.org] before starting.

	===Step 2 - The Development Environment===		===Step 2 - The Development Environment===