This repository has been archived by the owner on May 4, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
116 lines (81 loc) · 4.33 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
=== Openstax Import for Pressbooks ===
Contributors: BCcampus
Tags: pressbooks, openstax, textbook, import
Requires at least: 5.1.1
Tested up to: 5.1.1
Stable tag: 1.3.3
Requires PHP: 7.1
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html
A WordPress plugin that extends [Pressbooks](https://github.com/pressbooks/pressbooks) to let you import books from OpenStax.
== Description ==
Adds an option to the Pressbooks import tool named `Zip (OpenStax zip file)`. This new option asks for a link of the OpenStax Zip file. (You can get the link from the downloads section of the OpenStax book you'd like to import.)
**Primary Use Case**
This plugin was built primarily to support the creation, remixing, and distribution of open textbooks.
**Development Sprint**
The inspiration for this plugin came from wanting to improve our own process for bringing in OpenStax Textbooks. In the fall of 2016 a Development Sprint was held in Houston at Rice University. One of the goals of the sprint
was to be able to find a programmatic solution to the problem of converting equations during the import process. The XSL files by Vasil Yaroshevich are the key component used to convert equations to something that can be rendered in Pressbooks.
== Installation ==
IMPORTANT!
You must first install [Pressbooks](https://github.com/pressbooks/pressbooks). This plugin won't work without it.
The Pressbooks github repository is updated frequently. [Stay up to date](https://github.com/pressbooks/pressbooks/tree/master).
ALSO IMPORTANT!
The value of this plugin is it's ability to transform MathML to LaTeX. Rendering that LaTeX in the browser requires a separate piece of functionality. The best results for rendering LaTeX equations in the browser is with [WP QuickLaTeX](https://wordpress.org/plugins/wp-quicklatex/). For best results, use that plugin and activate at the book level. The built-in LaTeX rendering functionality in Pressbooks still works, but does not have as robust support for multi-line equations.
== Frequently Asked Questions ==
**What is an Open Textbook?**
Open Textbooks are open educational resources (OER); they are instructional resources created and shared in ways so that more people have access to them.
OER are defined as “teaching, learning, and research resources that reside in the public domain or have been released under an intellectual property license that permits their free use and re-purposing by others” (Hewlett Foundation).
== Screenshots ==
1. This new option asks for a link of the OpenStax Zip file
== Changelog ==
See: https://github.com/BCcampus/pressbooks-openstax-import/commits/dev for more detail
= 1.3.3 2019/04/12 =
* compatibility with PB 5.7.0
= 1.3.2 2018/11/20 =
* compatibility with PB 5.6.3
= 1.3.1 2018/11/20 =
* [bug] fix images with spaces in file name
* [bug] fix footnote references
* compatibility with PB 5.6.0
= 1.3.0 2018/10/16 =
* removed problematic dependency
* enforced coding standards on travis build
= 1.2.5 2018/10/16 =
* compatibility with pb 5.5.3
* fixed odd line breaks (props @greatislander and @connerbw)
= 1.2.4 2018/08/09 =
* convert iframes to [embed] tags (props @greatislander)
* move admin notices into accessible area (props @greatislander)
* apply coding standards
* update dependencies
* compatible with PB 5.4.5
= 1.2.2 2018/07/12 =
* clean up php warnings
* apply coding standards
* fix persistent msg bug
* compatible with PB 5.4.0
= 1.2.1 2018/06/19 =
* better dependency management
= 1.2.0 2018/05/11 =
* add notification at time of import
* allow admins to activate wp-quicklatex if installed
* display helpful error messages if import fails
= 1.1.1 2018/04/06 =
* fix upload zip file functionality
= 1.0.1 2018/03/15 =
* minor update to label
* add PB compatibility declaration
= 1.0.0 2018/02/27 =
* compatibility with PB 5
= 1.0.0-rc.1 2018/02/23 =
* compatibility with PB 5
= 0.1.3 2017/10/26 =
* fixed an issue where front-matter and back-matter were not importing
* modified autogenerated [link] text to (Figure)
* changed network admin notice, better to activate WP QuickLaTeX at book level
* removed chapter metadata from import
= 0.1.0 2017/08/30 =
* initial release...early, often
= 0.1.0-RC1 =
* Release Candidate
* Will work with >= v4.0.0 of Pressbooks