/
README.txt
138 lines (105 loc) · 5.81 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
=== DocuPress ===
Contributors: deviodigital
Donate link: https://deviodigital.com
Tags: documentation, docs, kb, knowledgebase, help, support, documents, notes
Requires at least: 3.0.1
Tested up to: 6.2.2
Stable tag: 3.0.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Documentation Simplified.
== Description ==
**DocuPress** helps you create your own documentation directly within your WordPress dashboard.
Separate your articles into collections, making it easy for users to browse only the content they're looking for.
### Includes new Gutenberg block, widgets, and a shortcode
**DocuPress** includes a Gutenberg block to display your articles within the new WordPress editor.
Included block options:
* Article Count
* Display style (grid/list)
* Display by Collection
* Display or hide featured image
* Display or hide excerpt
See the screenshots for various examples of the block in action
**DocuPress** also includes the `[docupress]` shortcode, making it easy to include a list of articles anywhere on your site.
Full list of shortcode options: `[docupress limit="99" collections="" order="" viewall="on"]`
**DocuPress** also includes 3 custom widgets:
* **Collections** - output's a list of every collection you create with DocuPress.
* **Recent Articles** - select how many articles to display, randomize the output order and also choose which collection you'd like to display articles from.
* **Related Articles** - select how many articles to display and randomize the output order in this widget that will only display when viewing a single article.
### Translations
Currently, **DocuPress** comes prepackaged with the following translations:
* English
* Spanish
* French
* Italian
* Hindi
Please [let us know](https://www.deviodigital.com/contact/) if there's a language you'd like to see **DocuPress** translated to next.
== Installation ==
1. Go to `Plugins - Add New` in your WordPress admin panel and search for `DocuPress`
2. Install and activate the plugin directly in your admin panel
3. Pat yourself on the back for a job well done :)
== Screenshots ==
1. DocuPress single article display
2. DocuPress "Documentation" tab in the admin dashboard
3. Gutenberg Block - Grid display (back-end)
4. Gutenberg Block - Grid display (front-end)
5. Gutenberg Block - List display (back-end)
6. Gutenberg Block - List display (front-end)
== Changelog ==
= 2.3.0 =
* Added new Hindi translation in `languages/docupress-hi_IN.pot`
* Updated various security related issues found with [Codacy](https://codacy.com) throughout multiple files in the plugin
* General code cleanup throughout multiple files in the plugin
= 2.2.1 =
* Actually added the new French translation in `languages/docupress-fr_FR.pot`
* Actually added the new Italian translation in `languages/docupress-it_IT.pot`
* Updated text strings for localization in `languages/docupress.pot`
* Updated various styles in `public/css/docupress-public.css`
* General code cleanup throughout multiple files in the plugin
= 2.2 =
* Added new Spanish translation in `languages/docupress-es_ES.pot`
* Added new French translation in `languages/docupress-fr_FR.pot`
* Added new Italian translation in `languages/docupress-it_IT.pot`
* Updated text strings for localization in `languages/docupress.pot`
= 2.1 =
* Added new Spanish translation in `languages/docupress-es_ES.pot`
* Updated text strings for localization in `languages/docupress.pot`
= 2.0 =
* Added "Was this article helpful?" section to the bottom of single articles in `admin/docupress-article-ratings.php`
* Added an estimated reading time to the beginning of single articles in `admin/docupress-article-ratings.php`
* Added 2 filters to the `[docupress]` shortcode in `admin/docupress-shortcodes.php `
* Updated shortcode list style in `public/css/docupress-public.css`
* Updated activator and deactivator class names in `docupress.php`
* Updated metabox with checkbox to hide estimated reading time in `admin/docupress-metaboxes.php`
* Updated `.pot` file for translation in `languages/docupress.pot`
* General code cleanup throughout multiple files in the plugin
= 1.3 =
* Added new `[docupress]` shortcode in `admin/docupress-shortcodes.php`
* Updated `.pot` file for translation in `languages/docupress.pot`
* General code cleanup throughout multiple files in the plugin
= 1.2.2 =
* Bugfix removed rest_base and rest_controller_class from custom post type in `admin/docupress-cpt.php`
* Updated code to escape input data for path and url in `admin/docupress-metaboxes.php`
* Updated check to hide undefined variable name notice in `admin/docupress-metaboxes.php`
* Updated code to Change names based on custom permalink based in `admin/docupress-cpt.php`
* General code cleanup in `public/class-docupress-public.php`
= 1.2.1 =
* Bugfix misspelled ID for noncename verification in `admin/docupress-metaboxes.php`
* Updated function names with all lowercase letters in `admin/docupress-cpt.php`
* Updated function names with all lowercase letters in `admin/docupress-taxonomies.php`
* Updated cpt and tax function names in activator in `includes/class-docupress-activator.php`
* Updated text strings for localization in `admin/docupress-metaboxes.php`
* Updated text strings for localization in `admin/docupress-widgets.php`
* Updated `.pot` file for translation in `languages/docupress.pot`
* General doc clean up throughout various files
= 1.2 =
* Added new Collections widget
* Added new Additional Details metabox for articles
* Added custom permalink settings to change article base
= 1.1.0 =
* Removed comment capabilities
* Updated call constructor method for the DocuPress widget
* Updated `get_bloginfo()` instance to URL instead of HOME
* Added `global $post;` and `wp_reset_postdata();` to the widget query
= 1.0 =
* Initial release