Various textual improvements and furhter explanations

default-embedded-wayf.php

@@ -32,10 +32,16 @@ var wayf_return_url = "https://my-app.switch.ch/aai/index.php?page=show_welcome"
 //////////////////// RECOMMENDED SETTINGS ////////////////////
 
 // Width of the embedded WAYF in pixels or "auto"
+// This is the width of the content only (without padding and border). 
+// Add 2 x (10px + 1px) = 22px for padding and border to get the actual 
+// width of everything that is drawn.
 // [Optional, default: "auto"]
 var wayf_width = "auto";
 
 // Height of the embedded WAYF in pixels or "auto"
+// This is the height of the content only (without padding and border). 
+// Add 2 x (10px + 1px) = 22px for padding and border to get the actual 
+// height of everything that is drawn.
 // [Optional, default: "auto"]
 var wayf_height = "auto";
 
@@ -44,6 +50,7 @@ var wayf_height = "auto";
 var wayf_show_remember_checkbox = true;
 
 // Logo size
+// Choose whether the small or large logo shall be used
 // [Optional, default: true]
 var wayf_use_small_logo = true;
 
@@ -81,32 +88,30 @@ var wayf_hide_after_login = true;
 // [Optional, default: true]
 var wayf_show_categories =  true;
 
-
 // Most used Identity Providers will be shown as top category in the drop down
 // list if this feature is used.
 // [Optional, commented out by default]
-// var wayf_most_used_idps =  new Array("urn:mace:switch.ch:SWITCHaai:unibas.ch", "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 shall not be shown
 // Possible values are: <?php echo $types ?>, "all"
+// Example of how to hide categories
+// var wayf_hide_categories =  new Array("other", "library");
 // [Optional, commented out by default]
 // var wayf_hide_categories =  new Array();
 
-// Example of how to hide categories
-// var wayf_hide_categories =  new Array("other", "library");
 
 // EntityIDs of Identity Provider whose category is hidden but that shall be shown anyway
 // If this array is not empty, wayf_show_categories will be disabled because
 // otherwise, unhidden IdPs may be displayed in the wrong category
 // Example of how to unhide certain Identity Providers
-// var wayf_unhide_idps = new Array("urn:mace:switch.ch:aaitest:dukono.switch.ch");
+// var wayf_unhide_idps = new Array("https://aai-login.uzh.ch/idp/shibboleth");
 // [Optional, commented out by default]
 // var wayf_unhide_idps = new Array();
 
 // EntityIDs of Identity Provider that shall not be shown at all
 // Example of how to hide certain Identity Provider
-// var wayf_hide_idps = new Array("urn:mace:switch.ch:aaitest:blupblup.switch.ch", "https://lewotolo.switch.ch/idp/shibboleth");
+// var wayf_hide_idps = new Array("https://idp.unige.ch/idp/shibboleth", "https://lewotolo.switch.ch/idp/shibboleth");
 // [Optional, commented out by default]
 // var wayf_hide_idps = new Array();
 
@@ -121,7 +126,7 @@ var wayf_show_categories =  true;
 // if there is a good reason why to use the old and deprecated Shibboleth WAYF
 // protocol instead.
 // [Optional, default: commented out]
-// var wayf_use_discovery_service = false
+// var wayf_use_discovery_service = false;
 
 // Session Initiator URL of the Service Provider
 // Examples: "https://econf.switch.ch/Shibboleth.sso/DS", "https://dokeos.unige.ch/Shibboleth.sso/DS"
@@ -194,7 +199,7 @@ var wayf_show_categories =  true;
 // var wayf_additional_idps = [ 
 //        
 //        {name:"International University X",
-//        entityID:"urn:mace:switch.ch:SWITCHaai:internation.university.org",
+//        entityID:"urn:mace:switch.ch:SWITCHaai:example.university.org",
 //        SAML1SSOurl:"https://int.univ.org/shibboleth-idp/SSO"},
 //
 //        {name:"Some Other University",

languages.php

@@ -29,7 +29,7 @@ $langStrings['en'] = array (
 'access_host' => 'In order to access a service on host <tt>\'%s\'</tt> you must authenticate yourself.',
 'select_idp' => 'Select the Home Organisation you are affiliated with',
 'remember_selection' => 'Remember selection for this web browser session.',
-'switch_description' => 'The <a href="http://www.switch.ch/" target="_blank">SWITCH</a> Foundation operates the Swiss Education &amp; Research Network which guarantees high-speed connectivity to the Internet and to science networks globally for the benefit of higher education in Switzerland.',
+'switch_description' => 'The <a href="http://www.switch.ch/" target="_blank">SWITCH</a> foundation operates the Swiss education and research network which guarantees high-speed connectivity to the Internet and to science networks globally for the benefit of higher education in Switzerland.',
 'invalid_user_idp' => 'There may be an error in the data you just submitted.<br>The value of your input <tt>\'%s\'</tt> is invalid.<br>Only the following values are allowed:',
 'contact_assistance' => 'Please contact <a href="mailto:aai@switch.ch">aai@switch.ch</a> for assistance.',
 'no_arguments' => 'No arguments received!',
@@ -70,7 +70,7 @@ $langStrings['de'] = array (
 'access_host' => 'Um auf Dienste auf dem Server <tt>\'%s\'</tt> zuzugreifen, ist eine g&uuml;ltige Benutzerauthentifizierung n&ouml;tig.',
 'select_idp' => 'W&auml;hlen Sie Ihre Home Organisation',
 'remember_selection' => 'Auswahl f&uuml;r die laufende Webbrowser Sitzung speichern.',
-'switch_description' => 'Die <a href="http://www.switch.ch/" target="_blank">Stiftung SWITCH</a> betreibt neben anderen Dienstleistungen das Schweizer Bildungs- &amp; Forschungsnetzwerk, welches allen h&ouml;heren Ausbildungseinrichtungen Hochgeschwindigkeitsanschl&uuml;sse ans Internet und an andere globale Wissenschaftsnetze zur Verf&uuml;gung stellt.',
+'switch_description' => 'Die <a href="http://www.switch.ch/" target="_blank">Stiftung SWITCH</a> betreibt neben anderen Dienstleistungen das Schweizer Bildungs- und Forschungsnetzwerk, welches allen h&ouml;heren Ausbildungseinrichtungen Hochgeschwindigkeitsanschl&uuml;sse ans Internet und an andere globale Wissenschaftsnetze zur Verf&uuml;gung stellt.',
 'invalid_user_idp' => 'M&ouml;glicherweise sind die &uuml;bermittelten Daten fehlerhaft.<br>Der Wert der Eingabe <tt>\'%s\'</tt> ist ung&uuml;ltig.<br>Es sind ausschliesslich die folgenden Wert erlaubt:',
 'contact_assistance' => 'F&uuml;r Unterst&uuml;tzung und Hilfe, kontaktieren Sie bitte <a href="mailto:aai@switch.ch">aai@switch.ch</a>.',
 'no_arguments' => 'Keine Argumente erhalten!',
@@ -194,7 +194,7 @@ $langStrings['pt'] = array (
 'no_idp' => 'N&atilde;o existem Organiza&ccedil;&otilde;es de Origem na federa&ccedil;&atilde;o \'<i>%s</i>\'',
 'remember_selection' => 'Memorize a selec&ccedil;&atilde;o para esta sess&atilde;o.',
 'import_swisssign' => 'A SWITCH recomenda <a href="http://www.switch.ch/pki/import.html" target="_blank">a importa&ccedil;&atilde;o do\'SwissSign Root CA Certificate\'</a> no seu browser. Desta forma, o seu browser estabelecer&acute; uma liga&ccedil;&atilde;o segura com os servidores AAI.',
-'switch_description' => 'A SWITCH FOUNDATION &eacute; uma institui&ccedil;&atilde;o gere e opera a rede de investiga&ccedil;&atilde;o e ensino sui&ccedil;a por forma a garantir conectividade de alto desempenho &agrave; Internet e a redes de I&amp;D globais para o beneficio de uma educa&ccedil;&atilde;o superior na sui&ccedil;a',
+'switch_description' => 'A SWITCH foundation &eacute; uma institui&ccedil;&atilde;o gere e opera a rede de investiga&ccedil;&atilde;o e ensino sui&ccedil;a por forma a garantir conectividade de alto desempenho &agrave; Internet e a redes de I&amp;D globais para o beneficio de uma educa&ccedil;&atilde;o superior na sui&ccedil;a',
 'invalid_user_idp' => 'Poder&aacute; existir um erro nos dados que enviou.<br>Os valores enviados <tt>\'%s\'</tt> s&atilde;o inv&aacute;lidos.<br>Apenas os valores seguintes s&atilde;o permitidos:',
 'contact_assistance' => 'Contacte <a href="mailto:aai@fccn.pt">aai@fccn.pt</a> para assistencia.',
 'no_arguments' => 'Nenhum argumento recebido!',

templates.php

@@ -725,9 +725,9 @@ function decodeBase64(input) {
 		wayf_hide_after_login 
 		&& user_logged_in
 	){
-		writeHTML('<div id="wayf_div" style="background:' + wayf_background_color + ';border-style: solid;border-color: ' + wayf_border_color + ';border-width: 1px;padding: 10px;height: auto;width: ' + wayf_width + ';text-align: left;overflow: hidden;">');
+		writeHTML('<div id="wayf_div" style="background:' + wayf_background_color + ';border-style: solid;border-color: ' + wayf_border_color + ';border-width: 1px;padding: 10px; height: auto;width: ' + wayf_width + ';text-align: left;overflow: hidden;">');
 	} else {
-		writeHTML('<div id="wayf_div" style="background:' + wayf_background_color + ';border-style: solid;border-color: ' + wayf_border_color + ';border-width: 1px;padding: 10px;height: ' + wayf_height + ';width: ' + wayf_width + ';text-align: left;overflow: hidden;">');
+		writeHTML('<div id="wayf_div" style="background:' + wayf_background_color + ';border-style: solid;border-color: ' + wayf_border_color + ';border-width: 1px;padding: 10px; height: ' + wayf_height + ';width: ' + wayf_width + ';text-align: left;overflow: hidden;">');
 	}
 	
 	// Shall we display the logo
@@ -748,13 +748,12 @@ function decodeBase64(input) {
 	}
 	
 	// Start login check
+	// Search for login state cookie
+	// If one exists, we only draw the logged_in_message
 	if(
 		wayf_hide_after_login 
 		&& user_logged_in
 	){
-		// Search for login state cookie
-		// If one exists, we stop drawing embedded WAYF
-		
 		writeHTML('<p id="wayf_intro_div" style="float:left;font-size:' + wayf_font_size + 'px;color:' + wayf_font_color + ';">' + wayf_logged_in_messsage + '</p>');
 		
 	} else {
@@ -1004,7 +1003,7 @@ SCRIPT;
 	// Close box
 	writeHTML('</div>');
 	
-	// Now output HTML
+	// Now output HTML all at once
 	document.write(wayf_html);
 })()