forked from quantum-journal/o3po
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
138 lines (99 loc) · 6.27 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# O-3PO
[](https://travis-ci.org/quantum-journal/o3po) [](https://codecov.io/gh/quantum-journal/o3po) [](https://github.com/quantum-journal/o3po/blob/master/license.txt)
* Contributors: cgogolin, johannesjmeyer, drever
* Donate link: https://quantum-journal.org/donate/
* Tags: publishing, open-access
* Requires at least: 4.0.1
* Tested up to: 5.2.1
* Requires PHP: 5.6
* Stable tag: 1.0.0
* License: GPLv3 or later
* License URI: http://www.gnu.org/licenses/gpl-3.0.html
O-3PO stands for Open-source Open-access Overlay Publishing Option, it intends to make publishing of open-access arXiv overlay journals on WordPress powered websites as easy as possible.
O-3PO powers the website of [Quantum - the open journal for quantum science](https://quantum-journal.org/) and was originally developed for this purpose.
## Warning
This is beta software, which still may contain site-specific and/or not well tested code.
## Description
O-3PO offers the following features:
* Automatic download of LaTeX source code and PDF from the arXiv
* Automatic extraction of meta-data
* Automagic interpretation of references and DOI links
* DOI registration at and cited-by retrieval from [Crossref REST API](https://api.crossref.org/)
* Meta-data deposition at the [DOAJ API](https://doaj.org/api/v1/docs)
* Article source and pdf download as well as meta-data extraction from, and journal reference feed for the [arXiv](https://arxiv.org/help/api/index)
* Meta-data and full text deposition in the [CLOCKSS](https://www.clockss.org/clockss/Home) archive
* Posting of updates on publications to the [Buffer.com](https://buffer.com/app) queue
* Linking to [Fermat's library](https://fermatslibrary.com/)
* Cited-by information retrieval from [NASA ads](https://ui.adsabs.harvard.edu/)
* Merging of cited-by information from multiple sources and bibliometrics calculation
* Automatic and customizable emails for author communication
* Search centered navigation of articles
* Integration of publications in to RSS feed
* Presentation of journal content by volume
* Web-statement endpoint for the verification of licenses
* Transformation of \cite commands into hyperlinks referencing bibliography items
## Works best with
* [OnePress theme](https://www.famethemes.com/themes/onepress/)
* [Relevanssi](https://wordpress.org/plugins/relevanssi/)
In fact, certain features of O-3PO may only work correctly in conjunction with the OnePress theme.
## Installation
1. Git clone this repository via: `git clone https://github.com/quantum-journal/o3po.git`
2. Copy the `o3po` directory into your `wp-content/plugins/` directory.
3. Activate the plugin through the Plugins menu of WordPress.
## Installation
O-3PO uses the PHPUnit testing framework. You can run all tests locally by executing `make test`.
## Documentation
Please refer to the [online documentation](https://quantum-journal.github.io/o3po/) to learn about the implementation.
The documentation can be build locally by running `make docs`.
## Bugs, limitations, and to do
* Move fix_custom_logo_html into separate plug-in
* Move remaining onepress related customizations into a separate plug-in
## Frequently Asked Questions
### Why should I use O-3PO?
O-3PO is open source, actively maintained, and allows you to combine all the features of a professional publishing platform, with exactly the integrations an arXiv overlay journal needs, with the power of the worlds most popular blogging platform.
### Why the name O-3PO?
It is obviously a play on the name of humanoid robot character from a series of popular science fiction movies, whose primary purpose is to assist people in their communication, just like this plugin.
## Screenshots
1. Various settings can be customized via the settings.
## Changelog
### 0.3.1
* Uncluttered RSS feed content
* Use button instead of form/input elements for action buttons (full text, print, ...)
* improved generation of Trackbacks
* Fixed truncation of formulas when creating excerpts
* Extract DOIs from ULRs as a fallback also from BibLaTeX bibliographies
* Minor bug fixes
### 0.3.0
* Added maintenance mode.
* O-3PO is now largely theme independent.
* Settings page completely redesigned.
* Email templates and various other aspects of the plugin are now customizable.
* Tweaked appearance of publications.
* Code quality and test coverage improved.
* Improved cited-by data parsing.
* Support for buffer.com https api
* Greatly improved documentation of settings
* Better test coverage
* Support for \cite commands and improved parsing of \affiliation macros
### 0.2.2
* Settings page now uses password text fields for sensitive settings.
* Fixed file name of full text pdf download.
### 0.2.1
* Fix for an additional incompatibility with PHP >=7.1.
* Restrict visible indication of test system to adminbar to allow setup on production system.
### 0.2.0
* Now compatible with and tested on multiple PHP versions ranging from 5.6 to 7.2.8.
* CLOCKSS interface activated.
* Search page template with extra feedback to users can now be deactivated in settings.
* Many smaller bug fixes.
* Test coverage massively increased.
### 0.1.0
* First publicly available version.
## License
The WordPress Plugin O-3PO is licensed under the GPL v3 or later.
> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.
> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
> You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
A copy of the license is included in the root of the plugin’s directory. The file is named `license`.
## Credits
This plugin is based on the structure provided by the [WordPress-Plugin-Boilerplate](https://github.com/DevinVinson/WordPress-Plugin-Boilerplate/tree/master/plugin-name).