Add about page to web app

adoxography · adoxography · commit da2f115e3cfb · 2018-06-06T20:12:58.000-07:00
diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,7 @@
+## Objective
+**NEAM** is a system for extracting Named Entities in transcribed diary entries from the [Emma B. Andrews Diary Project](http://www.emmabandrews.org/project/). Found entities are tagged following the TEI schema of the project.
+
+## Requirements
+* Creating a system that successfully extracts entities: people, places, and organizations
+* Tagging the entities with appropriate TEI tags and ref attributes
+* Establishing a baseline of accuracy
diff --git a/neam/python/app/routes.py b/neam/python/app/routes.py
@@ -1,16 +1,29 @@
 import os
 
-from flask import render_template, request, send_from_directory, jsonify, url_for
+from flask import render_template, request, send_from_directory, jsonify, url_for, Markup
+from markdown import markdown
+
 from neam.python.app import app, celery, neam_annotate
 
 
+FILE_DIR = os.path.dirname(os.path.realpath(__file__))
+
+
 @app.route('/')
 @app.route('/index')
 def index():
     """ Routes the user to the index page """
     return render_template('index.html', title='NEAM Annotate')
 
 
+@app.route('/about')
+def about():
+    """ Routes the user to the about page """
+    with open(os.path.join(FILE_DIR, '..', '..', '..', 'docs', 'about.md')) as one_pager:
+        content = '\n'.join(one_pager.readlines())
+    return render_template('about.html', title='About NEAM', content=Markup(markdown(content)))
+
+
 @app.route('/annotate', methods=['POST'])
 def annotate():
     """
diff --git a/neam/python/app/static/css/style.css b/neam/python/app/static/css/style.css
@@ -6,6 +6,10 @@
     background-color: #452a78;
 }
 
+.brand-logo {
+    margin-left: 1rem;
+}
+
 body {
     background-color: #f5f5f5;
     font-family: "Open Sans", Helvetica, Arial, Verdana, sans-serif;
@@ -21,10 +25,22 @@ input:not(.browser-default):focus:not([readonly]), textarea.materialize-textarea
     box-shadow: 0 1px 0 0 #558097 !important;
 }
 
-h1 {
+h1, h2, h3 {
     font-family: "encode_sans_normalbold", sans-serif;
 }
 
+h1 {
+    font-size: 2.8rem;
+}
+
+h2 {
+    font-size: 2.3rem;
+}
+
+h3 {
+    font-size: 1.8rem;
+}
+
 strong {
     font-weight: bolder;
 }
@@ -34,3 +50,7 @@ strong {
     background-color: white;
 }
 
+.box h2:first-child {
+    margin-top: .5rem;
+}
+
diff --git a/neam/python/app/templates/about.html b/neam/python/app/templates/about.html
@@ -0,0 +1,8 @@
+{% extends "layout.html" %}
+
+{% block content %}
+    <h1 class="center-align">About NEAM</h1>
+    <div class="row box z-depth-2">
+        {{ content }}
+    </div>
+{% endblock %}
diff --git a/neam/python/app/templates/layout.html b/neam/python/app/templates/layout.html
@@ -13,8 +13,9 @@
     <body>
         <nav>
             <div class="nav-wrapper">
-                <ul id="nav-mobile" class="left hide-on-med-and-down">
-                    <li><a>Link</a></li>
+                <a href="/" class="brand-logo">NEAM</a>
+                <ul id="nav-mobile" class="right hide-on-med-and-down">
+                    <li><a href="/about">About</a></li>
                 </ul>
             </div>
         </nav>
diff --git a/requirements.txt b/requirements.txt
@@ -6,6 +6,7 @@ numpy==1.13.3
 flask
 celery
 gunicorn
+markdown
 redis
 lxml
 pywikibot
