Parcourir la source

Converted README to markup

Andreas Kopmann il y a 7 ans
Parent
commit
20fad1dfa5
1 fichiers modifiés avec 20 ajouts et 16 suppressions
  1. 20 16
      README.md

+ 20 - 16
README.md

@@ -3,9 +3,10 @@ Ak, 27.3.2017
 
 
 Get information from Scopus database.
 Get information from Scopus database.
 
 
-This queries work only with access to Scopus (e.g. from KIT LAN)
+Note: This queries work only with access to Scopus (e.g. from KIT LAN)
 Scopus service is not public vailable.
 Scopus service is not public vailable.
 
 
+
 ## Version history
 ## Version history
 
 
 Version 1.0, 8.3.17 (ak):
 Version 1.0, 8.3.17 (ak):
@@ -17,9 +18,9 @@ Version 1.0, 8.3.17 (ak):
 
 
 
 
 ## Content
 ## Content
-info		Documentation, website, etc
 
 
-readme.txt	This file
+```
+readme.md       This file
 my_scopus.py	List of scopus author ids
 my_scopus.py	List of scopus author ids
 ak_scopus.py	Functions to access scopus
 ak_scopus.py	Functions to access scopus
 ak_wordpress.py Functions to creates Wordpress posts + comments
 ak_wordpress.py Functions to creates Wordpress posts + comments
@@ -31,8 +32,11 @@ test-scopus2.py Example from one of the website, only one query
 test-wp.py	Test script for access to the wordpress API	
 test-wp.py	Test script for access to the wordpress API	
 test-wp2.py 	Test script for wordpress - only query, no modification
 test-wp2.py 	Test script for wordpress - only query, no modification
 
 
+info            Documentation, website, etc (not in GIT)
+```
+
+## Usage
 
 
-## Usage: 
 1. Go to Scopus and retrieve the scopus author ids for the scientists in your group.
 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.
 Define the ids in my_scopus.py and group them.
 
 
@@ -45,9 +49,9 @@ python -W ignore scopus-get-publications.py
 Note: The -W ignore flag might be necessary if the INSERT IGNORE causes warnings.
 Note: The -W ignore flag might be necessary if the INSERT IGNORE causes warnings.
 
 
 Example run:
 Example run:
+```
 ufo:~/scopus # python -W ignore scopus-get-publications.py 
 ufo:~/scopus # python -W ignore scopus-get-publications.py 
 
 
-```
 ***********************************************
 ***********************************************
 **** scopus-get-publications / 2017-03-27 *****
 **** scopus-get-publications / 2017-03-27 *****
 ***********************************************
 ***********************************************
@@ -92,7 +96,7 @@ like UFO or may be also later for the DTS program.
 - Handle wrong publications in scopus for author with same name
 - Handle wrong publications in scopus for author with same name
 - Automatically include reports and student thesis by
 - Automatically include reports and student thesis by
 bibtex definition and upload on a server!?
 bibtex definition and upload on a server!?
--> Would have the nice effect, that all student work is organized systematically!!!
+This would have the nice effect, that all student work is organized systematically!!!
 
 
 
 
 
 
@@ -151,19 +155,21 @@ MariaDB [scopus]> describe citations;
 ```
 ```
 
 
 
 
-## Setup of scopus database in mysql 
-
+Setup of scopus database in mysql 
+```
 create database scopus;
 create database scopus;
 
 
 CREATE USER 'scopus@localhost';
 CREATE USER 'scopus@localhost';
 grant all on scopus.* to 'scopus'@'localhost' identified by '$scopus$';
 grant all on scopus.* to 'scopus'@'localhost' identified by '$scopus$';
+```
 
 
+```
 # create tables
 # create tables
 mysql -u scopus -p scopus < create_scopus.sql
 mysql -u scopus -p scopus < create_scopus.sql
+```
 
 
 
 
-
-Publications in Scopus:
+## Publications in Scopus
 
 
 Sometime (unfortunately quite often) a author id in Scopus is not unique but 
 Sometime (unfortunately quite often) a author id in Scopus is not unique but 
 identifies several researchers with the same name. E.g. Michele Caselle (3 persons)
 identifies several researchers with the same name. E.g. Michele Caselle (3 persons)
@@ -305,7 +311,7 @@ Sample data from Scopus:
 ```
 ```
 
 
 
 
-## Installations
+## Installation of tools
 
 
 Installation of python, mysql et al:
 Installation of python, mysql et al:
 
 
@@ -369,12 +375,10 @@ mkdir ufo2
 chown -R wwwrun:www ufo2
 chown -R wwwrun:www ufo2
 ```
 ```
 
 
+Run the installer:
+```
 http://ufo.kit.edu/ufo2/installer.php
 http://ufo.kit.edu/ufo2/installer.php
-
-
-Error: PHP module ZipArchive is missing 
-Manual extraction is available in the advanced options !!!
-
+```
 
 
 Installation Scopus-Scripts:
 Installation Scopus-Scripts: