Changeset 18646 for trunk/MobileIndico/README.md

Timestamp:

09/25/16 21:30:01 (8 years ago)

Author:

tbretz

Message:

Adapted to fit a nice markdown page

File:

• trunk/MobileIndico/README.md (modified) (9 diffs)

trunk/MobileIndico/README.md

@@ -1 @@
-Mobile Indico
-=============
-
-Mobile Indico aims to display an indico event in a mobile friendly way.
-
-
-Quick guide - direct access
-===========================
+Quick access guide
+==================
 
 If you are happy with the existuing layout, you can access an event
@@ -12 +6 @@
 https://indico.scc.kit.edu/indico/) as a mobile version directly by
 
-https://www.fact-project.org/svn/trunk/MobileIndico/indico.html?url=https://indico.scc.kit.edu/indico/&id=254
+> https://www.fact-project.org/svn/trunk/MobileIndico/indico.html?url=https://indico.scc.kit.edu/indico/&id=254
 
 If you find that too long, you can use http://tinyurl.com to shorten
@@ -19 +13 @@
 A short version of the core url is available as
 
-http://tinyurl.com/MyIndico?url=https://indico.scc.kit.edu/indico/&id=254
+> http://tinyurl.com/MyIndico?url=https://indico.scc.kit.edu/indico/&id=254
 
 
@@ -37 +31 @@
 
 The trick of JSONP is to wrap the JSON opject into a script (Javascript
-function) and insert a <script> tag into the webpage. Thus the script
+function) and insert a `<script>` tag into the webpage. Thus the script
 containing the data is loaded and the data can be processed.
 
@@ -49 +43 @@
 First download all files from
 
-https://trac.fact-project.org/browser/trunk/MobileIndico
+> https://trac.fact-project.org/browser/trunk/MobileIndico
 
 and copy them to a webserver.
 
 The current version is bound to a single indico server which is
-specified in indico.js in the first line, as well as the number
+specified in indico.js in the first lines, as well as the number
 of the default event if no event is specified:
 
-var indico_url = "https://indico.scc.kit.edu/indico/";
-var default_event = 215;
+```
+  var indico_url = "https://indico.scc.kit.edu/indico/";
+  var default_event = 215;
+```
 
 Adapt that according to your needs.
@@ -68 +64 @@
 The default timetable is then accessed through
 
-http://you.web-server.com/your-path/indico.html
+> http://you.web-server.com/your-path/indico.html
 
 and another event (e.g. 215) through
 
-http://you.web-server.com/your-path/indico.html?id=215
+> http://you.web-server.com/your-path/indico.html?id=215
 
 A debug mode in which the received JSON object is displayed is
 available as well
 
-http://you.web-server.com/your-path/indico.html?id=215&debug
+> http://you.web-server.com/your-path/indico.html?id=215&debug
 
 It is also possible to overwrite the default indico url, for exmaple
 
-http://you.web-server.com/your-path/indico.html?url=https://indico.scc.kit.edu/indico/&id=215
+> http://you.web-server.com/your-path/indico.html?url=https://indico.scc.kit.edu/indico/&id=215
 
 
@@ -87 +83 @@
 =====
 
-indico.css:  A simple style sheet to format the output
-indico.svg:  The indico logo at the header line
-rwth.avg:    The rwth logo at the footer
-indico.js:   The javascript retrieving the data and formatting the html
-indico.html: The main html page for user access
+- *indico.css*:  A simple style sheet to format the output
+- *indico.svg*:  The indico logo at the header line
+- *rwth.avg*:    The rwth logo at the footer
+- *indico.js*:   The javascript retrieving the data and formatting the html
+- *indico.html*: The main html page for user access
 
 
@@ -99 +95 @@
 For formatting purpose, the data is wrapped in classes like this:
 
+```
 <indico>
    Date
@@ -162 +159 @@
     ...
 </indico>
+```