forked from NHSLeadership/nhsblocks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
82 lines (63 loc) · 5.29 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
=== NHS Blocks ===
Contributors: tblacker
Tags: gutenberg, blocks, nhs
Plugin URI: https://digital.leadershipacademy.nhs.uk/digital-capabilities/websites/nhs-blocks-user-guide/
Requires at least: 5.0
Tested up to: 5.2.3
Stable tag: 1.0.4
Requires PHP: 5.6
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
NHS styled blocks for WordPress as developed by the NHS Leadership Academy based on the NHS Digital Frontend library.
== Description ==
NHS styled blocks for WordPress using the Gutenberg editor, based on the excellent work from the NHSUK Frontend Library. These blocks mean your WordPress site can offer the latest care cards, site promos and info panels to your users, and that all of this content will be styled to match the NHS branding guidelines.
This plugin is designed principally for use by NHS organisations, but can be used by anybody.
== Installation ==
This section describes how to install the plugin and get it working.
1. This plugin requires that the Gutenberg plugin (running as a plugin) is already installed and active on your site to get the latest developments and techniques available.
2. Upload the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly.
3. Activate the plugin through the 'Plugins' screen in WordPress
4. Navigate to edit or create any page or post.
5. When you go to add a new block to your content, you will see a new section titled "NHS Frontend". In here are all of the new blocks this plugin provides. Experiment - almost all of the blocks have style variations available.
== Frequently Asked Questions ==
= Is this plugin restricted to only NHS Organisations =
This plugin has been built specifically for use in the NHS, but it is open source code and you are free to use it on any site.
== Screenshots ==
1. This plugin adds a new type of block to your WordPress - titled NHS Frontend - with 10 new blocks based on the NHS Digital Frontend Library
2. Dashboard Layout - a graphical nav panel for users to jump to sections of your site
3. Do / Dont lists - Simple lists in a display card with ticks and crosses to denote actions they should or should not take. Can also be used for status updates, projects etc
4. Buttons - Restyling of buttons to match NHS Digital layouts
5. Reveal Elements - Either simple arrow based expandable sections, or icon based with plus/minus icons
6. Panels - Text blocks with title sections to separate your content out cleanly
7. Promo Blocks - Clean blocks which are completely linked to inner content / external sources with title, text and optional images
8. Testimonial / Quote - Simple display device for highlighting user feedback, personal quotes or other text you would like to highlight
9. Grouped blocks - pre-defined layouts for displaying your content in more eye catching ways
10. Hero - a full screen width block, with optional single colour or image background and optional block of text to anchor the page and set clear purpose
== Changelog ==
= 1.0.5 =
* IE10/11 compatability with Hero Block
* Additional css filters for buttons, panels and promos
= 1.0.4 =
* Reworked js filters to position hero at head of page
= 1.0.3 =
* Moved css and js from theme in to the blocks to enable standalone functionality
* Added css to avoid conflicts with LearnDash (Conflicts triggered by Gutenberg plugin, but not in our gift)
= 1.0.1 =
* Added Base language (English) and ensured full internationalisation. Translations welcome :)
* Registered all blocks so they show correctly on plugin page
* Improved Screenshot library for clearer understanding of plugin functionality from within WordPress.org listing / wp-admin search function
= 1.0 =
* First stable public release of the plugin.
* Included modules:
* Dashboard links - designed for your home page or a section home. You can add graphical sections with text overlays linking to your inner pages.
* Do / Dont Lists - simple panels with lists of items with either a tick or a cross next to them.
* Button - NHS styled buttons, available as primary (green), secondary (blue) or reverse (white)
* Reveal - expandable areas of the screen. Available either as standard reveal (down arrow) or expander (plus icon)
* Panels - Text areas with titles, text and buttons for call to action. Available as standard white panel, grey panel or white panel with coloured header.
* Promo - Linked boxes with text and optional images. Available in standard or smaller text variants.
* Testimonial - quotes or testimonials can be included with this block. Available as standard (blue text with blue left hand border) or inverted (white text with blue background and white left hand border)
* Cards - Information cards. Coloured headers with an arrow pointing to text content. Available as standard care card, warnings (red header) or alerts (red header, black body)
* Grouped Items - pre configured layouts of elements, with eiter testimonials, panels or promos inside each field.
* Hero Banner - a full screen width hero image, with optional text overlay box including title and tagline. Ideal for graphically anchoring your website sections.
== Development / Contributing ==
Contributions to development of this work are welcome at [our GitHub repository](https://github.com/NHSLeadership/nhsblocks "NHSBlocks GitHub repo").