diff --git a/README.md b/README.md index 9e3d9b2..c78b90e 100644 --- a/README.md +++ b/README.md @@ -36,28 +36,13 @@ list_all_SPs_csv.xsl ## Overview -Bash script ``http_xsltproc.sh`` is a wrapper around the ``xsltproc`` command-line tool. Unlike ``xsltproc``, this script fetches the target XML document from an HTTP server. See the inline help file for details: +Bash script ``http_xsltproc.sh`` is a wrapper around the ``xsltproc`` command-line tool. Unlike ``xsltproc``, script ``http_xsltproc.sh`` fetches the target XML document from an HTTP server. See the inline help file for details: ```Shell $ $BIN_DIR/http_xsltproc.sh -h ``` -Here's an example of script usage: - -```Shell -$ MD_LOCATION=http://md.incommon.org/InCommon/InCommon-metadata.xml -$ $BIN_DIR/http_xsltproc.sh $LIB_DIR/list_all_IdP_DisplayNames_csv.xsl $MD_LOCATION | head -IdP Display Name,IdP Entity ID,IdP Discovery,Registrar ID -"Ohio State University",urn:mace:incommon:osu.edu,show,https://incommon.org -"Cornell University",https://shibidp.cit.cornell.edu/idp/shibboleth,show,https://incommon.org -"University of California - Office of the President",urn:mace:incommon:ucop.edu,show,https://incommon.org -"University of California-Irvine",urn:mace:incommon:uci.edu,show,https://incommon.org -"University of Washington",urn:mace:incommon:washington.edu,show,https://incommon.org -"Internet2",urn:mace:incommon:internet2.edu,show,https://incommon.org -"University of California-San Diego",urn:mace:incommon:ucsd.edu,show,https://incommon.org -"Georgetown University",https://shibb-idp.georgetown.edu/idp/shibboleth,show,https://incommon.org -"Case Western Reserve University",urn:mace:incommon:case.edu,show,https://incommon.org -``` +The following examples illustrate usage of the script. ### Example #1 @@ -68,7 +53,7 @@ xml_location=http://md.incommon.org/InCommon/InCommon-metadata.xml resource_url=https://incommon.org/federation/metadata/all_IdP_DisplayNames.csv ``` -The latter resource is used to construct a List of IdP Display Names in the spaces wiki. +The latter resource is used to construct a [List of IdP Display Names](https://spaces.internet2.edu/x/2IDmBQ) in the spaces wiki. Let's build an automated process that transforms the SAML metadata at ``xml_location`` into the CSV file at ``resource_url``. Schedule the following process to run every hour on incommon.org: @@ -101,7 +86,7 @@ resource1_url=https://incommon.org/federation/metadata/all_RandS_IdPs.csv resource2_url=https://incommon.org/federation/metadata/all_RandS_SPs.csv ``` -The latter pair of resources are used to construct the List of Research and Scholarship Entities in the spaces wiki. +The latter pair of resources are used to construct the [List of Research and Scholarship Entities](https://spaces.internet2.edu/x/ZoUABg) in the spaces wiki. Suppose there is an automated process that transforms the SAML metadata at ``xml_location`` into the CSV files at ``resource1_url`` and ``resource2_url``. Specifically, let's suppose the following process runs every hour on incommon.org: @@ -144,7 +129,7 @@ resource1_url=https://incommon.org/federation/metadata/all_exported_IdPs.csv resource2_url=https://incommon.org/federation/metadata/all_exported_SPs.csv ``` -The latter pair of resources are used to construct the List of Exported Entities in the spaces wiki. +The latter pair of resources are used to construct the [List of Exported Entities](https://spaces.internet2.edu/x/DYD4BQ) in the spaces wiki. Suppose there is an automated process that transforms the SAML metadata at ``xml_location`` (i.e., the Export Aggregate) into the CSV files at ``resource1_url`` and ``resource2_url``. Specifically, let's suppose the following process runs every hour on incommon.org: