-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
200 lines (132 loc) · 9.09 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
=== DailyBrief ===
Contributors: dfroberg
Donation Link: https://steemit.com/@dfroberg
Tags: content+generation, generation, exxp, blockchain, hive, briefs, monetization
Requires at least: 4.7
Tested up to: 5.7
Stable tag: trunk
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
DailyBrief is a WordPress plugin that provides a post summary of all WordPress posts written a during a day.
== Description ==
DailyBrief is designed to solve two fundamental problems many new WordPress users find themselves with; first what to send people subscribing to a email newsletter and second when they first begin to publish on the blockchain; The dreaded SPAM label. Producing too many posts daily on steem hits a cultural bias many anti-abuse teams adhere to "More than 4 posts a day is always SPAM".
DailyBrief compiles a summary of all posts made during a particular day complete with featured images, meta information, and excerpts. It also creates a table of contents, inserts headers and footers with optional macros that auto-fill in article counts, tags and categories used in the processed articles.
> **Important: The plugin is primarily intended to be used alongside [Exxp](https://wordpress.org/plugins/exxp_wp/) the WordPress to Hive integration solution. If you want to publish your daily briefs to steem you need to install [Exxp](https://wordpress.org/plugins/exxp_wp/) first.**
> **Note: This plugin requires PHP 5.6 or higher to be activated.**
> **Note: Automated tests for PHP 5.6, 7.0, 7.1, 7.2, 7,3, 7.4 are made on each commit.**
> [![Build Status](https://gitlab.froberg.org/dfroberg/dailybrief/badges/master/build.svg)](https://github.com/dfroberg/dailybrief)
---
== Features ==
* Daily automated brief generated for previous day (if any posts was published that day).
* Automatic integration with your Exxp installation.
== Screenshots ==
1. Automatic Preview gives you a pretty good overview on how your post will look on Steem.
2. Table of Contents.
3. Footer and Manual Brief Generation button.
4. Options 1
5. Options 2
6. Options 3
== Languages ==
We plan to use GlotPress on WordPress.org, so if you want to translate DailyBrief to your language please [follow this guidelines](https://make.wordpress.org/polyglots/handbook/rosetta/theme-plugin-directories/=translating-themes-plugins).
== See room for improvement? ==
Great! There are several ways you can get involved to help make Dailybrief better:
1. **Report Bugs:** If you find a bug, error or other problem, please report it! You can do this by [creating a new topic](http://wordpress.org/support/plugin/dailybrief) in the plugin forum. Once a developer can verify the bug by reproducing it, they will create an official bug report in GitHub where the bug will be worked on.
2. **Suggest New Features:** Have an awesome idea? Please share it! Simply [create a new topic](http://wordpress.org/support/plugin/dailybrief) in the plugin forum to express your thoughts on why the feature should be included and get a discussion going around your idea.
3. **Check out our Github:** Take a look at the code; [GitHub](https://github.com/dfroberg/dailybrief)
Thank you for wanting to make DailyBrief better for everyone! [We salute you](https://www.youtube.com/watch?v=8fPf6L0XNvM).
== Frequently Asked Questions ==
= Can daily briefs be generated via WP CLI? =
Yes, check [WP-CLI-README](https://github.com/dfroberg/dailybrief/blob/master/WP-CLI-README.md) to learn how.
= Can I temporarily disable generation of daily briefs? =
Yes, go to settings and set pause to Yes.
= Can I generate daily briefs as drafts? =
Yes, go to settings and set publish to No.
= If I haven't written any posts will Daily Brief publish empty briefs? =
No, if it detects that there is nothing to summarize it will skip post creation.
= Can I create the Briefs manually and not rely on CRON jobs? =
Yes, Set "CRON Pause" to on and use the preview windows "Generate Now" button to create the briefs.
= How do I fix 404 / page not found when clicking on a post link in a brief? =
Take a look at the URL Suffix '?campaign=xxxxx' etc and prefix it i.e. '?utm_campaign=xxxxxx' and see if it helps, there is a slew of reserved parameters that is a terrible idea to use; [Reserved Terms](https://codex.wordpress.org/Reserved_Terms), many plugins also take ownership of specific parameters, so a bit of trial and error might be required. **Test links in your Preview**.
== Changelog ==
= 1.1.05 — 2 of June, 2021 =
* Fixed some stability issues in debug information.
= 1.1.01 — 1 of June, 2021 =
* Fixed typo in Helper plugin detection
= 1.1.00 — 27 of May, 2021 =
* Replaced integration of SteemPress with Exxp 2.6.8 plugin, plus added warnings if SteemPress plugin is still in use and disable publishing if that is the case.
= 1.0.40 — 3 of March, 2021 =
* Compatibility check with WP 5.5
= 1.0.39 — 24 of August, 2020 =
* Compatibility check with WP 5.5 and SteemPress 2.6.3.
= 1.0.38 — 11 of June, 2020 =
* Compatibility check with WP 5.4.2 and SteemPress 2.6.3.
= 1.0.37 — 8 of January, 2020 =
* Compatibility check for WP 5.3 and SteemPress 2.6.
= 1.0.36 — 30 of September, 2019 =
* Compatibility check for WP 5.2.3 and SteemPress 2.6.
= 1.0.35 — 10 of June, 2019 =
* Compatibility check for WP 5.2.1 and SteemPress 2.4.1.
= 1.0.34 — 5 of April, 2019 =
* Fix: More workarounds setting featured image of the post dynamically while using CDN etc.
= 1.0.33 — 4 of April, 2019 =
* Fix: Workaround for catching and setting featured image of the post dynamically while using CDN etc.
= 1.0.32 — 3 of April, 2019 =
* Fix: Show warning in debug screen if steempress is detected and post is too large.
= 1.0.31 — 1 of April, 2019 =
* Fix: Ensure character limit is only respected if SteemPress is installed and active, as there are other uses for DailyBrief.
* Add: Enable or Disable Article title links.
* Fix: Strip shortcodes from excerpts.
* Fix: Some display fixes in preview and generated posts.
* Fix: Make sure your text is smaller than 65280 characters.
= 1.0.30 — 18 of March, 2019 =
* Fix: Debug aside covered options screens on small screen devices.
* Fix: Fixed select2 JS error on multiple=true and removed it since it's not needed.
= 1.0.29 — 7 of March, 2019 =
* New: Enabled select2 & multiple focus categories.
= 1.0.28 — 26 of February, 2019 =
* Fix: Filled out some more information on how to get support.
= 1.0.27 — 26 of February, 2019 =
* Fix: To avoid conflicts change the default url suffix from campaign to utm_campaign, there seems to conflicts where campaign parameter causes 404's.
= 1.0.26 — 22 of February, 2019 =
* Fix: Add extra checks for missing CRON job, plugin not activated properly or upgraded without activate/deactivate.
= 1.0.25 — 22 of February, 2019 =
* Fix: Ensuring compatibility with Windows 5.1
* Fix: More preview window style fixes.
* New: Added generate manually now button to Preview window for those that really want to do things manually.
* Fix: An logical error in CRON pause resolved.
= 1.0.24 — 21 of February, 2019 =
* Fix: Rework Admin GUI & Try getting the timezone to display properly.
* Add: Make sidebar display debug information of Debug option is on.
= 1.0.23 — 20 of February, 2019 =
* Fix: Date selection for periods and single day to include hours
* Fix: Reorder Period selection fields plus adding more verbose debug information.
* Fix: Category exclusions
* Fix: Add new options to Internal CRON job.
= 1.0.22 — 19 of February, 2019 =
* Fix: Admin GUI layout and position of options.
* Fix: WP Cron activator / de-activator.
* New: Make cron_pause an option, pause post creation, this will skip post creation entirely.
= 1.0.21 — 14 of February, 2019 =
* Fix: Add try catch for scheduling timestamp in cron.
* New: Make cron_publish an option, this is practical if you're not quite ready with your setup or wish to pause creation of daily briefs.
= 1.0.20 — 13 of February, 2019 =
* Fix: Set internal CRON to fire "tomorrow" after midnight taking WP timezone into consideration.
= 1.0.19 — 8 of February, 2019 =
* New: Implement internal CRON to fire once a day for now. Should suffice for basic usage.
= 1.0.18 — 8 of February, 2019 =
* New: Implement focus category setting; Enable briefs about a particular subject.
= 1.0.17 — 8 of February, 2019 =
* Fix: Ensure that the category you post Daily Briefs to is always skipped from daily brief sourcing.
* Fix: User names now full names for readability on settings screens.
= 1.0.16 — 7 of February, 2019 =
* Improvement: Added Admin GUI preview for Dailybrief posts (steemit:ish version).
= 1.0.0 — 4 of January, 2019 =
* Improvement: Added Admin GUI for settings.
= 0.0.9 — 17 of December, 2018 =
* First initial WP_CLI version.
== Roadmap ==
* Multi-user functionality to work with StemPress 2.3+
* Multi-focus categories.
* Multi-period support; daily, weekly, monthly briefs.
* Ajaxify the options panel to make things a lot easier!!!
* High frequency post sites support for sites that requires multiple briefs per day.