You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2018/07/01 22:23:51 UTC

[jspwiki] branch master updated: fix a few formatting issues here and there

This is an automated email from the ASF dual-hosted git repository.

juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git


The following commit(s) were added to refs/heads/master by this push:
     new c6faab4  fix a few formatting issues here and there
c6faab4 is described below

commit c6faab43265c148925c71798b3ca83e46595e6e1
Author: Juan Pablo Santos Rodríguez <ju...@gmail.com>
AuthorDate: Mon Jul 2 00:23:49 2018 +0200

    fix a few formatting issues here and there
---
 README.md | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index b8a88ca..0445128 100644
--- a/README.md
+++ b/README.md
@@ -69,47 +69,47 @@ engine.  Just do the following:
    your desired URL (if you want it different from /JSPWiki).  For example,
    if you want your URL to be http://.../wiki, rename it to wiki.war.
    This name will be referred to as <appname> below.
-   Place this WAR in your $TOMCAT_HOME/webapps folder and then start Tomcat.
+   Place this WAR in your `$TOMCAT_HOME/webapps` folder and then start Tomcat.
 
-3) Point your browser at http://<myhost>/<appname>/Install.jsp
+3) Point your browser at http://&lt;myhost>/&lt;appname>/Install.jsp
 
 4) Answer a couple of simple questions
 
 5) Restart your container
 
-6) Point your browser to http://<myhost>/<appname>/
+6) Point your browser to http://&lt;myhost>/&lt;appname>/
 
 That's it!
 
 
 ## Advanced Installation
 
-In the $TOMCAT_HOME/lib folder (or equivalent based on your servlet container),
-place a jspwiki-custom.properties file, which can contain any overrides to the 
-default ini/jspwiki.properties file in the JSPWiki JAR.  For any values not 
-placed in jspwiki-custom.properties file JSPWiki will rely on the default file.
+In the `$TOMCAT_HOME/lib` folder (or equivalent based on your servlet container),
+place a `jspwiki-custom.properties` file, which can contain any overrides to the 
+default `ini/jspwiki.properties` file in the JSPWiki JAR.  For any values not 
+placed in `jspwiki-custom.properties` file JSPWiki will rely on the default file.
 Review the default file to look for values you may wish to override in the custom
 file.  Some common values to override in your custom file include 
-jspwiki.xmlUserDatabaseFile, jspwiki.xmlGroupDatabaseFile
-jspwiki.fileSystemProvider.pageDir, jspwiki.basicAttachmentProvider.storageDir, 
-and log4j.appender.FileLog.File.  The comments in the default file will suggest 
+`jspwiki.xmlUserDatabaseFile`, `jspwiki.xmlGroupDatabaseFile`, 
+`jspwiki.fileSystemProvider.pageDir`, `jspwiki.basicAttachmentProvider.storageDir`, 
+and `log4j.appender.FileLog.File`.  The comments in the default file will suggest 
 appropriate values to override them with. 
 
-The custom file can also be placed in the WEB-INF/ folder of the WAR, but storing
-this file in TOMCAT_HOME/lib allows you to upgrade the JSPWiki WAR without needing
+The custom file can also be placed in the `WEB-INF/` folder of the WAR, but storing
+this file in `$TOMCAT_HOME/lib` allows you to upgrade the JSPWiki WAR without needing
 to re-insert your customizations.
 
-Unzip the contents of jspwiki-corepages.zip into your newly created
+Unzip the contents of `jspwiki-corepages.zip` into your newly created
 directory.  You can find the rest of the documentation in the
-JSPWiki-doc.zip file.
+`JSPWiki-doc.zip` file.
 
 (Re)start tomcat.
 
-Point your browser at http://<where your Tomcat is installed>/MyWiki/.
+Point your browser at http://&lt;where your Tomcat is installed>/MyWiki/.
 You should see the Main Wiki page.  See the next section if you want
 to edit the pages =).
 
-The WEB-INF/jspwiki.policy file is used to change access permissions for 
+The `WEB-INF/jspwiki.policy` file is used to change access permissions for 
 the Wiki.
 
 Check the Apache JSPWiki website and project documentation for additional