Converted README to markup

README.txt → README.md

@@ -1,4 +1,4 @@
-README scopus
+# README scopus
 Ak, 27.3.2017
 
 Get information from Scopus database.
@@ -6,7 +6,7 @@ Get information from Scopus database.
 This queries work only with access to Scopus (e.g. from KIT LAN)
 Scopus service is not public vailable.
 
-Version history
+## Version history
 
 Version 1.0, 8.3.17 (ak):
 - initial version of a single script without any options
@@ -16,7 +16,7 @@ Version 1.0, 8.3.17 (ak):
  
 
 
-Content
+## Content
 info		Documentation, website, etc
 
 readme.txt	This file
@@ -32,7 +32,7 @@ test-wp.py	Test script for access to the wordpress API
 test-wp2.py 	Test script for wordpress - only query, no modification
 
 
-Usage: 
+## Usage: 
 1. Go to Scopus and retrieve the scopus author ids for the scientists in your group.
 Define the ids in my_scopus.py and group them.
 
@@ -47,6 +47,7 @@ Note: The -W ignore flag might be necessary if the INSERT IGNORE causes warnings
 Example run:
 ufo:~/scopus # python -W ignore scopus-get-publications.py 
 
+```
 ***********************************************
 **** scopus-get-publications / 2017-03-27 *****
 ***********************************************
@@ -76,9 +77,9 @@ NNewPubs   = 0
 NCites     = 4699
 NNewCites  = 0
 Runtime    = 0:00:11.496362
+```
 
-
-Further enhancements
+## Further enhancements
 
 Todo:
 - Reprocessing of all post, if the format has changed 
@@ -95,15 +96,16 @@ bibtex definition and upload on a server!?
 
 
 
-Structure of the database
+## Structure of the database
 
 Both tables keep the reference to the publications in Scopus and the 
 Wordpress ids. With this information, reprocessing is possible (but not
 implemented now).
 
 
-Table publocations:
+Table publications:
 
+```
 MariaDB [scopus]> describe publications;
 +--------------+--------------+------+-----+---------+----------------+
 | Field        | Type         | Null | Key | Default | Extra          |
@@ -122,9 +124,11 @@ MariaDB [scopus]> describe publications;
 | scopusdata   | text         | YES  |     | NULL    |                |
 | eid          | varchar(255) | YES  |     | NULL    |                |
 +--------------+--------------+------+-----+---------+----------------+
+```
 
 Table citations:
 
+```
 MariaDB [scopus]> describe citations;
 +--------------+--------------+------+-----+---------+----------------+
 | Field        | Type         | Null | Key | Default | Extra          |
@@ -144,10 +148,10 @@ MariaDB [scopus]> describe citations;
 | bibtex       | text         | YES  |     | NULL    |                |
 | ts           | datetime     | YES  |     | NULL    |                |
 +--------------+--------------+------+-----+---------+----------------+
+```
 
 
-
-Setup of scopus database in mysql 
+## Setup of scopus database in mysql 
 
 create database scopus;
 
@@ -170,6 +174,7 @@ authors. Might be possible to implement also a black list??
 
 
 Sample data from Scopus:
+```
 {
     "abstracts-retrieval-response": {
         "authors": {
@@ -297,15 +302,20 @@ Sample data from Scopus:
         }
     }
 }
+```
 
 
+## Installations
 
 Installation of python, mysql et al:
 
+```
 pip install python-wordpress-xmlrpc
+```
 
 Konfiguration Webserver (muss man wohl nach jeder Installation neu machen!!!)
 
+```
 /etc/apache2/httpd.conf:
 LoadModule userdir_module libexec/apache2/mod_userdir.so
 LoadModule php5_module libexec/apache2/libphp5.so
@@ -321,39 +331,43 @@ mysqli.default_socket = /tmp/mysql.sock
 
 
 sh-3.2# apachectl restart
-
+```
 
 Install website:
 
 Create archive with wp dublicator
 
 Save scopus database
-
+```
 mysqldump -u scopus -p scopus > scopus-170322.sql
-
+```
 
 Create database on remote system
 
 mysql:
+```
 CREATE USER 'scopus'@'localhost' IDENTIFIED BY '$scopus$';
 GRANT ALL PRIVILEGES ON scopus.* TO 'scopus'@'localhost';
 
 CREATE DATABASE scopus;
 
 mysql -u scopus -p scopus < scopus-170322.sql
-
+```
 
 Create database wp_ufo2;
 
+```
 CREATE USER ‘ufo’@‘localhost' IDENTIFIED BY '$ipepdv$';
 GRANT ALL PRIVILEGES ON wp_ufo2.* TO ‘ufo’@‘localhost';
 
 CREATE DATABASE wp_ufo2;
-
+```
 
 Import WP archive:
+```
 mkdir ufo2
 chown -R wwwrun:www ufo2
+```
 
 http://ufo.kit.edu/ufo2/installer.php
 
@@ -364,14 +378,17 @@ Manual extraction is available in the advanced options !!!
 
 Installation Scopus-Scripts:
 
+```
 pip install requests
 pip install python-wordpress-xmlrpc
 pip install pymysql
+```
 
 Check configurations:
+```
 scopus-get-piblications.py
 ak_wordpress.py
-
+```