Difference between revisions of "PRS/WebStyle"
(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 wh...") |
|||
| Line 9: | Line 9: | ||
== How To Use == | == 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> | 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> | |||
Latest revision as of 07:41, 18 August 2022
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[edit | edit source]
Code[edit | edit source]
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[edit | edit source]
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[edit | edit source]
Once you have created a WebTemplate, you can pull in stylesheets through the WebDatabaseInterface class. Simply call WebDatabaseInterface.GetStylesheet(code), which returns an object of type WebStyle. This class has an attribute named Style, which contains the raw text from the WebStyle. Thus, to load and apply a style, put this markup in the <head> tag of your template:
<style> @(WebDatabaseInterface.GetStylesheet("EXAMPLE").Style) </style>
Loading Multiple Stylesheets[edit | edit source]
Since each call to GetStylesheet results in a request to the database, it can be beneficial to load multiple stylesheets at once. This is made possible with the GetStylesheets function, as demonstrated:
Dictionary<string, WebStyle> styles = WebDatabaseInterface.GetStylesheets("FIRST", "SECOND");
<style>
@(styles["FIRST"].Style)
@(styles["SECOND"].Style)
</style>