Update README.md

ebremer · Aug 8, 2013 · 6326582 · 6326582
1 parent 711be9f
commit 6326582
Showing 1 changed file with 65 additions and 60 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 ## webid4vivo
+<br>
 Purpose: To add webid authentication and provisioning capabilities to VIVO (http:https://www.vivoweb.org)
 
 **Developers:**<br>
@@ -16,79 +17,83 @@ Tammy DiPrima
 * bcpkix-jdk15on-149.jar 
 * bcprov-jdk15on-149.jar
 
-Put these jars here: [vivo-install-dir]/src
+**Put the jars here:** [vivo-install-dir]/src
 
 #### Source Code
 
-**Move java files to:** [vivo-install-dir]/src/edu/stonybrook/ai/webid4vivo
-
-**Add the servlets & servlet mappings to productMods/WEB-INF/web.xml:**<br>
-<pre><code>
- &lt;servlet&gt;
- &lt;servlet-name&gt;signIn&lt;/servlet-name&gt;
- &lt;servlet-class&gt;edu.stonybrook.ai.webid4vivo.auth&lt;/servlet-class&gt;
- &lt;/servlet&gt;
- &lt;servlet&gt;
- &lt;servlet-name&gt;webidMgt&lt;/servlet-name&gt;
- &lt;servlet-class&gt;edu.stonybrook.ai.webid4vivo.WebidController&lt;/servlet-class&gt;
- &lt;/servlet&gt;
- &lt;servlet&gt;
- &lt;servlet-name&gt;webidGen&lt;/servlet-name&gt;
- &lt;servlet-class&gt;edu.stonybrook.ai.webid4vivo.WebidGenerator&lt;/servlet-class&gt;
- &lt;/servlet&gt;
- &lt;servlet-mapping&gt;
- &lt;servlet-name&gt;signIn&lt;/servlet-name&gt;
- &lt;url-pattern&gt;/signIn&lt;/url-pattern&gt;
- &lt;/servlet-mapping&gt;
- &lt;servlet-mapping&gt;
- &lt;servlet-name&gt;webidMgt&lt;/servlet-name&gt;
- &lt;url-pattern&gt;/webidMgt&lt;/url-pattern&gt;
- &lt;/servlet-mapping&gt;
- &lt;servlet-mapping&gt;
- &lt;servlet-name&gt;webidGen&lt;/servlet-name&gt;
- &lt;url-pattern&gt;/webidGen&lt;/url-pattern&gt;
- &lt;/servlet-mapping&gt;
-</code></pre>
+**Create directory, and move java files to:** [vivo-install-dir]/src/edu/stonybrook/ai/webid4vivo
+
+**Add the servlets & servlet mappings to:** [vivo-install-dir]productMods/WEB-INF/web.xml<br>
+
+ <servlet>
+  <servlet-name>signIn</servlet-name>
+  <servlet-class>edu.stonybrook.ai.webid4vivo.auth</servlet-class>
+ </servlet>
+ <servlet>
+  <servlet-name>webidMgt</servlet-name>
+  <servlet-class>edu.stonybrook.ai.webid4vivo.WebidController</servlet-class>
+ </servlet>
+ <servlet>
+  <servlet-name>webidGen</servlet-name>
+  <servlet-class>edu.stonybrook.ai.webid4vivo.WebidGenerator</servlet-class>
+ </servlet>
+ <servlet-mapping>
+  <servlet-name>signIn</servlet-name>
+  <url-pattern>/signIn</url-pattern>
+ </servlet-mapping>
+ <servlet-mapping>
+  <servlet-name>webidMgt</servlet-name>
+  <url-pattern>/webidMgt</url-pattern>
+ </servlet-mapping>
+ <servlet-mapping>
+  <servlet-name>webidGen</servlet-name>
+  <url-pattern>/webidGen</url-pattern>
+ </servlet-mapping>
+
 
 #### Freemarker
 
-**Add the following to /vitro-core/webapp/web/templates/freemarker/widgets/widget-login.ftl:**
-<pre><code>
-&lt;p class="external-auth"&gt;&lt;a class="blue button" href="/signIn" title="webid"&gt;WebID&lt;/a&gt;&lt;/p&gt;
-&lt;p class="or-auth"&gt;or&lt;/p&gt;
-</code></pre>
-**Suggestion -- if you are also using external authentication, make that button green:**
-<pre><code>
-&lt;p class="external-auth"&gt;&lt;a class="green button" href="${externalAuthUrl}" title="external authentication name"&gt;${externalAuthName}&lt;/a&gt;&lt;/p&gt;
-</code></pre>
-**Add the following to productMods/templates/freemarker/body/individual/individual--foaf-person.ftl**:
+**Add the following to:** [vivo-install-dir]/vitro-core/webapp/web/templates/freemarker/widgets/widget-login.ftl
+
+ <p class="external-auth"><a class="blue button" href="/signIn" title="webid">WebID</a></p>
+ <p class="or-auth">or</p>
+
+Notice that the button color is <font color="#398aac">**blue**</font>.
+
+**Suggestion:** If you are also using external authentication, make the external-auth button <font color="#749a02">**green**</font>.
+
+ <p class="external-auth"><a class="green button" href="${externalAuthUrl}" title="external authentication name">${externalAuthName}</a></p>
+
+**Add the following to:** [vivo-install-dir]/productMods/templates/freemarker/body/individual/individual--foaf-person.ftl:
 
 *Where it says:*
-<pre><code>&lt;section id="individual-info" ${infoClass!} role="region"&gt; &lt;br&gt;
-</code></pre>
+
+ <section id="individual-info" ${infoClass!} role="region"> <br>
+
 *Add this underneath:*
-<pre><code>
-  &lt;#if user.loggedIn&gt;
-  &lt;div align="right"&gt;&lt;a href="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/webidMgt?2"&gt;My WebIDs&lt;/a&gt;&lt;/div&gt;
-  &lt;/#if&gt;
-</code></pre>
+
+ <#if user.loggedIn> 
+  <div align="right"><a href="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/webidMgt?2">My WebIDs</a></div>
+ </#if>
+
 
 **Stop Tomcat<br>
 Redeploy VIVO<br>**
 
 #### Apache HTTP Server
 
-**Modify /etc/httpd/conf/httpd.conf:**
-<pre><code>
-&#35;Listen 12.34.56.78:80
-Listen 443
-&#35; LoadModule foo_module modules/mod_foo.so
-LoadModule ssl_module modules/mod_ssl.so
-&#35;LoadModule include_module modules/mod_include.so
-&#35;&lt;VirtualHost *:80&gt; 
-&lt;Location /signIn&gt;
-SSLVerifyDepth 0
-SSLVerifyClient optional_no_ca
-&lt;/Location&gt;
-</code></pre>
+**Add commands to /etc/httpd/conf/httpd.conf:**
+
+ #Listen 12.34.56.78:80
+ Listen 443
+
+ #LoadModule foo_module modules/mod_foo.so
+ LoadModule ssl_module modules/mod_ssl.so
+
+ #<VirtualHost *:80> 
+ <Location /signIn>
+  SSLVerifyDepth 0
+  SSLVerifyClient optional_no_ca
+ </Location>
+
 **Restart apache**