-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreadme.txt
165 lines (106 loc) · 6.14 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
=== Smarter Archives ===
Contributors: rob1n
Tags: archives, archive
Tested up to: 5.5
Stable tag: 3.2.5
Easily navigate the yearly and monthly archives of your blog.
== Description ==
When you use the `[smarter-archives]` shortcode anywhere in a post or a page, it gets replaced by a listing of every year since you started posting, with a list of links to each month for that year. However, the plugin is smart enough to know if you didn't create any content in any given month, and doesn't make a link for that month. See the **Screenshots** section for an example of it in action.
See the **Usage** section for a complete list of the arguments the shortcode takes, and how you can use them to customize your archives listing.
The month names are [internationalized with the WordPress translation API](http://codex.wordpress.org/I18n_for_WordPress_Developers). A POT file is included, and if you want to translate please feel free to do so and [submit a new pull request](https://github.com/robinadr/smarter-archives/pulls) on GitHub. If you do not know how to use GitHub, you can also [contact me directly](http://robinadr.com/contact). Here are the translations that have been done so far:
* Dutch (nl_NL)
* French (fr_FR)
* German (de_DE)
* Italian (it_IT)
* Spanish (es_ES)
* Russian (ru_RU)
The original concept for this plugin comes from a plugin by Justin Blanton.
== Screenshots ==
1. An example of the plugin in action on my website.
== Installation ==
1. Download the ZIP file and unzip it
2. Copy or upload the `smarter-archives` folder to your plugins folder (usually `wp-content/plugins/`)
3. Activate *Smarter Archives* in the admin
4. Put the `[smarter-archives]` shortcode where you want the listing to show
5. Enjoy.
== Usage ==
The `[smarter-archives]` shortcode takes these arguments (default values included):
* `mode` (default: `output`) -- if it's set to `output`, the plugin prints the listing. Set it to `false` to return the value
* `wrapper_class` (default: `smart-archives`) -- class given to the tag wrapped around the listing (`<div>` by default)
* `wrapper_tag` (default: `div`) -- tag wrapped around the listing
* `year_link_class` (default: `year-link`) -- class given to each year links
* `year_tag` (default: `p`) -- tag around each year group
* `year_class` (default: none) -- class for the tag around each year group
* `after_year` (default: `: `) -- value after the year and before the list of months
* `month_link_class` (default: `month-link`) -- class given to each month link
* `month_tag` (default: `span`) -- tag around each month
* `after_month` (default: ` `) -- spacer between months
* `empty_month_class` (default: `empty-month`) -- class applied to empty months (can use this to gray them out)
* `order` (default: `DESC`) -- order the years are shown in (`ASC` for ascending, `DESC` for descending)
**Advanced Usage**
There is a function, `get_smarter_archives()`, that returns the raw array with the years, months, and post counts. You can use this for ultimate customization.
**Example Usage**
[smarter-archives order="DESC" after_month="•"]
== Changelog ==
= 3.2.5 =
* Fix issue with setting default options in shortcode
* Updated compatibility up to WordPress 5.5
= 3.2.4 =
* Added Russian (ru_RU) translation, thanks to [Alexander Tischenko](http://n-wp.ru/)
= 3.2.3 =
* Added German (de_DE) translation, thanks to Jay Linski (@jaylinski)
= 3.2.2 =
* Updated Italian translation
* Added Dutch (nl_NL) translation, thanks to Micha
= 3.2.1 =
* Fixed bug involving [extra empty months](https://github.com/robinadr/smarter-archives/issues/2)
= 3.2 =
* Fixed bug related to the new i18n changes in WordPress 4.0
= 3.1.3 =
* [Fixed bug](https://github.com/robinadr/smarter-archives/issues/1) relating to an extra quote in month links
= 3.1.2 =
* Added French (fr_FR) translation, thanks to [Jean-Hugues Roy](http://jhroy.ca/)
This update is **optional**, the only change is the new French translation.
Also, note that development is now on [GitHub](https://github.com/robinadr/smarter-archives). Releases will continue to be pushed through the WP plugin repository, however.
= 3.1.1 =
This update is **optional** for everyone, unless you want the new Italian translation. If not, feel free to skip it.
* New translation: Italian (it_IT) courtesy of [Marco Zambianchi](http://www.astronautinews.it/)
= 3.1 =
* Only load textdomain if WPLANG is defined AND not empty
= 3.0 =
* Backend is **completely rewritten: only 1 query compared to 12 for every year before** (!!)
* Optimizations everywhere
* New option: `year_class` (see Usage for more info)
* Updated compatibility to WP 3.8
* Updated es_ES translation to include new strings
= 2.6 =
* Standardized i18n calls -- **fully translatable**
* Added a POT file for translating
* Added a lang folder
* **Spanish (es_ES) translation added** -- thanks to [Andrew Kurtis of WebHostingHub](http://www.webhostinghub.com/)
* **New shortcode**: `[smarter-archives]`, see Usage for more details
* Fixed bug: `order` now actually does something
= 2.5 =
[View changes for 2.5 here](http://robinadr.com/2013/04/smarter-archives-2-5).
= 2.0.1 =
* Updated WordPress compatibility to 3.5.1
= 2.0 =
* Updated WordPress compatibility to 3.5
* Main function's output is now completely customizable
* i18n support added; English domain included
* Smarter Archives is now licensed under the GPL v2 license
= 1.5 =
* Updated WordPress compatibility to 3.4.2
== License ==
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
A full version of the license is included with the plugin in `license.txt`.