Commit 7419ad70 authored by haemmer's avatar haemmer
Browse files

Made descriptions of options more consistent

parent 124ab4a4
...@@ -95,14 +95,14 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome" ...@@ -95,14 +95,14 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
// Most used Identity Providers will be shown as top category in the drop down // Most used Identity Providers will be shown as top category in the drop down
// list if this feature is used. // list if this feature is used.
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_most_used_idps = new Array("https://aai-logon.unibas.ch/idp/shibboleth", "https://aai.unil.ch/idp/shibboleth"); // var wayf_most_used_idps = new Array("https://aai-logon.unibas.ch/idp/shibboleth", "https://aai.unil.ch/idp/shibboleth");
// Categories of Identity Provider that should not be shown // Categories of Identity Provider that should not be shown
// Possible values are: <?php echo $types ?>, "all" // Possible values are: <?php echo $types ?>, "all"
// Example of how to hide categories // Example of how to hide categories
// var wayf_hide_categories = new Array("other", "library"); // var wayf_hide_categories = new Array("other", "library");
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_hide_categories = new Array(); // var wayf_hide_categories = new Array();
// EntityIDs of Identity Provider whose category is hidden but that should be shown anyway // EntityIDs of Identity Provider whose category is hidden but that should be shown anyway
...@@ -110,29 +110,32 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome" ...@@ -110,29 +110,32 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
// otherwise, unhidden IdPs may be displayed in the wrong category // otherwise, unhidden IdPs may be displayed in the wrong category
// Example of how to unhide certain Identity Providers // Example of how to unhide certain Identity Providers
// var wayf_unhide_idps = new Array("https://aai-login.uzh.ch/idp/shibboleth"); // var wayf_unhide_idps = new Array("https://aai-login.uzh.ch/idp/shibboleth");
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_unhide_idps = new Array(); // var wayf_unhide_idps = new Array();
// EntityIDs of Identity Provider that should not be shown at all // EntityIDs of Identity Provider that should not be shown at all
// Example of how to hide certain Identity Provider // Example of how to hide certain Identity Provider
// var wayf_hide_idps = new Array("https://idp.unige.ch/idp/shibboleth", "https://aai-logon.switch.ch/idp/shibboleth"); // var wayf_hide_idps = new Array("https://idp.unige.ch/idp/shibboleth", "https://aai-logon.switch.ch/idp/shibboleth");
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_hide_idps = new Array(); // var wayf_hide_idps = new Array();
//////////////////// ADVANCED SETTINGS //////////////////// //////////////////// ADVANCED SETTINGS ////////////////////
// Use the SAML2/Shibboleth 2 Discovery Service protocol where // [Experimental Feature] Use the SAML2/Shibboleth 2 Discovery Service protocol where
// the user is sent back to the Service Provider after selection // the user is sent back to the Service Provider after selection
// of his Home Organisation. // of his Home Organisation.
// This is true by default and it should only be uncommented and set to false // This feature should only be uncommented and set to false if there
// if there is a good reason why to use the old and deprecated Shibboleth WAYF // is a good reason why to use the old and deprecated Shibboleth WAYF
// protocol instead. // protocol instead.
// [Optional, default: commented out] // [Optional, default: true]
// var wayf_use_discovery_service = false; // var wayf_use_discovery_service = false;
// If enabled, the Embedded WAYF uses the improved drop down list feature // [Experimental Feature] If enabled, the Embedded WAYF will activate the
// will transform the list of organisations into a search-field while keeping // improved drop down list feature, which will transform the list of
// its original list character. // organisations into a search-field while keeping its original function as
// a select list. To make this work, the JQuery library will dynamically be
// loaded if it is not yet present. Additionally, another Javascript and CSS
// file are loaded to perform the actual transformation.
// [Optional, default: false] // [Optional, default: false]
// var wayf_use_improved_drop_down_list = false // var wayf_use_improved_drop_down_list = false
...@@ -143,7 +146,7 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome" ...@@ -143,7 +146,7 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
// WARNING: Only use this feature if you know exactly what you are doing // WARNING: Only use this feature if you know exactly what you are doing
// This option will cause problems that are difficult to find // This option will cause problems that are difficult to find
// in case they accidentially select a wrong Home Organisation // in case they accidentially select a wrong Home Organisation
// [Optional, false] // [Optional, dfeault: false]
//var wayf_force_remember_for_session = false; //var wayf_force_remember_for_session = false;
// Session Initiator URL of the Service Provider // Session Initiator URL of the Service Provider
...@@ -152,37 +155,37 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome" ...@@ -152,37 +155,37 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
// or will be set automatically if the page where the Embedded WAYF is placed is called // or will be set automatically if the page where the Embedded WAYF is placed is called
// with a 'return' and an 'entityID' GET Arguments // with a 'return' and an 'entityID' GET Arguments
// [Optional, if wayf_use_discovery_service = true // [Optional, if wayf_use_discovery_service = true
// or if wayf_additional_idps is not empty, default: commented out] // or if wayf_additional_idps is not empty, default: wayf_sp_handlerURL + "/Login"]
// var wayf_sp_samlDSURL = wayf_sp_handlerURL + "/Login"; // var wayf_sp_samlDSURL = wayf_sp_handlerURL + "/Login";
// Default IdP to preselect when central WAYF couldn't guess IdP either // Default IdP to preselect when central WAYF couldn't guess IdP either
// This is usually the case the first time ever a user accesses a resource // This is usually the case the first time ever a user accesses a resource
// [Optional, default: commented out] // [Optional, default: none]
// var wayf_default_idp = "https://aai-logon.switch.ch/idp/shibboleth"; // var wayf_default_idp = "https://aai-logon.switch.ch/idp/shibboleth";
// Set a custom Assertion Consumer URL instead of // Set a custom Assertion Consumer URL instead of
// the default wayf_sp_handlerURL + '/SAML/POST' // the default wayf_sp_handlerURL + '/SAML/POST'
// Only relevant if wayf_use_discovery_service is false // Only relevant if wayf_use_discovery_service is false and SAML1 is used.
// Examples: "https://my-app.switch.ch/custom/saml-implementation/samlaa" // Examples: "https://my-app.switch.ch/custom/saml-implementation/samlaa"
// This will implicitely be set to wayf_sp_samlACURL = wayf_sp_handlerURL + "/SAML/POST"; // This will implicitely be set to wayf_sp_samlACURL = wayf_sp_handlerURL + "/SAML/POST";
// [Optional, commented out by default] // [Optional, default: wayf_sp_handlerURL + "/SAML/POST"]
// var wayf_sp_samlACURL = "https://my-app.switch.ch/custom/saml-implementation/samlaa"; // var wayf_sp_samlACURL = "https://my-app.switch.ch/custom/saml-implementation/samlaa";
// Overwites the text of the checkbox if // Overwites the text of the checkbox if
// wayf_show_remember_checkbox is set to true // wayf_show_remember_checkbox is set to true
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_overwrite_checkbox_label_text = 'Save setting for today'; // var wayf_overwrite_checkbox_label_text = 'Save setting for today';
// Overwrites the text of the submit button // Overwrites the text of the submit button
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_overwrite_submit_button_text = 'Go'; // var wayf_overwrite_submit_button_text = 'Go';
// Overwrites the intro text above the drop-down list // Overwrites the intro text above the drop-down list
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_overwrite_intro_text = 'Select your Home Organisation to log in'; // var wayf_overwrite_intro_text = 'Select your Home Organisation to log in';
// Overwrites the category name of the most used IdP category in the drop-down list // Overwrites the category name of the most used IdP category in the drop-down list
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_overwrite_most_used_idps_text = 'Most popular'; // var wayf_overwrite_most_used_idps_text = 'Most popular';
...@@ -191,16 +194,16 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome" ...@@ -191,16 +194,16 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
// could be authenticated // could be authenticated
// If you want to hide the embedded WAYF completely, uncomment // If you want to hide the embedded WAYF completely, uncomment
// the property and set it to "". This then won't draw anything // the property and set it to "". This then won't draw anything
// [Optional, default commented out: You are already logged in] // [Optional, default: none]
// var wayf_logged_in_messsage = ""; // var wayf_logged_in_messsage = "";
// Provide the name of a JavaScript function that checks whether the user // Provide the name of a JavaScript function that checks whether the user
// already is logged in. The function should return true if the user is logged // already is logged in. The function should return true if the user is logged
// in or false otherwise. If the user is logged in, the Embedded WAYF will // in or false otherwise. If the user is logged in, the Embedded WAYF will
// hide itself or draw a custom message depending on the // hide itself or draw a custom message depending on the
// setting wayf_logged_in_messsage // setting wayf_logged_in_messsage. The default check will access a Shibboleth
// The function you specify has of course to be implemented by yourself! // session handler which typically is found at /Shibboleth.sso/Session.
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_check_login_state_function = function() { // var wayf_check_login_state_function = function() {
// if (# specify user-is-logged-in condition#) // if (# specify user-is-logged-in condition#)
// return true; // return true;
...@@ -222,7 +225,7 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome" ...@@ -222,7 +225,7 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
// organisation. Basically, anything the user could use to search his institution. // organisation. Basically, anything the user could use to search his institution.
// //
// The IdPs will be displayed in the order they are defined // The IdPs will be displayed in the order they are defined
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_additional_idps = [ ]; // var wayf_additional_idps = [ ];
// Example of how to add Identity Provider from other federations // Example of how to add Identity Provider from other federations
...@@ -251,11 +254,11 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome" ...@@ -251,11 +254,11 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
// The list wayf_additional_idps will be sorted alphabetically // The list wayf_additional_idps will be sorted alphabetically
// The SP must have configured the discovery feed handler that generates a // The SP must have configured the discovery feed handler that generates a
// JSON object. Otherwise it won't generate the JSON data containing the IdPs. // JSON object. Otherwise it won't generate the JSON data containing the IdPs.
// [Optional, commented out by default] // [Optional, default: false]
// var wayf_use_disco_feed = true; // var wayf_use_disco_feed = false;
// URL where to load the Discovery Feed from in case wayf_use_disco_feed is true // URL where to load the Discovery Feed from in case wayf_use_disco_feed is true
// [Optional, commented out by default] // [Optional, default: none]
// var wayf_discofeed_url = "/Shibboleth.sso/DiscoFeed"; // var wayf_discofeed_url = "/Shibboleth.sso/DiscoFeed";
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment