Skip to content

Commit 698833d

Browse files
committed
'Advanced guides' corrections
Signed-off-by: Kev Provance <kevin.provance@gmail.com>
1 parent 979e5b1 commit 698833d

10 files changed

Lines changed: 73 additions & 67 deletions

‎docs/configuration/global_arguments.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,10 @@ $args['share_icons'][] = array(
363363

364364
Set whether Redux will display the Import/Export tab at the bottom of the options panel. Please note, if the Import / Export feature is used as a field, this tab will not display regardless of the value set to it.
365365

366+
## templates_path
367+
368+
Set the path to the [user defined templates](../guides/advanced/panel-templates.md) for the Redux options panel.
369+
366370
## transient_time
367371
**Default**: `60 * MINUTE_IN_SECONDS`
368372

‎docs/guides/advanced/embedding-redux.md‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,32 @@ title: "Embedding Redux"
44

55
# Embedding Redux into Your Theme or Plugin
66

7-
::: danger Due to security concerns, we strongly discourage this method of using Redux without your projects. We update our software monthly which may include pathes to plug security holes. Unless you plan on updating Redux within your project regularly, the Redux plugin installed via [TGM](http://tgmpluginactivation.com/) is the preferred method.
7+
::: danger Due to security concerns, we strongly discourage this method of using Redux without your projects. We update our software monthly, which may
8+
include pathes to plug security holes. Unless you plan on updating Redux within your project regularly, the Redux plugin installed via [TGM](http://tgmpluginactivation.com/) is the
9+
preferred method.
810
:::
911

10-
::: danger Never, ever, EVER modify any files in `redux-core` (formerly `ReduxCore`). There are hooks, filters, etc. to bypass nearly anything.
12+
::: danger Never, ever, EVER modify any files in `redux-core`. There are hooks, filters, etc. to bypass nearly anything.
1113
Modifying files within `redux-core` (including dropping in extensions) will only serve to make your life harder should you
1214
ever choose to update.
1315
:::
1416

15-
So you have this really cool Theme or Plugin. And of course you love Redux because - let’s face it - who doesn't? You
16-
understand how the Redux plug-in works but the concept of a theme or plugin installing another plugin escapes you. Or perhaps
17-
you might not care for [TGM](http://tgmpluginactivation.com/) or any of its variations. What are you to do?
17+
So you have this really cool Theme or Plugin. And of course you love Redux because, let’s face it, who doesn't? You
18+
understand how the Redux plugin works, but the concept of a theme or plugin installing another plugin escapes you. Or perhaps
19+
you might not care for [TGM](http://tgmpluginactivation.com/) or any of its variations. What's one to do?
1820

19-
You've come to the right place. Embedding Redux into your theme or plugin is as easy as 1, 2, 3. You may wonder...what if your client also installs the Redux plugin? Will it conflict? The answer is no. Even better, the Redux plug-in will
20-
**always** supersede your theme’s require of Redux. This means your clients could - hypothetically - receive updates to
21-
Redux without any theme update from you. Pretty cool, eh?
21+
You've come to the right place. Embedding Redux into your theme or plugin is as easy as 1, 2, 3. You may wonder...what if your client also installs the
22+
Redux plugin? Will it conflict? The answer is no. Even better, the Redux plug-in will **always** supersede your theme’s require of Redux.
23+
This means your clients could - hypothetically - receive updates to Redux without any theme update from you. Pretty cool, eh?
2224

2325
Let's begin, shall we?
26+
2427
## Step 1: Get the Source
2528
There are a variety of methods in which to acquire the Redux Framework source code. Please refer to the
2629
[Basics: Installing](../basics/install.md) guide. Once you've acquired the source, only the `redux-core` folder matters
2730
(Note: in 3.x, this folder was called `ReduxCore`, but has been re-named to conform with WordPress naming standards.)
2831
You can rename it to anything you prefer. It’s important to choose a name for the folder in which Redux will be contained
29-
now, as it will be difficult to change the name later. Redux may be placed into any directory or in any path
32+
now, as it will be challenging to change the name later. Redux may be placed into any directory or in any path
3033
(such as ~/admin or ~/framework).
3134

3235

@@ -46,7 +49,7 @@ Here is where the true magic of Redux comes into play. Suppose a user has Redux
4649
theme is now using the plugin class and **not** the embedded version you included with your theme or
4750
plug-in! Put another way, your project will just work out of the box, no questions asked! Redux, when installed as a
4851
plug-in takes priority. Any references that include Redux in your own `framework.php` will be ignored. Redux - installed
49-
as a plug-in - can be forever updated by the user and your theme receives the benefit without you ever needing to push
52+
as a plug-in - can be forever updated by the user, and your theme receives the benefit without you ever needing to push
5053
any code update! What other option framework can claim the same?
5154

5255
The answer: None!

‎docs/guides/advanced/health-status-report.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "The Health Status Report"
33
---
44

55
# Understanding The Health Status Report
6-
The Redux Framework System Status report is a vital tool used in troubleshoot issues with your site. With a wide
7-
variety of sections and fields, software versions, server settings, and WordPress configuration, all may be checked in a
6+
The Redux Framework System Status report is a vital tool used to troubleshoot issues with your site. With a wide
7+
variety of sections and fields, software versions, server settings, and WordPress configuration, all may be checked at a
88
moment’s notice.
99

1010
The System Status report is also the best way that the Redux Support Team can help you. Before opening a ticket, be
@@ -17,22 +17,22 @@ sure to add your settings and check to see if you can troubleshoot an issue with
1717
## WordPress Environment
1818
This section provides general information about your site, your WordPress installation, and the features you have enabled.
1919

20-
|Field Name|Description|Example|
21-
|--- |--- |--- |
22-
|Home URL|The URL of your site's homepage.|http://example.com|
23-
|Site URL|The root URL of your site.|http://example.com|
24-
|Redux Version|The version of Redux Framework installed on your site.|3.4.4.5|
25-
|Redux Data Directory Writable|Whether the Redux data directory is writable, and its location.|/srv/www/wp-content/uploads/redux/|
26-
|WP Version|The version of WordPress installed on your site.|3.4.1|
27-
|WP Multisite|Whether you have WordPress Multisite enabled.|-|
28-
|Permalink Structure|The WordPress permalink structure set in Settings->Permalinks.|/%postname%/|
29-
|Front Page Display|The sitting to display "Latest Posts" or "Static Pages" as set in Settings->Reading.|posts|
30-
|Front Page|The name of the page used as the "Front Page" of the site.  This information is displayed only when Front Page Display is set to pages.|
31-
|Posts Page|The name of the page used as the "Post Page" of the site.  This information is displayed only when Front Page Display is set to pages.|
32-
|WP Memory Limit|The maximum amount of memory (RAM) that your site can use at one time. Learn how to increase this limit here.|64 MB|
33-
|Database Table Prefix|Displays the length of the WordPress database table prefix, and whether it falls into acceptable parameters.|Length: 3 - Status: Acceptable|
34-
|WP Debug Mode|Displays whether WordPress is in Debug Mode.|-|
35-
|Language|The current language used by WordPress. Default = English|en_US|
20+
|Field Name|Description| Example |
21+
|--- |--- |------------------------------------|
22+
|Home URL|The URL of your site's homepage.| http://example.com |
23+
|Site URL|The root URL of your site.| http://example.com |
24+
|Redux Version|The version of Redux Framework installed on your site.| 4.5 |
25+
|Redux Data Directory Writable|Whether the Redux data directory is writable, and its location.| /srv/www/wp-content/uploads/redux/ |
26+
|WP Version|The version of WordPress installed on your site.| 6.2 |
27+
|WP Multisite|Whether you have WordPress Multisite enabled.| - |
28+
|Permalink Structure|The WordPress permalink structure set in Settings->Permalinks.| /%postname%/ |
29+
|Front Page Display|The sitting to display "Latest Posts" or "Static Pages" as set in Settings->Reading.| posts |
30+
|Front Page|The name of the page used as the "Front Page" of the site. This information is displayed only when Front Page Display is set to pages.|
31+
|Posts Page|The name of the page used as the "Post Page" of the site. This information is displayed only when Front Page Display is set to pages.|
32+
|WP Memory Limit|The maximum amount of memory (RAM) that your site can use at one time.Learn how to increase this limit here.| 64 MB |
33+
|Database Table Prefix|Displays the length of the WordPress database table prefix, and whether it falls into acceptable parameters.| Length: 3 - Status: Acceptable |
34+
|WP Debug Mode|Displays whether WordPress is in Debug Mode.| - |
35+
|Language|The current language used by WordPress. Default = English| en_US |
3636

3737

3838
## Browser
@@ -90,9 +90,9 @@ on if and how many plugins on your site use Redux Framework.
9090
|compiler|Flag setting the compiler option for the specified instance of Redux.|√|
9191
|output|Indicates if output flag for globally shutting off all CSS output is enabled for the specified instance of Redux.|√|
9292
|output_tag|The output_tag variable sets whether or not dynamic CSS will be generated for the customizer and Google fonts for this instance of Redux.|√|
93-
|template_path|The full directory path to custom template files for this instance of Redux.  This data is only displayed if the template_path argument is set.|/srv/www/wp-content/themes//redux/templates|
94-
|Templates|A list of custom templates used and their versions.  This data is only displayed if the template_path argument is set and templates are installed.|`/admin/templates/container.tpl.php`, <br/>`/admin/templates/content.tpl.php`, <br />`/admin/templates/footer.tpl.php`, <br />`/admin/templates/header.tpl.php`, <br />`/admin/templates/header_stickybar.tpl.php`, <br />`/admin/templates/menu_container.tpl.php`|
95-
|Extensions|A list of installed Redux Framework extensions and their versions.  This information is only displayed if extensions are installed.|Widget Areas - 1.0.0<br />Social Profiles - 1.0.2<br />Search - 1.0.0<br />Multi Media - 1.0.0<br />Metaboxes - 1.3.1<br />Js Button - 1.0.1<br />Custom Fonts - 1.0.1<br />Color Scheme - 2.1.6|
93+
|template_path|The full directory path to custom template files for this instance of Redux. This data is only displayed if the template_path argument is set.|/srv/www/wp-content/themes//redux/templates|
94+
|Templates|A list of custom templates used and their versions. This data is only displayed if the template_path argument is set and templates are installed.|`/admin/templates/container.tpl.php`,<br/>`/admin/templates/content.tpl.php`,<br />`/admin/templates/footer.tpl.php`,<br />`/admin/templates/header.tpl.php`,<br />`/admin/templates/header_stickybar.tpl.php`,<br />`/admin/templates/menu_container.tpl.php`|
95+
|Extensions|A list of installed Redux Framework extensions and their versions. This information is only displayed if extensions are installed.|Widget Areas - 1.0.0<br />Social Profiles - 1.0.2<br />Search - 1.0.0<br />Multi Media - 1.0.0<br />Metaboxes - 1.3.1<br />Js Button - 1.0.1<br />Custom Fonts - 1.0.1<br />Color Scheme - 2.1.6|
9696

9797
## Theme
9898
This section displays valuable information about the current theme running on your installation. Typically, this could be
@@ -104,6 +104,6 @@ one of the more problematic areas of a site – as there is no standard on what
104104
|Version|The installed version of the current active theme.|1.0.0|
105105
|Author URL|The developer or plugin’s URL|http://www.rdx.io|
106106
|Child Theme|Displays whether the active theme is a child theme, and what the parent theme is.|x|
107-
|Parent Theme Name|The name of the current parent theme.  This information is displayed only f the current theme is a child theme.|HelpBase (child theme)|
108-
|Parent Theme Version|The installed version of the parent theme.  This information is displayed only f the current theme is a child theme.|1.0.0|
109-
|Parent Theme Author URL|The parent's theme's developer or URL.  This information is displayed only f the current theme is a child theme.|http://www.rdx.io|
107+
|Parent Theme Name|The name of the current parent theme. This information is displayed only f the current theme is a child theme.|HelpBase (child theme)|
108+
|Parent Theme Version|The installed version of the parent theme. This information is displayed only f the current theme is a child theme.|1.0.0|
109+
|Parent Theme Author URL|The parent's theme's developer or URL. This information is displayed only f the current theme is a child theme.|http://www.rdx.io|

‎docs/guides/advanced/increasing-the-memory-limit.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ WordPress memory can be different to the server – you need to set this regardl
1818

1919
If you have access to your PHP.ini file, change the line in PHP.ini
2020

21-
If your line shows 32M try 64M:
21+
If your line shows 32M, try 64M:
2222

2323
```text
2424
memory_limit = 64M ; Maximum amount of memory a script may consume (64MB)
2525
```
2626

27-
If you don’t have access to PHP.ini try adding this to an .htaccess file:
27+
If you don’t have access to PHP.ini, try adding this to an .htaccess file:
2828

2929
```text
3030
php_value memory_limit 64M

‎docs/guides/advanced/overriding-default-css.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,29 @@ We understand customization is important to any developer. That’s why we've pr
77
dequeue our default CSS files. Interested? Read on!
88

99
::: danger
10-
Be sure to prefix all the function names below to avoid conflicts with other developer's code.
10+
Be sure to prefix all the function names below to avoid conflicts with another developer's code.
1111
:::
1212

1313
::: warning Table of Contents
1414
[[toc]]
1515
:::
1616

1717
## Appending CSS
18-
Let's say you want to append some custom CSS to your panel. Here is how this is accomplished.
18+
Let's say you want to append some custom CSS to your panel. Here is how this is achieved.
1919

2020
```php
2121
$opt_name = 'OPT_NAME'; # TODO - Replace with your opt_name
2222
function add_panel_css() {
2323
wp_register_style(
2424
'redux-custom-css',
25-
'http://urltomyfile',
26-
array( 'redux-admin-css' ), // Be sure to include redux-admin-css so it's appended after the core css is applied
25+
'https://urltomyfile',
26+
array( 'redux-admin-css' ), // Be sure to include redux-admin-css so it's appended after the core CSS is applied
2727
time(),
2828
'all'
2929
);
3030
wp_enqueue_style('redux-custom-css');
3131
}
32-
// This example assumes your opt_name is set to OPT_NAME, replace with your opt_name value
32+
// This example assumes your opt_name is set to OPT_NAME, replace it with your opt_name value
3333
add_action( 'redux/page/' . $opt_name . '/enqueue', 'add_panel_css' );
3434
```
3535

@@ -54,7 +54,7 @@ function add_and_override_panel_css() {
5454
wp_register_style(
5555
'redux-custom-css',
5656
'http://urltomyfile',
57-
array( 'farbtastic' ), // Notice redux-admin-css is removed and the wordpress standard farbtastic is included instead
57+
array( 'farbtastic' ), // Notice redux-admin-css is removed and the WordPress standard farbtastic is included instead
5858
time(),
5959
'all'
6060
);

‎docs/guides/advanced/panel-templates.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ To do this is simple. First, copy the templates from `~/redux-core/templates/pan
1717
Never, ever, **EVER** modify `redux-core`. Always move things out of the core to make modifications.
1818
:::
1919

20-
Tell Redux where these new files are, via the `templates_path` argument. That's it!
20+
Tell Redux where these new files are, via the [`templates_path`](../../configuration/global_arguments.md#templates_path) argument. That's it!
2121

2222
#### What if you change something?
23-
Our templates use the same version methods of other products. If your panel is in `dev_mode` a notice will be displayed in the panel
23+
Our templates use the same version methods of other products. If your panel is in `dev_mode` a notice will display in the panel
2424
when a template file has been updated in the core.
2525

2626
## Won't this Change All Panels?

‎docs/guides/advanced/updating-an-option-manually.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Updating an Option Manually"
33
---
44

55
# Updating an Option Manually
6-
Most of the time, options for your theme or plugin will be set via the Redux option panel. But what if the need to
7-
update an option from someplace else arises? Perhaps an option would need to be changed behind the scenes, based on certain
6+
Most of the time, options for your theme or plugin will be set via the Redux option panel. What if the need to
7+
update an option from someplace else arises? Perhaps an option needs to be changed behind the scenes, based on certain
88
conditions. Can it be done?
99

1010
You better believe it! All thanks to the Redux API.
@@ -14,7 +14,7 @@ $opt_name = 'OPT_NAME'; // TODO - Replace with your opt_name
1414
Redux::set_option( $opt_name, 'KEY', $option );
1515
```
1616

17-
The `KEY` is the [field ID](../../configuration/objects/field.md) you are seeking to update. The `$option` is the value you
17+
The `KEY` is the [field ID](../../configuration/objects/field.md) you're seeking to update. The `$option` is the value you
1818
wish to save.
1919

20-
This method will save the values in the database as well as update the global variable.
20+
This method saves the values in the database as well as updates the global variable.

‎docs/guides/advanced/using-another-icon-web-font.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: "Using Another Icon Font"
33
---
44

55
# Using Another Icon Web Font
6-
Redux uses Elusive Icons in our panel. Why? @aristath, a good friend of the Redux team designed the icon pack. As a
7-
result, we can use any icon we want. We understand our choice in icon pack may not match or suit everyone's needs.
6+
Redux uses Elusive Icons in our panel. We understand our choice in icon pack may not match or suit everyone's needs.
87
This is why we've made it easy to add a new icon pack. Here's how:
98

109
```php
@@ -26,10 +25,10 @@ function new_icon_font() {
2625
add_action( 'redux/page/' . $opt_name . '/enqueue', 'new_icon_font' );
2726
```
2827

29-
Now to use the added icons, you can do the following for a [section](../../configuration/objects/section.md) declaration:
28+
To use the added icons, add the following [section](../../configuration/objects/section.md) declaration:
3029

3130
```php
32-
Redux::addSection( 'OPT_NAME', array(
31+
Redux::add_section( 'OPT_NAME', array(
3332
'id' => 'icon_section',
3433
'title' => esc_html__('Home Settings', 'your-textdomain-here'),
3534
'header' => esc_html__('Welcome to the Redux Framework Demo', 'your-textdomain-here'),

‎docs/guides/advanced/wp-filesystem-proxy.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ the moment a Redux object has been loaded (your Redux config has been run).
1111
:::
1212

1313
## Getting Started
14-
First, you must get the Redux object. The easiest method is as follows:
14+
First, get the Redux object. The easiest method is as follows:
1515

1616
```php
1717
$redux = Redux::get_instance('OPT_NAME'); // TODO - Use your opt_name
@@ -27,17 +27,17 @@ Below is a list of available commands and the arguments associated with each.
2727

2828
## Chmod / File Permissions
2929
By default, the WP_FileSystem API uses default values for chmod (read/write permissions). These are in the form of the
30-
declared FS_CHMOD_DIR for directories or FS_CHMOD_FILE for files. Do not worry about setting these values yourself.
30+
declared `FS_CHMOD_DIR` for directories or `FS_CHMOD_FILE` for files. Do not worry about setting these values yourself.
3131

3232
::: tip
3333
If you **must** override the default chmod settings, you may pass in a chmod argument for all actions except
34-
object and unzip. To do so, pass a string or int: `0644` as this argument value.
34+
object and unzip. To do so, pass a string or int: `0644` as this argument's value.
3535
:::
3636

3737
## Possible Calls & Arguments.
3838

3939
### `mkdir`
40-
Creates a directory. It will even make multiple children directories even it if it doesn't exist.
40+
Create a directory. It will even make multiple child directories even it if it doesn't exist.
4141

4242
```php
4343
$redux = Redux::get_instance( 'OPT_NAME' ); // TODO - Use your opt_name
@@ -92,7 +92,7 @@ $redux->filesystem->execute(
9292
```
9393

9494
### `get_contents`
95-
Retrieves the contents of a file. This command will attempt to use the WordPress filesystem first.
95+
Retrieve the contents of a file. This command will attempt to use the WordPress filesystem first.
9696
However, if the file does not have the standard WordPress read permissions, it will fall back to `file_get_contents`.
9797

9898
```php

0 commit comments

Comments
 (0)