Versions Compared

Old Version 1

changes.mady.by.user Scott Cantor

Saved on

compared with

New Version 2

changes.mady.by.user Scott Cantor

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For detailed information on the Velocity-related content of the views, see the VelocityVariables topic.

Look and Feel

TBDThe main purpose of the supplied templates is to define the necessary form submission / link interface contracts required for proper functionality of the various features. In some cases, the views render information from the IdP to the user (e.g., the Consent features) while in others they merely collect information from the user. Logout is the most complex case, and has a bit of both.

The actual look and feel of the views is not in general expected to meet anybody’s needs in particular. Deployers are not only encouraged but expected to change them fairly extensively in most cases. The goal of the installation process is to ensure that functionality is usable and can be tested or demonstrated before the work of aligning the look and feel to meet local expectations is done.

Note

Defaults aside, do NOT use the delivered style sheet or image filenames in production, and always adjust the relevant values in messages/messages.properties to reflect your own chosen names for these files (or replace the use of the properties entirely):

idp.css = /css/osu.css
idp.logo = /images/osu-logo.png

While the original style sheets and images will not be overwritten by upgrades, the properties that refer to them could have their default values changed, which could alter the appearance of your pages if you haven’t defined values for them yourself to supplant the system values.

Expand
titleV4.0 - V4.1

As in V3, the original V4 releases rely on the following conventions:

  • A couple of sample logos are installed to edit-webapp/images and one is referenced by default via the message property idp.logo

  • Most views link to edit-webapp/css/main.css explicitly. Two more CSS files are installed for specific use cases (consent.css and logout.css).

Expand
titleV4.2

V4.2 includes a new set of views with updated HTML and references to a new global stylesheet and (empty) placeholder logo. The HTML is intended to be more modern, mobile friendly, and hopefully improve accessibility.

  • A (new to V4.2) sample logo is installed to edit-webapp/images/placeholder.png and is referenced by default via the message property idp.logo

  • All views link to a style sheet defined in the idp.css property, which defaults to edit-webapp/css/placeholder.css

  • All views by default also import a new Velocity template in views/custom-styles.vm that redeclares a number of the styles while defining the various colors based on overrideable message properties. If you don’t need this, simply remove the #parse() command that processes this template from any/all of the views and it will reduce bloat.

Upgrades are meant to be safe, but prior to V4.2, the default CSS and logo files (which were strictly provided as examples) have been overwritten during upgrades. This should be corrected in V4.2, but please heed the caution box above: do NOT rely on the default filenames for your “final” configuration. Even if you make use of the provided CSS, copy it to a filename of your own and set the idp.css property to switch to it.