DevOps:Doc/Open CSP/2.0/Class definition architecture - Revision history

81d56153-9868-4094-90a0-df1700ff7090: Text replacement - "{{Doc properties" to "{{Csp class properties"

2025-07-15T09:01:21Z

Text replacement - "{{Doc properties" to "{{Csp class properties"

ws-class-props
← Older revision		Revision as of 11:01, 15 July 2025
Line 1:		Line 1:
	{{~~Doc~~ properties		{{Csp class properties
	\|Subject version=2.0		\|Subject version=2.0
	\|Doc subject=DevOps:Doc/Open CSP		\|Doc subject=DevOps:Doc/Open CSP

Ebc16062-dd09-4928-8cf3-821f492b0c44 at 12:29, 31 October 2023

2023-10-31T12:29:15Z

← Older revision		Revision as of 14:29, 31 October 2023
Line 104:		Line 104:

	== The "Wiki" namespace ==		== The "Wiki" namespace ==
	Open CSP uses the Wiki namespace. Technically this is the standard Project namespace, which has been labeled "Wiki". This namespace is intended for technical pages for development or configuration of the wiki. It is not intended for users that only write or read content on the wiki. For example class definitions and the "Slots" page are in this namespace. The class definition architecture currently relies on the class definition pages having a specific pagetitle format, so you should not move these pages to different namespaces or modify ~~the title~~. If you want to restrict access to this namespace, that is possible by using an extension like ~~WikiGuard or~~ Lockdown.		Open CSP uses the Wiki namespace. Technically this is the standard Project namespace, which has been labeled "Wiki". This namespace is intended for technical pages for development or configuration of the wiki. It is not intended for users that only write or read content on the wiki. For example class definitions and the "Slots" page are in this namespace. The class definition architecture currently relies on the class definition pages having a specific pagetitle format, so you should not move these pages to different namespaces or modify their titles. If you want to restrict access to this namespace, that is possible by using an extension like Lockdown.

Ebc16062-dd09-4928-8cf3-821f492b0c44 at 12:17, 31 October 2023

2023-10-31T12:17:11Z

← Older revision		Revision as of 14:17, 31 October 2023
Line 102:		Line 102:
	* Parse component template (for example '''Template:Csp default sidebar''', unless a different template is found in the class definition data)		* Parse component template (for example '''Template:Csp default sidebar''', unless a different template is found in the class definition data)
	* Pass all of the slotdata from the current page as well as the class definition slotdata to this template, in the form of an ArrayFunctions export		* Pass all of the slotdata from the current page as well as the class definition slotdata to this template, in the form of an ArrayFunctions export

			== The "Wiki" namespace ==
			Open CSP uses the Wiki namespace. Technically this is the standard Project namespace, which has been labeled "Wiki". This namespace is intended for technical pages for development or configuration of the wiki. It is not intended for users that only write or read content on the wiki. For example class definitions and the "Slots" page are in this namespace. The class definition architecture currently relies on the class definition pages having a specific pagetitle format, so you should not move these pages to different namespaces or modify the title. If you want to restrict access to this namespace, that is possible by using an extension like WikiGuard or Lockdown.

Charlot: User:Charlot

2023-10-27T18:21:29Z

User:Charlot

ws-seo
← Older revision	Revision as of 20:21, 27 October 2023
Line 1:	Line 1:
		{{SEO
		\|Title=Open CSP Class definition architecture
		\|Keywords=OpenCSP,documentation,architecture
		\|Description=The pages architecture within Open CSP explained.
		\|Image=OCSP-Documentation.jpg
		\|Image alt=Open CSP Documentation Banner
		\|Section=Documention/Open_CSP
		\|Published time=2023-10-01
		}}

Ebc16062-dd09-4928-8cf3-821f492b0c44 at 12:57, 5 October 2023

2023-10-05T12:57:00Z

← Older revision		Revision as of 14:57, 5 October 2023
Line 99:		Line 99:
	* Get class definition pagename corresponding to the class		* Get class definition pagename corresponding to the class
	* Get slotdata from class definition page (return if it does not exist)		* Get slotdata from class definition page (return if it does not exist)
			* If the component is not found in the "Layout areas" parameter of the class definition page, return
	* Parse component template (for example '''Template:Csp default sidebar''', unless a different template is found in the class definition data)		* Parse component template (for example '''Template:Csp default sidebar''', unless a different template is found in the class definition data)
	* Pass all of the slotdata from the current page as well as the class definition slotdata to this template, in the form of an ArrayFunctions export		* Pass all of the slotdata from the current page as well as the class definition slotdata to this template, in the form of an ArrayFunctions export

Ebc16062-dd09-4928-8cf3-821f492b0c44 at 12:46, 5 October 2023

2023-10-05T12:46:25Z

← Older revision		Revision as of 14:46, 5 October 2023
Line 94:		Line 94:
	<br>Open CSP uses system messages inside these components. These system message contain some logic with various parser functions and Lua functions, in order to display a component based on the slot data of page as well as the slot data of the corresponding class definition page. This logic works as follows:		<br>Open CSP uses system messages inside these components. These system message contain some logic with various parser functions and Lua functions, in order to display a component based on the slot data of page as well as the slot data of the corresponding class definition page. This logic works as follows:

	* A component contains a system message that invokes a Lua function, for example <code><nowiki>{{#invoke:CspComponents\|parseComponentIfApplicable\|sidebar}}</nowiki></code>		* A component contains a system message that invokes a Lua function, for example <code><nowiki>{{#invoke:CspComponents\|parseComponentIfApplicable\|sidebar}}</nowiki></code>. This Lua function does the following:
	* This Lua function does the following:
	* Retrieve slotdata from current page		* Retrieve slotdata from current page
	* Get "Class" parameter from slotdata (return if it does not exist)		* Get "Class" parameter from slotdata (return if it does not exist)
Line 101:		Line 100:
	* Get slotdata from class definition page (return if it does not exist)		* Get slotdata from class definition page (return if it does not exist)
	* Parse component template (for example '''Template:Csp default sidebar''', unless a different template is found in the class definition data)		* Parse component template (for example '''Template:Csp default sidebar''', unless a different template is found in the class definition data)
	* ~~pass~~ all of the slotdata from the current page as well as the class definition slotdata to this template, in the form of an ArrayFunctions export		* Pass all of the slotdata from the current page as well as the class definition slotdata to this template, in the form of an ArrayFunctions export

Ebc16062-dd09-4928-8cf3-821f492b0c44: /* Components */

2023-10-05T12:44:54Z

Components

← Older revision		Revision as of 14:44, 5 October 2023
Line 92:		Line 92:
	* '''Footer''': by default not displayed, can be customized through class definitions		* '''Footer''': by default not displayed, can be customized through class definitions

	Open CSP uses system messages inside these components. These system message contain some logic with various parser functions and Lua functions, in order to display a component based on the slot data of page as well as the slot data of the corresponding class definition page. This logic works as follows:		<br>Open CSP uses system messages inside these components. These system message contain some logic with various parser functions and Lua functions, in order to display a component based on the slot data of page as well as the slot data of the corresponding class definition page. This logic works as follows:

	* A component contains a system message that invokes a Lua function, for example <code><nowiki>{{#invoke:CspComponents\|parseComponentIfApplicable\|sidebar}}</nowiki></code>		* A component contains a system message that invokes a Lua function, for example <code><nowiki>{{#invoke:CspComponents\|parseComponentIfApplicable\|sidebar}}</nowiki></code>

Ebc16062-dd09-4928-8cf3-821f492b0c44: /* Components */

2023-10-05T12:44:27Z

Components

← Older revision		Revision as of 14:44, 5 October 2023
Line 92:		Line 92:
	* '''Footer''': by default not displayed, can be customized through class definitions		* '''Footer''': by default not displayed, can be customized through class definitions

			Open CSP uses system messages inside these components. These system message contain some logic with various parser functions and Lua functions, in order to display a component based on the slot data of page as well as the slot data of the corresponding class definition page. This logic works as follows:

	~~Open CSP uses system messages inside these components. These~~ system message ~~contain some logic with various parser functions and~~ Lua ~~functions~~, ~~in order~~ to ~~display~~ a ~~component based on~~ the ~~slot~~ data of page as well as the ~~slot data of the corresponding~~ class definition ~~page.~~		* A component contains a system message that invokes a Lua function, for example <code><nowiki>{{#invoke:CspComponents\|parseComponentIfApplicable\|sidebar}}</nowiki></code>
			* This Lua function does the following:
			* Retrieve slotdata from current page
			* Get "Class" parameter from slotdata (return if it does not exist)
			* Get class definition pagename corresponding to the class
			* Get slotdata from class definition page (return if it does not exist)
			* Parse component template (for example '''Template:Csp default sidebar''', unless a different template is found in the class definition data)
			* pass all of the slotdata from the current page as well as the class definition slotdata to this template, in the form of an ArrayFunctions export

Ebc16062-dd09-4928-8cf3-821f492b0c44 at 12:37, 5 October 2023

2023-10-05T12:37:31Z

← Older revision		Revision as of 14:37, 5 October 2023
Line 88:		Line 88:
	* '''Header:''' always visible at the top of a page		* '''Header:''' always visible at the top of a page
	* '''Main''': this component displays the content that is stored in the main slot of a page, i.e. the text that is written by users		* '''Main''': this component displays the content that is stored in the main slot of a page, i.e. the text that is written by users
	* '''Sub-header''': by default shown below the header, can be customized through class definitions		* '''Sub-header''': by default shown below the header with '''Template:Csp default subheader''', can be customized through class definitions
	* '''Sidebar''': by default shown on right side, can be customized through class definitions, metadata is displayed in this component		* '''Sidebar''': by default shown on right side with '''Template:Csp default sidebar''', can be customized through class definitions, metadata is displayed in this component
	* '''Footer''': by default not displayed, can be customized through class definitions		* '''Footer''': by default not displayed, can be customized through class definitions


	Open CSP uses system messages inside these components. These system message contain some logic with various parser functions and Lua functions, in order to display a component based on the slot data of page as well as the slot data of the corresponding class definition page.		Open CSP uses system messages inside these components. These system message contain some logic with various parser functions and Lua functions, in order to display a component based on the slot data of page as well as the slot data of the corresponding class definition page.

Ebc16062-dd09-4928-8cf3-821f492b0c44 at 12:32, 5 October 2023

2023-10-05T12:32:13Z

@@ Line 34: / Line 34: @@
 === Example slots of a content page ===
 === Example slots of a class definition page ===
 == Components ==
 Open CSP uses the Chameleon skin to be able to display pages with customizable components. The following components are used:
-* Header
+* '''Header:''' always visible at the top of a page
-* Sub-header
+* '''Main''': this component displays the content that is stored in the main slot of a page, i.e. the text that is written by users
-* Sidebar
+* '''Sub-header''': by default shown below the header, can be customized through class definitions
-* Footer
+* '''Sidebar''': by default shown on right side, can be customized through class definitions, metadata is displayed in this component
-* Main
+* '''Footer''': by default not displayed, can be customized through class definitions
-Open CSP uses system messages inside these components. These system message contain wikitext with some logic through various parser functions and lua functions, in order to display a component that takes into account class definitions.
+Open CSP uses system messages inside these components. These system message contain some logic with various parser functions and Lua functions, in order to display a component based on the slot data of page as well as the slot data of the corresponding class definition page.