forked from gambitph/Titan-Framework
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
397 lines (327 loc) · 14.9 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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
=== Plugin Name ===
Contributors: bfintal
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D2MK28E7BDLHC
Tags: framework, options, admin, admin panel, meta box, theme customizer, option framework, library, sdk, edd, settings, api, theme creator, theme framework
Requires at least: 4.1
Tested up to: 4.9.6
Stable tag: 1.12.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Create Settings for Your WordPress Themes & Plugins with Just a Few Lines of Code.
== Description ==
Titan Framework allows theme and plugin developers to create admin pages, options, meta boxes, and theme customizer options with just a few simple lines of code.
This means faster theme & plugin creation for everyone.
[What is Titan Framework and how does it work?](http://www.titanframework.net/what/)
= The Goal =
Titan Framework aims to be easily used by everyone. The goal is to make it plug and play - just activate the plugin and start creating your options.
[How to start developing with Titan Framework](http://www.titanframework.net/how/)
* [Join the Community in Slack](https://gambit-slackin.herokuapp.com/)
* [Documentation and Tutorials for Developers](http://www.titanframework.net/docs)
* [Titan Framework GitHub Repository](https://github.com/gambitph/Titan-Framework)
* [Issue Tracker](https://github.com/gambitph/Titan-Framework/issues)
= Start Creating Your Theme =
[You can generate your own Underscores based theme with Titan Framework through our site](http://www.titanframework.net/)
The generated theme comes with sample pre-created options in the admin and theme customizer along with code documentation.
= Features =
* Makes development unbelievably easy
* Built with optimization in mind
* Does NOT clutter the database
* Integrates with your project seamlessly
* Theme customizer live preview integration
* Supports child themes
* Automatic CSS generation with SCSS support
* Full font style fields
* Easy Digital Download activation integration
= Easy creation of: =
* Admin menus and submenus
* Admin pages
* Admin options and tabs
* Meta boxes and options
* Theme customizer sections and options
= Options available in admin pages, meta boxes and theme customizer: =
* Ajax button
* Checkbox
* Code (using [Ace](http://ace.c9.io/#nav=about))
* Color picker
* Custom
* Date
* EDD License (Easy Digital Downloads license)
* Editor (WYSIWYG)
* Enable
* File upload
* Font Style (Web safe fonts and Google WebFonts)
* Gallery
* Group
* Heading
* Iframe
* Media uploader
* Multicheck
* Multicheck categories and taxonomies
* Multicheck pages and posts
* Multicheck post types
* Note
* Number
* Radio buttons
* Radio palette picker
* Radio image
* Save and reset buttons
* Select (drop down)
* Select Google WebFont
* Select categories and taxonomies
* Select pages and posts
* Select post types
* Sortable
* Text
* Textarea
= Supporting the Framework =
Titan is super new, so far the framework has been getting good feedback from the community. Help out and spread the word by starring this repo, sending tweets, writing blog posts about what you think about Titan, and [review the plugin](http://wordpress.org/support/view/plugin-reviews/titan-framework).
= Help Translate =
We want Titan Framework to be used by everyone, and since not everyone speaks or reads english, we would appreciate it if you can [help translate the framework to your language](https://www.transifex.com/projects/p/titan-framework/).
= Currently translated to =
* French (thanks @PunKeel)
* German (thanks @jascha)
* Italian (thanks @DavideVogliotti & Giuseppe Pignataro)
* Portuguese (thanks @pagelab)
* Spanish (thanks @maperezotero)
* Turkish (thanks @gurkankara)
= Donate to the Development =
If Titan Framework has helped you in any way, we would appreciate any amount of donations that you give us. Donations would mean more development time for the framework as I am continuously developing it during my free time.
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9X7HJBGJ37VH6)
= Special Thanks to all the Contributors =
@ahansson89, @ahmadawais, @ardallan, @BrazenlyGeek, @csloisel, @DavideVogliotti, @davidossahdez, @desaiuditd, @dovy, @fabiorphp, @iografica, @jaeh, @kevinlangleyjr, @manishsongirkar, @mendezcode, @MickeyKay, @nemke, @sagarjadhav, @smccafferty, @tojibon
and to everyone else in the GitHub repo!
== Installation ==
1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Use the provided classes and functions in your theme or plugin. Read our guide on how to [Get Started with Titan Framework](http://www.titanframework.net/how/)
== Frequently Asked Questions ==
* [Site FAQs](http://www.titanframework.net/faqs/)
* [Documentation and Tutorials for Developers](http://titanframework.net)
* [Titan Framework GitHub Repository](https://github.com/gambitph/Titan-Framework)
* [Issue Tracker](https://github.com/gambitph/Titan-Framework/issues)
== Upgrade Notice ==
== Screenshots ==
1. An admin page with tabs and options created using Titan Framework
2. Supports theme customizer sections, options and live previewing
3. Meta box support for pages, posts and custom post types
4. Sample code on how to create admin pages and options
== Changelog ==
= 1.12.2 =
* New: Added support for `menu_title` argument on AdminPage
* New: Adds `query_args` argument to select-posts
* Fixed: Quick edit ajax saving with a post meta box added results in a forbidden error
* Fixed: Date type default value non well formed
= 1.12.1 =
* Fixed: Compatibility of the color picker with NextGEN Gallery
= 1.12 =
* New: Added `page_template` parameter for meta boxes.
* Fixed: Error with the color picker option (and options that use the color picker) in WP 4.9
* Fixed: PHP warning when reseting font options
= 1.11 =
* New: Added custom font in Theme Customizer
* New: Added File Upload option
* New: Added select_all in multicheck option
* New: Added em in font size
* New: Sample Content Extension support
* Enhanced: Tabs color is changed, and the gap between tabs and panel is removed
* Enhanced: Allow svg file in upload option
* Fixed: Gallery option
= 1.10 =
* New: Added new options multicheck-post-types and select-post-types
* New: Added Group option
* New: Added include_fonts in Theme Customizer.
* Enhanced: Generated inline CSS now has an ID attribute.
* Enhanced: Easy Digital Downloads product checking revised.
* Enhanced: Timepicker styles.
* Enhanced: EDD option.
* Change: Footer Text should be returned not echoed.
* Change: class_exists to function_exists of googlefonts function.
* Fixed: Input tag.
= 1.9.3 =
* New: Transport parameter for overriding the Customizer transport parameter
* New: Added `enqueue` parameter for the code option
* New: Added `size` parameter to the Text option
* Change: Removed `title` parameter in admin tabs
* Fixed: Fixed bug where a blank panel was being created
* Fixed: Removed seconds, and other more precise controls in the date option.
= 1.9.2 =
* New: `tf_css_get_css_file_path_{$namespace}` filter
* Enhanced: Heading options in Customizer now look great
* Enhanced: The `css` parameter now performs live preview changes instead of reloading the page
* Enhanced: Added `inherit` values for some styles in the font option
* Enhanced: Changed some default style values in the font option to `inherit`
* Fixed: Options with a value of zero do not generate CSS properly (they wrongly reset to their default value before)
* Fixed: `getOptions` function turned non-existent keys to false
* Fixed: Existing panel names (not panel IDs) across different namespaces that match get shown in the wrong section
* Fixed: Removed remnance of a checkbox in the enable option while in the Customizer in Firefox
= 1.9.1 =
* Fixed: in some setups, saving options in a tab resets other tabs
= 1.9 =
* Major performance and speed optimizations, now is less process & memory intensive
* New `iframe` option
* New `custom` option
* New `multiple` attribute in select options for selecting multiple values
* New `desc` attribute in heading options for displaying short descriptions
* New `alpha` attribute in color options for picking rgba colors
* New `editor_options` attribute in editor options for specifying editor settings
* New `tf_admin_tab_created_{namespace}` action
* New `$titan->getOptions()` function for getting multiple options at once
* Updated Google Font list
* Heading options now generate an `id` attribute
* Now using Gulp for development and building
* Started using WordPress PHP Coding Standards
* Started unit testing. Coverage currently at 8%
* Removed initializing state which could cause duplication problems
* Bumped minimum version to 4.1
* Simplified Titan Framework checker code
* Fixed: notice for newly added options
* Fixed: upload option now uses attachment url in `livePreview` attribute
* Fixed: meta boxes now save properly for attachment post_types
* Fixed: font text-shadows
* Fixed: meta box css & js code from showing up in non-singular pages
* Fixed: stray border in enable options in the customizer
* Fixed: upload images misalign after saving in the customizer
* Removed: references to old select-google-font option
= 1.8.1 =
* Duplicated CSS rules #271
* Generated css contains duplicated declarations #232
* Add support for checking item ID #267
* Removed missing gallery since we still need to work on it bd23623
= 1.8 =
* New option: ajax-button
* Added new hooks:
* tf_done
* tf_pre_save_admin_{namespace}
* tf_save_admin_{namespace}
* tf_pre_reset_admin_{namespace}
* tf_reset_admin_{namespace}
* Added `desc` option for headers
* Removed unused tracking code
* Tweaked customizer font css
* Updated SCSSPHP to v0.0.15
* Added label for blank page/post titles for page/post options
* Updated & namespaced SCSSPHP
* Saving '0' values now work (e.g. in select options)
* Additional check to prevent scss compile of empty string
* Fixed bug where sometimes options without IDs (e.g. note) produce errors in the Customizer
* Fixed possible JS running in iframe-font-preview + empty checks for CWE-200
* getOption no longer throws a "called too early" warning and can now be called anywhere
* #240 Update class-option-font.php
* #235 Update class-option-checkbox.php
* #262 Namespace invisible class
* #264 Switch to strpos instead of preg_match
* #253 Remove timepicker from requirements
= 1.7.6 =
* The Note option can now be placed in the Customizer
* Prefixing a select value with `!` now displays the drop down value as disabled
* Added new argument `panel_desc` for panel descriptions
* Updated & namespaced EDD updater files
* Fixed bug where options with the value 0 were not properly returned
* Fixed bug where double descriptions showed up in the Customizer
* Minor XSS security fixes, shouldn't be affected really, but it's better to be safe
= 1.7.5 =
* Added `hidden` parameter for all options
* Fixed 4.1 display issues with the upload option
* Fixed an undefined notice that sometimes appears
= 1.7.4 =
* Faster SCSS parsing
* Faster loading time
* Unit parameter for number options now supported in the Theme Customizer
* Better font color option handling in Theme Customizer
* Now prevents SCSS errors from showing up
* Fixed name label issues with the enable option
* Better plugin checking method
* Plugin checker now integrates with TGM Plugin Activation
* Updated Ace
= 1.7.3 =
* Fixed bug introduced in 1.7.2 where admin options sometimes were not being saved
= 1.7.2 =
* EDD option can now check for updates all by itself (thank you julien731)
* `get_post_types` function now callable from `tf_create_options`
* Now passes theme-check (ignored `add_menu_page` error)
= 1.7.1 =
* Bug fixes for the Easy Digital Download License option
* Enhanced date option parameters
* New parameters for Theme Customizer for creating panels
= 1.7 =
* New Easy Digital Download License option (thank you julien731)
* New date option (thank you ardalann)
* Added new action tf_save_options_{namespace} which is called after saving options
* Fixed display issue with the font option in the theme customizer
* Fixed bug where empty multicheck returned an array
* Fix: customizer show_font_size & show_color
= 1.6.1 =
* Added missing files in the SVN
= 1.6 =
* New embed method (check the getting started section)
* New tf_create_options hook for creating options
* New number unit parameter
* Removed font awesome, now uses dashicons
* Added desc params to panels, tabs and meta boxes
* Added size attribute for the upload option
* Deleted Uncommon Ace Extensions
* Improve load script to meta boxes
* Lots of bug fixes
= 1.5 =
* Added German, Portuguese, Turkish and updated Italian translations
* Added `notification` and `paragraph` paramaters to the note option
* Added `include_fonts` parameter to the font option for specifying the selectable fonts
* Added `show_websafe_fonts` and `show_google_fonts` parameters to the font option
* Added `maxlength` parameter to the the text option
* Fixed Titan plugin detection code
* New more WordPress-centric styling of admin panels (special thanks to @sagarjadhav)
* A Lot of stabilization bug fixes
= 1.4.3 =
* Added a few global hooks
* Fixed missing hooks that prevented the Shortcode Extension from working
* Fixed missing HTML tags
= 1.4.2 =
* Fixed a typo
= 1.4.1 =
* Added some new hooks
* Added namespaces to all hooks
* Added meta links
* Fixed bug where font drop downs closed immediately in Firefox
* Fixed bug where getInstance did not return the same instance sometimes
* Fixed bug where the font option did not generate CSS correctly
* Fixed bug where only one Titan instance generated CSS files
* Fixed bug where CSS were being generated multiple times
* Fixed bug where option IDs in different instances caused an error
* Fixed bug where the live preview lagged a lot
= 1.4 =
* Added new Font option
* Added new Sortable option
* Fixed bug where generated CSS values aren't showing up (thanks @ardalann)
= 1.3 =
* Added Spanish translations (thanks @maperezotero)
* Added Code option that uses Ace
* No need to use the post ID when getting getOption
* createMetaBox can now accept an array in the post_type parameter
* Now using Travis CI
* Tons of bug fixes
= 1.2.1 =
* Added French translations (thanks @PunKeel)
* Added removeOption function
* Fixed bug where fonts sometimes cannot be changed
* Fixed fatal error encountered sometimes when generating CSS
* Fixed bug where other post types are unable to be saved
= 1.2 =
* Better embedding handling
* Automatic CSS generation
= 1.1.1 =
* Titan can now be embedded into themes and plugins
* Added Radio Image option
* Better layout for Google WebFont option
* Now enforcing unique option ids
* Fixed bug that shows up in fresh WP installs
= 1.1 =
* Added WYSIWYG editor option
* Added Radio Palette option
* Fixed bug where special characters in admin pages and tabs were not redirecting correctly
* Fixed minor bug where customizer options become reordered
* Minor bug fixes
= 1.0.1 - 1.0.2 =
* Added styling to the admin options
* Fixed minor debug error in options (Thanks to @Dovy)
= 1.0 =
First release