Web Template - Revision history

Kenric: /* Visible */

2022-12-16T02:13:32Z

Visible

← Older revision		Revision as of 02:13, 16 December 2022
Line 23:		Line 23:
	===Visible===		===Visible===

	The Visible field denotes whether the page is accessibly via a URL - if it is not visible, then a 404 Not Found is returned when trying to access it - it is as if it didn't exist. Use this if you want to disable a page or if the template is only relevant in the context of other templates - see [[Partial%20Templates\|Partial Templates]]		The Visible field denotes whether the page is accessibly via a URL - if it is not visible, then a 404 Not Found is returned when trying to access it - it is as if it didn't exist. Use this if you want to disable a page or if the template is only relevant in the context of other templates - see [[#Partial%20Templates\|Partial Templates]]

	=== Root URL ===		=== Root URL ===

Kenric: /* Visible */

2022-12-16T02:13:24Z

Visible

← Older revision		Revision as of 02:13, 16 December 2022
Line 23:		Line 23:
	===Visible===		===Visible===

	The Visible field denotes whether the page is accessibly via a URL - if it is not visible, then a 404 Not Found is returned when trying to access it - it is as if it didn't exist. Use this if you want to disable a page or if the template is only relevant in the context of other templates - see [[~~WebTemplate#~~Partial%20Templates\|Partial Templates]]		The Visible field denotes whether the page is accessibly via a URL - if it is not visible, then a 404 Not Found is returned when trying to access it - it is as if it didn't exist. Use this if you want to disable a page or if the template is only relevant in the context of other templates - see [[Partial%20Templates\|Partial Templates]]

	=== Root URL ===		=== Root URL ===

Kenric at 02:13, 16 December 2022

2022-12-16T02:13:04Z

← Older revision		Revision as of 02:13, 16 December 2022
Line 23:		Line 23:
	===Visible===		===Visible===

	The Visible field denotes whether the page is accessibly via a URL - if it is not visible, then a 404 Not Found is returned when trying to access it - it is as if it didn't exist. Use this if you want to disable a page or if the template is only relevant in the context of other templates - see [[~~PRS/~~WebTemplate#Partial%20Templates\|Partial Templates]]		The Visible field denotes whether the page is accessibly via a URL - if it is not visible, then a 404 Not Found is returned when trying to access it - it is as if it didn't exist. Use this if you want to disable a page or if the template is only relevant in the context of other templates - see [[WebTemplate#Partial%20Templates\|Partial Templates]]

	=== Root URL ===		=== Root URL ===

Kenric: /* Fields */

2022-12-16T02:12:10Z

Fields

← Older revision		Revision as of 02:12, 16 December 2022
Line 2:		Line 2:
	Web Templates are the manner in which the Web Engine interfaces with a user, written in HTML with C# support using the Razor templating engine. Upon receiving a request from a user, the WebEngine finds the template that is required and then executes it, recompiling if changes have been made.		Web Templates are the manner in which the Web Engine interfaces with a user, written in HTML with C# support using the Razor templating engine. Upon receiving a request from a user, the WebEngine finds the template that is required and then executes it, recompiling if changes have been made.
	==Fields==		==Fields==

	===DataModel===		===DataModel===

	The DataModel field is a name of an entity type, such as Equipment or Employee, which specifies the specific data to load for the page template. For example, if you are writing a page which lists employees, it is useful to preload the data necessary - this is done by setting DataModel to "Employee". This field is optional.		The DataModel field is a name of an entity type, such as Equipment or Employee, which specifies the specific data to load for the page template. For example, if you are writing a page which lists employees, it is useful to preload the data necessary - this is done by setting DataModel to "Employee". This field is optional.

	===Slug ===		===Slug ===

	The Slug field denotes the name of the page itself, intended to be a short text field which describes the function of the page. Note that it cannot contain any slashes ('/', '\'), and should use only characters which are URL-safe; when in doubt, stick to just numbers and letters.		The Slug field denotes the name of the page itself, intended to be a short text field which describes the function of the page. Note that it cannot contain any slashes ('/', '\'), and should use only characters which are URL-safe; when in doubt, stick to just numbers and letters.

	The DataModel and slug fields combine to form a path to the page, with the form ''www.domain.com/v1/DataModel/Slug?id=XXXXXXXX-XXXX-XXXX-XXXXXXXX''. If the DataModel field is empty, then the URL is simply ''www.domain.com/v1/Slug''. This allows you to create pages which do not have to be tied to a specific entity. If a page has a DataModel and the id query does not match any page, then a 404 Not Found is returned to the user.		The DataModel and slug fields combine to form a path to the page, with the form ''www.domain.com/v1/DataModel/Slug?id=XXXXXXXX-XXXX-XXXX-XXXXXXXX''. If the DataModel field is empty, then the URL is simply ''www.domain.com/v1/Slug''. This allows you to create pages which do not have to be tied to a specific entity. If a page has a DataModel and the id query does not match any page, then a 404 Not Found is returned to the user.
	===Description===
			=== Description ===

	The Description field is a non-functional field which allows you to add a description to the template - this is not necessary, but can be useful as a reference.		The Description field is a non-functional field which allows you to add a description to the template - this is not necessary, but can be useful as a reference.

			=== Template ===

			The source code for the template, which is in the Razor syntax - a mix of C# and HTML.

	===Visible===		===Visible===

	The Visible field denotes whether the page is accessibly via a URL - if it is not visible, then a 404 Not Found is returned when trying to access it - it is as if it didn't exist. Use this if you want to disable a page or if the template is only relevant in the context of other templates - see [[PRS/WebTemplate#Partial%20Templates\|Partial Templates]]		The Visible field denotes whether the page is accessibly via a URL - if it is not visible, then a 404 Not Found is returned when trying to access it - it is as if it didn't exist. Use this if you want to disable a page or if the template is only relevant in the context of other templates - see [[PRS/WebTemplate#Partial%20Templates\|Partial Templates]]

			=== Root URL ===

			This field is default to false. It defines whether the URL of the page is a root URL, or whether it is prefixed by "v1/" (The default is the prefix). We have the prefix so that we can add our own endpoints to the Web Engine, such as the "/login" endpoint, without clashing with any endpoints that you have created. However, if you do want to remove the prefix, untick this box. In order to allow you to choose a URL which is guaranteed to never clash with our own endpoints, you can start your [[#Slug\|slug]] with a capital letter - we reserve all lowercase letter slugs that are not prefixed with "v1/".

			Tick this box at your own risk, since if we add an endpoint in future that has the same name as a page you have added, your page will effectively become inaccessible.

	==Writing a Template==		==Writing a Template==

Prs at 23:24, 18 October 2022

2022-10-18T23:24:26Z

@@ Line 1: / Line 1: @@
-WebStyles are closely associated with WebTemplates, providing a means by which one can apply stylesheets to their pages. Using this system allows for a consistent styling across pages (or a subset of pages), since they would all speak to a certain WebStyle. Note also that despite being intended for CSS styling, they can contain any data, meaning the system could be used for other types of documents.
+The first parameter, <code>requiredTables</code>, specifies which tables should be loaded. By default, <code>LoadModel</code> loads nothing. In general, the CompanyInformation, CompanyLogo and the current entity are useful to load, so a call could look like:
-==Fields==
+<code>Model.LoadModel(new string[] {"CompanyInformation", "CompanyLogo", "Employee"})</code>.
-===Code===
-The Code field is the unique identifier by which a given WebStyle is accessed. This should be somewhat descriptive, since it must be referenced via other pages, but it is recommended to keep it short and sweet.
+The second parameter specifies a way to narrow the load of the data, preventing unnecessary data from being loaded. For example, if one only requires the ID and Name fields of an employee, one might call:<pre>
-===Description===
+Model.LoadModel(
-An arbitrary field by which one can give a description for the WebStyle. It is non-functional, but provides a reference on top of the code for humans to identify the purpose or contents of the WebStyle.
+    new string[] {"CompanyInformation", "CompanyLogo", "Employee"},
-==How To Use==
+    new DataModelQueryDef<Employee>(
-Once you have created a [[PRS/WebTemplate|WebTemplate]], you can pull in stylesheets through the WebDatabaseInterface class. Simply call <code>WebDatabaseInterface.GetStylesheet(code)</code>, which returns an object of type <code>WebStyle</code>. This class has an attribute named <code>Style</code>, which contains the raw text from the WebStyle. Thus, to load and apply a style, put this markup in the <code><head></code> tag of your template:<pre>
+        null,
-<style> @(WebDatabaseInterface.GetStylesheet("EXAMPLE").Style) </style>
+        new Columns<Employee>(x => x.ID).Add(x => x.Name),
 </pre>
-===Loading Multiple Stylesheets===
-Since each call to <code>GetStylesheet</code> results in a request to the database, it can be beneficial to load multiple stylesheets at once. This is made possible with the <code>GetStylesheets</code> function, as demonstrated:<pre>
-Dictionary<string, WebStyle> styles = WebDatabaseInterface.GetStylesheets("FIRST", "SECOND");
+By default, all columns in the database are loaded, so this is a way to drastically reduce the amount of data loaded. (The other two fields, set to <code>null</code>, specify a filter and sort order for the retrieved data.)
-<style>
+====Retrieving Data====
-@(styles["FIRST"].Style)
+To get a table that has been loaded, use <code>Model.GetTable<T>(alias)</code>. This returns an object of type <code>CoreTable</code>, which has a property <code>Rows</code>, through which one can retrieve data. An example is shown here.<pre>
-@(styles["SECOND"].Style)
+Model.LoadModel(new string[] {"Employee"}); // Load Model
-</style>
+CoreTable employeeTable = Model.GetTable<Employee>(); // Get Table from Model
 </pre>

Prs: Created page with " WebStyles are closely associated with WebTemplates, providing a means by which one can apply stylesheets to their pages. Using this system allows for a consistent styling across pages (or a subset of pages), since they would all speak to a certain WebStyle. Note also that despite being intended for CSS styling, they can contain any data, meaning the system could be used for other types of documents. ==Fields== ===Code=== The Code field is the unique identifier by whic..."

2022-10-18T23:15:09Z

Created page with " WebStyles are closely associated with WebTemplates, providing a means by which one can apply stylesheets to their pages. Using this system allows for a consistent styling across pages (or a subset of pages), since they would all speak to a certain WebStyle. Note also that despite being intended for CSS styling, they can contain any data, meaning the system could be used for other types of documents. ==Fields== ===Code=== The Code field is the unique identifier by whic..."

New page

WebStyles are closely associated with WebTemplates, providing a means by which one can apply stylesheets to their pages. Using this system allows for a consistent styling across pages (or a subset of pages), since they would all speak to a certain WebStyle. Note also that despite being intended for CSS styling, they can contain any data, meaning the system could be used for other types of documents.

==Fields==
===Code===
The Code field is the unique identifier by which a given WebStyle is accessed. This should be somewhat descriptive, since it must be referenced via other pages, but it is recommended to keep it short and sweet.
===Description===
An arbitrary field by which one can give a description for the WebStyle. It is non-functional, but provides a reference on top of the code for humans to identify the purpose or contents of the WebStyle.
==How To Use==
Once you have created a [[PRS/WebTemplate|WebTemplate]], you can pull in stylesheets through the WebDatabaseInterface class. Simply call <code>WebDatabaseInterface.GetStylesheet(code)</code>, which returns an object of type <code>WebStyle</code>. This class has an attribute named <code>Style</code>, which contains the raw text from the WebStyle. Thus, to load and apply a style, put this markup in the <code><head></code> tag of your template:<pre>
<style> @(WebDatabaseInterface.GetStylesheet("EXAMPLE").Style) </style>
</pre>
===Loading Multiple Stylesheets===
Since each call to <code>GetStylesheet</code> results in a request to the database, it can be beneficial to load multiple stylesheets at once. This is made possible with the <code>GetStylesheets</code> function, as demonstrated:<pre>
Dictionary<string, WebStyle> styles = WebDatabaseInterface.GetStylesheets("FIRST", "SECOND");
<style>
@(styles["FIRST"].Style)
@(styles["SECOND"].Style)
</style>
</pre>