forked from BCcampus/pressbooks-textbook
/
README.txt
229 lines (172 loc) · 8.46 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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
=== PressBooks Textbook ===
Contributors: bdolor
Donation link: https://github.com/BCcampus/pressbooks-textbook/wiki/Contribution-guidelines
Tags: pressbooks, textbook
Requires at least: 4.1.4
Tested up to: 4.2.2
Stable tag: 1.2.14
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
PressBooks Textbook adds functionality to the PressBooks plugin to make it easier to author textbooks.
== Description ==
**PressBooks Textbook** adds functionality to PressBooks to make it easier to author textbooks as well. The features it currently offers are:
* Textbook Theme
* TinyMCE table buttons
* TinyMCE textbook buttons
* TinyMCE spell check
* TinyMCE anchor button
* Search functionality
* Creative Commons license attribution
* Prominent admin buttons (Import, Plugin)
* Annotation functionality
* Optionally redistributing free, digital versions of your book.
* Download links to openly licensed textbooks, ready to remix.
* A remix 'eco-system' — Search and Import chapters from both local and remote instances of PressBooks
* Disable/enable comments
Textbooks have functional and styling considerations above and beyond regular books. Open textbooks are those that are licensed with a [creative commons license](http://creativecommons.org).
This plugin was built primarily to support the creation, remixing and distribution of open textbooks for the [open textbook project in BC](http://open.bccampus.ca/about-2/).
== 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).
Most of the functionality of this plugin, like search, textbook buttons and annotation are tied directly to the `Open Textbooks` theme. Network Activate the `Open Textbooks`
theme, then activate at the book level. You'll have access to those features and more.
= Using Git =
1. cd /wp-content/plugins
2. git clone https://github.com/BCcampus/pressbooks-textbook.git
3. Activate the plugin at the network level, through the 'Plugins' menu in WordPress
4. Activate the `Open Textbooks` theme at the network level
5. Activate the `Open Textbooks` theme at the book level.
= OR, go to the WordPress Dashboard =
1. Navigate to the Network Admin -> Plugins
2. Search for 'PressBooks Textbook'
3. Click 'Network Activate'
4. Activate the `Open Textbooks` theme at the network level
5. Activate the `Open Textbooks` theme at the book level.
= OR, upload manually =
1. Upload `pressbooks-textbook` to the `/wp-content/plugins/` directory
2. Activate the plugin at the network level, through the 'Plugins' menu in WordPress
3. Activate the `Open Textbooks` theme at the network level
4. Activate the `Open Textbooks` theme at the book level.
== FAQ ==
= 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.
That’s a different model than traditionally-copyrighted materials.
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).
= How do you make a Textbook 'Open'? =
When creating Open Textbooks and other OERs, we feel it is best to adhere to the five Rs of open education as defined by David Wiley, which are:
1. Retain – i.e. no digital rights management restrictions (DRM), the content is yours to keep, whether you’re the author, instructor or student.
2. Reuse – you are free to use materials in a wide variety of ways without expressly asking permission of the copyright holder.
3. Revise – as an educator, you can adapt, adjust, or modify the content to suit specific purposes and make the materials more relevant to your students. This means making it available in a number of different formats and including source files, where possible.
4. Remix – you or your students can pull together a number of different resources to create something new.
5. Redistribute – you are free to share with others, so they can reuse, remix, improve upon, correct, review or otherwise enjoy your work.
== Screenshots ==
1. Modified home page
2. Search feature
3. Textbook specific buttons with styling maintained throughout export routines
4. Textbook theme
5. Customize your plugin options for each book in your collection
== Changelog ==
See: https://github.com/BCcampus/pressbooks-textbook/commits/master for more detail
= 1.2.14 (2015/08/10) =
* minor tweaks
* migrating more functionality to PB
= 1.2.13 (2015/07/16) =
* migrating some functionality to PB
= 1.2.11/12 (2015/07/13) =
* fix for download link to mPDF on homepage
= 1.2.10 (2015/07/09) =
* styling change for tables in admin interface
* migration of table functionality to PB
= 1.2.9 (2015/06/22) =
* add style for tight/loose tracking
* left align h3 tags
* support for disabling social media buttons
* bug fix for search and import
= 1.2.8 (2015/05/28) =
* bug fix
= 1.2.7 (2015/05/26) =
* add search and import feature for remote instances of PB
= 1.2.6 (2015/04/21) =
* patch potential xss attack vector
* adding accessibility button to theme
* update pdf export to work with new luther parent theme
* remove automatic theme switch on book creation due to inconsistent behaviour
* fix php notice messages in search and import
* fix syntax error in search and import
= 1.2.5 (2015/03/11) =
* add table cell border to web and print
* fix default theme on new book creation
* add part title to web view
* fix latest exports returning empty on book titles with periods
* stability/logic improvements
= 1.2.3 (2015/01/12) =
* updating ccc documentation
* adding sub/sup buttons to tinymce
* css styles to support Jack!
* add optional (piwik/google) analytics event tracking code
* improvements to textbook download page
= 1.2.2 (2014/10/30) =
* hotfix for inconsistent behaviour on default activation of theme
= 1.2.1 (2014/10/29) =
* changes placement of export files on homepage
* fix for license picker in textbook downloads
* fix for running header in pdf output (thanks Jack!)
* adding default book options on new book creation
= 1.2.0 (2014/10/15) =
* adds ability to enable/disable comments
* modifies term 'chapter' to 'page'
* adds contributing authors to the homepage
* moves location of the plugin settings
* moves location of textbook downloads, for greater access
= 1.1.7 (2014/09/22) =
* adds the ability to search and import chapters from within your own instance of PB
= 1.1.6 (2014/08/27) =
* updating tinymce table plugin to latest version
* updating tinymce spellcheck plugin to latest version
= 1.1.5 (2014/07/22) =
* adding anchor button to TinyMCE
* preserving microdata in post save
= 1.1.4 (2014/07/16) =
* adding more LRMI microdata
* support for PB license module
* CSS updates for export files
= 1.1.3 (2014/06/18) =
* adding LRMI microdata
= 1.1.1 (2014/06/17) =
* adding support for vanilla WP export
* fix early morning spelling error
= 1.1.0 (2014/06/12) =
* adding news feed to admin dashboard
* updating mce table buttons plugin
* dependency injection, caching added to remix tab
= 1.0.9 (2014/05/30) =
* adding copyright description to cover page
* CSS updates for mobile devices
= 1.0.8 (2014/05/06) =
* adding spell check to tinyMCE
* fix for checking active plugins at book level
* disable including license in feeds (for a valid EPUB export)
= 1.0.7 (2014/05/02) =
* fix filtering of root child themes (thanks John!)
* tested up to WP 3.9
= 1.0.6 (2014/04/11) =
* fixing filter function to ameliorate conflicts with already active plugins.
= 1.0.5 (2014/04/04) =
* adding download links to 31 openly licensed textbooks in various digital formats. Remix!
= 1.0.4 (2014/04/03) =
* fixing redistribution of export files option on home page, requires re-setting if previously set
= 1.0.3 (2014/04/01) =
* updating and fixing mce table plugin
= 1.0.2 (2014/03/31) =
* choose which plugins you want to include
* adding tabs to plugin options page
= 1.0.1 (2014/03/18) =
* annotation capabilities
* administration menu page
* Redistribution capabilities for free, digital versions of your book
= 1.0.0 (2014/03/13) =
* initial release
== How to contribute code ==
Pull requests are enthusiastically received **and** scrutinized for quality.
* The best way is to initiate a pull request on [GitHub](https://github.com/BCcampus/pressbooks-textbook).