Skip to content

Commit fb1bbd8

Browse files
author
Ghost1227
committed
Initial clone from ReduxFramework
1 parent ee332a5 commit fb1bbd8

File tree

256 files changed

+25370
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

256 files changed

+25370
-3
lines changed

CHANGELOG.md

Whitespace-only changes.

README.md

Lines changed: 155 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,156 @@
1-
ReduxCore
2-
=========
1+
# Redux Options Framework v3.0.0 Beta [![Build Status](https://secure.travis-ci.org/ghost1227/Redux-Framework.png?branch=master)](http://travis-ci.org/ghost1227/Redux-Framework)
32

4-
ReduxCore is the core of the ReduxFramework plugin, and is also usable on its own as an embedded framework.
3+
## Please help us beta test. As soon as the community verifies there are no bugs, we will release.
4+
5+
Wordpress options framework which uses the [WordPress Settings API](http://codex.wordpress.org/Settings_API "WordPress Settings API"), Custom Error/Validation Handling, Custom Field/Validation Types, and import/export functionality.
6+
7+
## Donate to the Framework ##
8+
9+
If you can, please donate to help support the ongoing development of Redux Framework!
10+
11+
[![Donate to the framework](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "Donate to the framework")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=N5AD7TSH8YA5U)
12+
13+
## Features ##
14+
15+
* Uses the [WordPress Settings API](http://codex.wordpress.org/Settings_API "WordPress Settings API")
16+
* Multiple built in field types
17+
* Multple layout field types
18+
* Fields can be over-ridden with a callback function, for custom field types
19+
* Easily extendable by creating Field Classes
20+
* Built in Validation Classes
21+
* Easily extendable by creating Validation Classes
22+
* Custom Validation error handling, including error counts for each section, and custom styling for error fields
23+
* Custom Validation warning handling, including warning counts for each section, and custom styling for warning fields
24+
* Multiple Hook Points for customisation
25+
* Import / Export Functionality - including cross site importing of settings
26+
* Easily add page help through the class
27+
* Much more
28+
29+
## Stay In The Loop! ##
30+
31+
[![Follow us on Twitter](http://iod.unh.edu/Images/Twitter_follow_us.png "Follow us on Twitter")](https://www.twitter.com/ReduxFramework)
32+
33+
## Getting Redux ##
34+
35+
Redux can be downloaded in several ways which are outlined below. Please use whichever way you are most comfortable with.
36+
37+
### Download as a .zip archive ###
38+
39+
* Stable release: [download](https://github.com/ghost1227/Redux-Framework/archive/master.zip)
40+
41+
Once you have downloaded the framework, upload the .zip file to the root of your project and unzip it as follows:
42+
43+
```bash
44+
$ cd my-project
45+
$ unzip Redux-Framework-master.zip -d Redux-Framework
46+
```
47+
48+
### Cloning the repository using git ###
49+
50+
*Stable release*
51+
```bash
52+
$ cd my-project
53+
$ git clone git://github.com/ghost1227/Redux-Framework/
54+
```
55+
56+
### Cloning the repository as a git submodule ###
57+
58+
*Stable release*
59+
```bash
60+
$ cd my-project
61+
$ git submodule add git://github.com/ghost1227/Redux-Framework/
62+
```
63+
64+
## Setting up Redux ##
65+
66+
Copy the included options.php file outside of the Redux folder (recommended).
67+
68+
Include Redux in your theme ```functions.php``` or plugin as follows:
69+
70+
```php
71+
require_once('path/to/copied/options.php');
72+
```
73+
74+
Edit ```options.php``` as needed.
75+
76+
## FAQs ##
77+
78+
1. Why should we use ```require_once``` instead of ```get_template_part```?
79+
* First, because ```get_template_part``` is for... you guessed it, themes! Redux is designed to work with both themes *and* plugins.
80+
* Second, read [this](http://kovshenin.com/2013/get_template_part/).
81+
2. Why shouldn't we edit ```defaults.php```?
82+
* Because ```defaults.php``` is for *defaults*. Anything that is defined in ```defaults.php``` can be overridden in ```options.php```.
83+
84+
## Are you using Redux? ##
85+
86+
Send me an email at ghost1227@reduxframework.com so I can add you to our user spotlight!
87+
88+
## Changelog ##
89+
90+
### Master ###
91+
92+
* Removed get() and show()
93+
* Fixed huge performance bug
94+
* More bugfixes
95+
* Fixed spacing field
96+
97+
### Version 3.0.0 Beta (September 12, 2013)
98+
99+
* Massive code overhaul
100+
* Replaced redundant field types with data elements
101+
* Migrated to company repo
102+
* Added several new storage methods
103+
* Numerous bugfixes
104+
* Renamed std argument to default
105+
* Added MP6 support
106+
* Complete CSS rewrite
107+
* Globals are now conditional
108+
* Added nesting support
109+
* Added repeatable field
110+
* Restyled Dev Mode
111+
* Added System Info tab
112+
* Added compiler hooks
113+
* Added style and icon support to info field
114+
* Switched to Elusive Icons
115+
* Huge performance updates
116+
117+
### Version 2.0.1 Final (September 1, 2013) ###
118+
119+
* Added option to override ```icon_type``` per icon
120+
* Minor bug/versioning fixes
121+
* Added Font Awesome intro
122+
* Added ```raw_html``` option
123+
* Added ```text_sortable``` option
124+
* Switched from Aristo to Bootstrap jQuery UI theme
125+
126+
### Version 2.0.0 (January 31, 2013) ###
127+
128+
* Fixed SSL error which occurred occasionally with Google Webfonts
129+
* Added optional flag for ```wpautop``` on editors
130+
* Added password field type
131+
* Added ```checkbox_hide_all``` option
132+
* Added WP3.5 media chooser
133+
* Added Google webfonts previews
134+
* Updated to WP3.5 color picker
135+
* Minor style tweaks
136+
* Added graphical 'switch' option for checkboxes
137+
* Removed dependency on class extension for fields
138+
* Deprecated icons in favor of iconfonts
139+
140+
### Version 1.0.0 (December 5, 2012) ###
141+
142+
* Based on NHP Theme Options Framework v1.0.6
143+
* Cleaned up codebase
144+
* Changed option group name to allow multiple instances
145+
* Changed checkbox name attribute to id
146+
* Added rows attribute to textareas
147+
* Removed extra linebreak in upload field
148+
* Set default menu position to null to avoid conflicts
149+
* Added sample content for dashboard credit line
150+
* Minor style changes
151+
* Changed name of upload button
152+
* Refactored Google Webfonts function
153+
* Replaced ```stylesheet_override``` with ```admin_stylesheet```
154+
* Made text domain a constant
155+
* Removed PHP closing tags to prevent issues with newlines
156+
* Added option to define custom start tab

TODO.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# ToDo
2+
3+
The items on this list need to be accomplished before the official release of Redux Framework v3.0.0
4+
5+
## Design Issues ##
6+
7+
* The 'px' tag on the **Styling Options -> Body Font** field is misaligned.
8+
* Data-based checkbox and selects fail to show if no data is available. Ideally, it should show a single disabled entry such as '--No Data Available--'.
9+
* Multiselect fields aren't showing complete placeholders (cutting off at 'Select an').
10+
* I'd like to find a better theme for the date dropdown, it doesn't quite seem to fit.
11+
* Fix responsive CSS
12+
13+
## Spelling/Textual Issues ##
14+
15+
* The **Text Option - URL Validated** field shows http://no-half-pixels.com, needs to be changed to http://reduxframework.com
16+
17+
## Other Issues ##
18+
19+
* Currently missing fields (at least in the demo) - raw HTML
20+
* Add debugging info to Dev Mode tab
21+
* Can we find a better place to put the footer_text content? Doesn't feel right now.
22+
* Update sample options to show the correct facebook link, and drop LinkedIn
23+
* Update sample options home tab

0 commit comments

Comments
 (0)