InteropConfig:SolutionTemplates

From OSIS Open Source Identity Systems
Jump to: navigation, search

Create the following pages, substituting your namespace for UMA1 here:

1. Create the page http://osis.idcommons.net/wiki/Template:UMA1_Solution

<includeonly>
{{DT Article Header|UMA1 Solution|{{PAGENAME}}|{{{name}}}|refs=no}}
{|class=formtable width=100% border=1 cellspacing=0 cellpadding=0
  {{DT Form Header         |UMA1 Solution         |value={{{name}}}| width=120 | color=#ccffaa}}
  {{DT Form Field          |Identifier           |value={{{identifier|}}}   }}
  {{DT Form Field          |Description          |value={{{summary|}}}   }}
  {{DT Form Field          |Product Page         |value={{{homepage|}}}   }}
  {{DT Form Field          |Project or solution logo (if different than Participant logo) | value={{{logo|}}} }}
  {{DT Form Field          |Latest Version       |value={{{latestversion|}}}   }}
  {{DT Form Field          |Latest Release Date  |value={{{latestreleasedate|}}}   }}
  {{DT Form Field          |Installation/Operation Instructions     |value={{{instructions|}}}   }}
  {{DT Form Field          |Operated by          |value=[[UMA1:{{{solutionowner}}}|{{{solutionowner}}}]] }}
  {{DT Form Field          |Interop Roles        |value={{{solutionrole1|}}} {{ #if: {{{solutionendpoint1|}}} |: {{{solutionendpoint1}}} |}}  }}
  {{DT Form Field          |                     |value={{{solutionrole2|}}} {{ #if: {{{solutionendpoint2|}}} |: {{{solutionendpoint2}}} |}}  }}
  {{DT Form Field          |                     |value={{{solutionrole3|}}} {{ #if: {{{solutionendpoint3|}}} |: {{{solutionendpoint3}}} |}}  }}
  {{DT Form Field          |                     |value={{{solutionrole4|}}} {{ #if: {{{solutionendpoint4|}}} |: {{{solutionendpoint4}}} |}}  }}
|}
<small>Click [[:Template:Solution.help | here]] for help populating this chart.</small>
<!-- Cross Solution Results not relevant to I4 and beyond so should not be displayed
=== Cross Solution Results ===
{{ #if: {{{solutionrole1|}}} |*[[:Category:{{{solutionrole1|}}} Cross Solution Results]] | }}
{{ #if: {{{solutionrole2|}}} |*[[:Category:{{{solutionrole2|}}} Cross Solution Results]] | }}
{{ #if: {{{solutionrole3|}}} |*[[:Category:{{{solutionrole3|}}} Cross Solution Results]] | }}
{{ #if: {{{solutionrole4|}}} |*[[:Category:{{{solutionrole4|}}} Cross Solution Results]] | }}
-->

{{ #if: {{{solutionrole1|}}} |
{{DT Article|index=}}
== {{NAMESPACE}} {{{solutionrole1|}}} FeatureTest List ==
{{ {{NAMESPACE}} {{{solutionrole1|}}} FeatureTest List
  |name               = {{{name|}}}
  |primarysolution    = {{FULLPAGENAME}}
  |testedrole         = {{{solutionrole1}}}
  |ns                 = {{NAMESPACE}}
}} |
}}

{{ #if: {{{solutionrole2|}}} |
{{DT Article|index=}}
== {{NAMESPACE}} {{{solutionrole2|}}} FeatureTest List ==
{{ {{NAMESPACE}} {{{solutionrole2|}}} FeatureTest List
  |name               = {{{name|}}}
  |primarysolution    = {{FULLPAGENAME}}
  |testedrole         = {{{solutionrole2}}}
  |ns                 = {{NAMESPACE}}
}} |
}}

{{ #if: {{{solutionrole3|}}} |
{{DT Article|index=}}
== {{NAMESPACE}} {{{solutionrole3|}}} FeatureTest List ==
{{ {{NAMESPACE}} {{{solutionrole3|}}} FeatureTest List
  |name               = {{{name|}}}
  |primarysolution    = {{FULLPAGENAME}}
  |testedrole         = {{{solutionrole3}}}
  |ns                 = {{NAMESPACE}}
}} |
}}


{{ #if: {{{solutionrole4|}}} |
{{DT Article|index=}}
== {{NAMESPACE}} {{{solutionrole4|}}} Feature Test List ==
{{ {{NAMESPACE}} {{{solutionrole4|}}} Feature Test List
  |name               = {{{name|}}}
  |primarysolution    = {{FULLPAGENAME}}
  |testedrole         = {{{solutionrole4}}}
  |ns                 = {{NAMESPACE}}
}} |
}}

[[Category:{{NAMESPACE}} Solutions]]
{{ #if: {{{solutionrole1|}}} | [[Category:{{NAMESPACE}} {{{solutionrole1|}}}]] | }}
{{ #if: {{{solutionrole2|}}} | [[Category:{{NAMESPACE}} {{{solutionrole2|}}}]] | }}
{{ #if: {{{solutionrole3|}}} | [[Category:{{NAMESPACE}} {{{solutionrole3|}}}]] | }}
{{ #if: {{{solutionrole4|}}} | [[Category:{{NAMESPACE}} {{{solutionrole4|}}}]] | }}
</includeonly>
<noinclude>
{{:Template:UMA1 Solution.help}}
[[Category:Interop templates|{{PAGENAME}}]]
</noinclude>

2. Create page http://osis.idcommons.net/wiki/Template:UMA1_Solution.edit (substituting for UMA1 in both title and content)

{{DT Article|index=}}
== Solution Name?? ==
{{UMA1 Solution
  |name              = 
  |identifier        =
  |summary           = 
  |homepage          = http://
  |logo              = 
  |instructions      =
  |latestversion     =
  |latestreleasedate =
  |solutionowner     =
  |assertionissuer  =
  |metadataurl        =
  |certificatechain =
  |publiccertificate = 
  |solutionrole1     =
  |solutionendpoint1 = http://
  |solutionrole2     =
  |solutionendpoint2 = http://
  |solutionrole3     =
  |solutionendpoint3 = http://
  |solutionrole4     =
  |solutionendpoint4 = http://
}}

3. Create page http://osis.idcommons.net/wiki/Template:UMA1_Solution.help (substituting your namespace for UMA1 in title and content)

== Template Invocation ==
<pre>
{{DT Article|index=}}
== Solution Name?? ==
{{UMA1 Solution
  |name              = 
  |identifier        =
  |summary           = 
  |homepage          = http://
  |logo              = 
  |instructions      =
  |latestversion     =
  |latestreleasedate =
  |solutionowner     =
  |assertionissuer =
  |certificatechain =
  |publiccertificate =
  |metadataurl       =
  |solutionrole1     =
  |solutionendpoint1 = http://
  |solutionrole2     =
  |solutionendpoint2 = http://
  |solutionrole3     =
  |solutionendpoint3 = http://
  |solutionrole4     =
  |solutionendpoint4 = http://
}}

</pre>

== Usage notes ==
* '''name'''
: The name of the component without the initial interop prefix (eg: BG10:).
* '''summary'''
: A short description of the component purpose.  
: More detailed descriptions are desirable, and should be added to the main page content.
* '''homepage'''
: Web page for the solution
* '''logo'''
: Logo for the project or solution (if different than the Participant logo)
* '''instructions'''
: Either text instructions or a link to a page describing how to get or get to your solution
* '''latestversiondate'''
: A date that should be updated if you change your solution to fix any problems
* '''solutionowner'''
: The Name of the Participant who makes the Component -- should be the exact wiki page name, without the "Participants:" part  
* '''metadataurl'''
: An http url pointing to the Entity Descriptor file
* '''AssertionIssuer'''
: The value of of the EntityID in a SAML token (for SAML or IMI) or the OP Endpoint URL for OpenID
* '''certificatechain'''
: Optional certificate data for validating a certificate outside a trust framework.
* '''publiccertificate'''
: Public certificates for your solution - what should show up in the trust framework document.
* '''solutionrole1 - solutionrole4'''
: The type of component
: Possible Values:
:* Information Card Identity Selector
:* Information Card Browser Add-on
:* Information Card Identity Provider
:* Information Card Relying Party
:* OpenID Identity Provider
:* OpenID Relying Party
*'''solutionendpoint1 - solutionendpoint4'''
: The URL of the endpoint for the given solution role

If a given instantiation of this component can act in more than 4 component capacities, this template can be expanded.

4. Create page http://osis.idcommons.net/wiki/Template:UMA1_Solution.intro (substituting your namespace for UMA1 in title and content)

{{DT Article Edit (Syntax){{DT Language}}}}
----
{{UMA1 Solution.help}}

5. Create page http://osis.idcommons.net/wiki/Template:UMA1_Solution.text (substituting your namespace for UMA1 in title and content)

{{DT Articles list HTML|type=UMA1_Solution|namespace={{NAMESPACE}}|title=}}

5. Create page http://osis.idcommons.net/wiki/Template:UMA1_Solution.view (substituting your namespace for UMA1 in title and content)

[[{{{%PAGE%}}}#{{{name}}}|{{{name}}}]]
|{{{solutionrole1|}}}
|{{{solutionrole2|}}}
|{{{solutionrole3|}}}
|{{{solutionrole4|}}}
|{{{solutionowner|}}}
|<small>{{{%DATE%}}}</small>
|<small>{{{%USER%}}}</small>
<noinclude>[[:Category:UMA1 Solution]] [[Category:Interop templates]]</noinclude>