Skip to content

Commit 5b54e45

Browse files
author
hsehszroc
committed
v1.0 release
1 parent 8f36cb5 commit 5b54e45

File tree

2 files changed

+397
-32
lines changed

2 files changed

+397
-32
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ https://www.markdownguide.org/basic-syntax/#reference-style-links
6161
### Preface
6262
<small>[Top↑](#table-of-contents)</small>
6363

64-
This framework is a ready to use plugin or to include inside your own plugin/theme for anyone who needs to create: <br/>
64+
This framework is a ready to use plugin _<small>(if not building your own plugin or theme)_</small> or to include inside your own plugin/theme for anyone who needs to create: <br/>
6565
- WordPress Admin pages (**_Welcome | Fields Demo_** navigations at left side in screenshot 1 above)
6666
- Different Sections within a page (tabs **_Getting Started | Hooks & Filters | Recommended Setup | Ready to Go?_** inside **_Welcome_** page in screenshot 1 above)
6767
- Contents within each section (tab content of **_Getting Started_** inside **_Welcome_** page in screenshot 1 above)
@@ -78,17 +78,18 @@ This framework is a ready to use plugin or to include inside your own plugin/the
7878

7979
This plugin is developed using:
8080

81-
* [Code Editor - **Visual Studio Code (VS Code)**](https://code.visualstudio.com/download) - Loved by most developers for coding
81+
* [Code Editor - **Visual Studio Code (VS Code)**](https://code.visualstudio.com/download) - Loved by most developers for coding.
8282
* [VS Code extension - **WordPress Snippets**](https://github.com/jason-pomerleau/vscode-wordpress-toolbox) - Snippets for every WordPress function, class and constant.
83-
* [VS Code extension - **PHP Intelephense**](https://github.com/bmewburn/vscode-intelephense) - Essential features for productive PHP development
84-
* [VS Code extension - **Comment Anchors**](https://github.com/ExodiusStudios/vscode-comment-anchors) - Find anchors for WordPress **Action** & **Filter** hooks (and other anchors too) added in this framework's files
85-
* [VS Code Font - **Fira Code**](https://github.com/tonsky/FiraCode) - Download and install to your OS and then use from VS Code font family setting
83+
* [VS Code extension - **PHP Intelephense**](https://github.com/bmewburn/vscode-intelephense) - Essential features for productive PHP development.
84+
* [VS Code extension - **Comment Anchors**](https://github.com/ExodiusStudios/vscode-comment-anchors) - Find anchors for WordPress **Action** & **Filter** hooks (and other anchors too) added in this framework's files.
85+
* [VS Code Font - **Fira Code**](https://github.com/tonsky/FiraCode) - Free monospaced font with programming ligatures. Set it from VS Code font family.
8686
* [WordPress Plugin - **Show Hooks**](https://wordpress.org/plugins/show-hooks/) - See visual representation of WordPess action and filter hooks.
8787

8888
### Installation
8989
<small>[Top↑](#table-of-contents)</small>
9090

9191
#### For using as plugin
92+
>change [with-fields.php](https://github.com/TheWebSolver/tws-setting-framework/tree/master/templates/with-fields.php) and [without-fields.php](https://github.com/TheWebSolver/tws-setting-framework/tree/master/templates/without-fields.php) to your requirement.
9293
9394
- Download or clone this repo into plugins directory using:
9495
```sh
@@ -99,9 +100,9 @@ This plugin is developed using:
99100
```sh
100101
git clone https://github.com/TheWebSolver/tws-setting-framework.git
101102
```
102-
- Include the framework file **_tws-setting-framework.php_** from your main plugin file
103+
- Include the framework file **_tws-setting-framework.php_** from your plugin/theme file
103104
```sh
104-
include_once 'path_to_framework_directory/tws-setting-framework.php';
105+
require_once 'path_to_framework_directory/tws-setting-framework.php';
105106
```
106107

107108
## Usage
@@ -123,7 +124,7 @@ This plugin is developed using:
123124
124125
#### NOTE:
125126
126-
>Regarding documentation, once it is activated, navigate to **_Welcome_** submenu page which has four sections as tabs, first three of them are documentation tabs. Contents in these three tabs are added from files that are inside directory _[templates/contents](https://github.com/TheWebSolver/tws-setting-framework/tree/master/templates/contents)_.
127+
>Regarding documentation, once activated, navigate to **_Welcome_** submenu page which has four sections as tabs, first three of them are documentation tabs. Contents in these three tabs are added from files that are inside directory _[templates/contents](https://github.com/TheWebSolver/tws-setting-framework/tree/master/templates/contents)_.
127128
128129
>_(See screenshot 1 above for reference on how content gets displayed)_
129130
@@ -227,7 +228,7 @@ This plugin is developed using:
227228
228229
>For refresher, the parent class is in file [setting-component.php](https://github.com/TheWebSolver/tws-setting-framework/tree/master/setting/setting-component.php).
229230
230-
- >For visual presentation on how it works, see screenshot 3, 4, 5 and 6 below.
231+
- >For visual representation on how section and field gets displayed, see screenshot 3, 4 and 5 below.
231232
232233
#### Screenshot 3 - General Fields
233234
![Screenshot 3][screenshot-3]
@@ -259,7 +260,7 @@ This plugin is developed using:
259260
260261
- For debugging purpose, you can define debug constant to `true`.
261262
262-
On file [tws-setting-framework.php](https://github.com/TheWebSolver/tws-setting-framework/tree/master/tws-setting-framework.php) at around **_line 32_**, change `false` to `true`.
263+
On file [tws-setting-framework.php](https://github.com/TheWebSolver/tws-setting-framework/tree/master/tws-setting-framework.php) at around **_line 32_**, change contstant value from `false` to `true`. For visual representation, see screenshot 6 below.
263264
264265
```php
265266
define( 'HZFEX_SETTING_FRAMEWORK_DEBUG_MODE', true );
@@ -303,6 +304,12 @@ Shesh Ghimire - [@hsehszroc](https://twitter.com/hsehszroc)
303304
304305
Project Link: [https://github.com/TheWebSolver/tws-setting-framework](https://github.com/TheWebSolver/tws-setting-framework)
305306
307+
<!-- ACKNOWLEDGEMENT -->
308+
## Acknowledegement
309+
<small>[Top↑](#table-of-contents)</small>
310+
311+
- >This project uses base for Settings_API from [wordpress-settings-api-class](https://github.com/tareq1988/wordpress-settings-api-class).
312+
306313
307314
<!-- MARKDOWN LINKS & IMAGES -->
308315
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
@@ -323,10 +330,4 @@ Project Link: [https://github.com/TheWebSolver/tws-setting-framework](https://gi
323330
[screenshot-3]: images/simple-fields.png
324331
[screenshot-4]: images/advanced-fields.png
325332
[screenshot-5]: images/stylized-fields.png
326-
[screenshot-6]: images/debug.png
327-
328-
<!-- ACKNOWLEDGEMENT -->
329-
## Acknowledegement
330-
<small>[Top↑](#table-of-contents)</small>
331-
332-
- >This project uses base for Settings_API from [wordpress-settings-api-class](https://github.com/tareq1988/wordpress-settings-api-class).
333+
[screenshot-6]: images/debug.png

0 commit comments

Comments
 (0)