Skip to content

Commit 4a18882

Browse files
clovisclovis
committed
update docs
1 parent 3405b35 commit 4a18882

12 files changed

Lines changed: 47 additions & 91 deletions

‎docs/_includes/foot.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
</div>
2-
</div>
3-
</div>
4-
</div>
1+
</div>
2+
</div>
3+
</div>
4+
</div>
55
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js" integrity="sha384-geWF76RCwLtnZ8qwWowPQNguL3RmwHVBC9FhGdlKrxdiJJigb/j/68SIy3Te4Bkz" crossorigin="anonymous"></script>
66
</body>
77

‎docs/_includes/head.html‎

Lines changed: 41 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,6 @@
3838
code.highlighter-rouge {
3939
background: #f8f8f8;
4040
}
41-
.list-group-item-action:hover,
42-
.list-group-item-action:focus {
43-
color: #fff;
44-
background-color: rgb(173, 66, 66);
45-
}
4641
.navbar-dark .navbar-nav .nav-link {
4742
color: rgba(255, 255, 255, 0.85);
4843
}
@@ -63,6 +58,21 @@
6358
.title {
6459
color: rgb(95, 2, 2);
6560
}
61+
.doc-nav-link {
62+
color: #555;
63+
font-size: 0.9rem;
64+
padding: 0.4rem 0.75rem;
65+
border-radius: 0.375rem;
66+
border-left: 2px solid transparent;
67+
transition: all 0.15s ease;
68+
}
69+
.doc-nav-link:hover,
70+
.doc-nav-link:focus {
71+
color: rgb(95, 2, 2);
72+
background-color: rgba(156, 60, 60, 0.08);
73+
border-left-color: rgb(156, 60, 60);
74+
text-decoration: none;
75+
}
6676
</style>
6777
</head>
6878

@@ -116,7 +126,7 @@
116126
>
117127
<span class="navbar-toggler-icon"></span>
118128
</button>
119-
<ul class="navbar-nav d-none d-sm-flex">
129+
<ul class="navbar-nav ms-auto d-none d-sm-flex">
120130
<li class="nav-item">
121131
<a
122132
class="nav-link"
@@ -199,46 +209,30 @@
199209
</ul>
200210
</div>
201211
</nav>
202-
<div class="container-fluid mt-4">
203-
<div class="row justify-content-md-center">
204-
<div class="col-sm-4 col-md-3 col-lg-2 d-none d-sm-flex">
205-
<ul class="list-group">
206-
<a
207-
class="list-group-item list-group-item-action"
208-
href="{{ site.url }}installation.html"
209-
>Installation</a
210-
>
211-
<a
212-
class="list-group-item list-group-item-action"
213-
href="{{ site.url }}database_loading.html"
214-
>Database Loading</a
215-
>
216-
<a
217-
class="list-group-item list-group-item-action"
218-
href="{{ site.url }}encoding_spec.html"
219-
>Encoding Specification</a
220-
>
221-
<a
222-
class="list-group-item list-group-item-action"
223-
href="{{ site.url }}configure_web_app.html"
224-
>Configuring WebApp</a
225-
>
226-
<a
227-
class="list-group-item list-group-item-action"
228-
href="{{ site.url }}query_syntax.html"
229-
>Query Syntax</a
230-
>
231-
<a
232-
class="list-group-item list-group-item-action"
233-
href="{{ site.url }}access_control.html"
234-
>Access Control</a
235-
>
212+
<div class="container-fluid mt-4 px-4">
213+
<div class="row">
214+
<nav class="col-sm-4 col-md-3 col-lg-2 d-none d-sm-block" aria-label="Documentation" style="position: sticky; top: 80px; align-self: flex-start;">
215+
<h6 style="font-size: 0.7rem; text-transform: uppercase; letter-spacing: 1.5px; color: #999; margin-bottom: 0.75rem; padding-left: 0.75rem;">Documentation</h6>
216+
<ul class="nav flex-column" style="gap: 2px;">
217+
<li class="nav-item">
218+
<a class="nav-link doc-nav-link" href="{{ site.url }}installation.html">Installation</a>
219+
</li>
220+
<li class="nav-item">
221+
<a class="nav-link doc-nav-link" href="{{ site.url }}database_loading.html">Database Loading</a>
222+
</li>
223+
<li class="nav-item">
224+
<a class="nav-link doc-nav-link" href="{{ site.url }}encoding_spec.html">Encoding Specification</a>
225+
</li>
226+
<li class="nav-item">
227+
<a class="nav-link doc-nav-link" href="{{ site.url }}configure_web_app.html">Configuring WebApp</a>
228+
</li>
229+
<li class="nav-item">
230+
<a class="nav-link doc-nav-link" href="{{ site.url }}query_syntax.html">Query Syntax</a>
231+
</li>
232+
<li class="nav-item">
233+
<a class="nav-link doc-nav-link" href="{{ site.url }}access_control.html">Access Control</a>
234+
</li>
236235
</ul>
237-
</div>
236+
</nav>
238237
<div class="col-sm-8 col-md-8 col-lg-7">
239-
<div class="card ps-4 pe-4 pb-4"></div>
240-
</div>
241-
</div>
242-
</div>
243-
</body>
244-
</html>
238+
<div class="card ps-4 pe-4 pb-4">

‎docs/access_control.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: How to set-up access-control
3-
---
4-
51
There are two ways to control access, user/password authentication, and ip/domain checks. You can use either separately, or both.
62

73
### Turn on access control

‎docs/configure_web_app.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: Configuring the Web Application
3-
---
4-
51
- [Layout of the Web Application](#layout)
62
- [UI configuration](#ui)
73
- [Access control](#access)
@@ -11,7 +7,7 @@ title: Configuring the Web Application
117

128
Each loaded database contains its own copy of the web application and data. Here is what the database directory looks like after a load:
139

14-
<pre><code>
10+
```
1511
database/
1612
├── app/ # Vue.js client application
1713
│ ├── src/
@@ -32,7 +28,7 @@ database/
3228
│ └── hitlists/ # Cached query results
3329
├── custom_functions/ # User-defined Python functions
3430
└── favicon.ico
35-
</code></pre>
31+
```
3632

3733
There are three main sections:
3834

‎docs/database_loading.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
---
2-
title: Database Loading
3-
---
41

52
Loading PhiloLogic databases is very straight forward, and most of the time, you shouldn't need to specify any specialized load option.
63

‎docs/encoding_spec.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: Text Encoding Specification
3-
---
4-
51
- PhiloLogic can parse non-valid XML and does not rely on an XML lib for document parsing (with the exception of the TEI Header).
62

73
- The only requirement is that files are encoded in **UTF-8**.

‎docs/index.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: What is Philologic?
3-
---
4-
51
PhiloLogic is an XML database/search engine/web app developped at the [ARTFL Project](https://artfl-project.uchicago.edu) and designed
62
for the particular difficulties of TEI XML. For a more theoretical
73
description, you can refer to [our blog](<http://artfl.blogspot.com>).

‎docs/installation.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
---
2-
title: Installation
3-
---
41

52
## Overview
63

‎docs/query_syntax.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: PhiloLogic 4 Query Syntax
3-
---
4-
51
PhiloLogic4's query syntax has 5 basic operators:
62

73
1. the plain token, essentially, any word at all, split on space, e.g. `token`

‎docs/specific_installations/macos_installation.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: Installing PhiloLogic5 on macOS
3-
---
4-
51
Tested on macOS Ventura and later (Apple Silicon and Intel).
62

73
### 1. Install System Dependencies

0 commit comments

Comments
 (0)