The purpose of this document is to outline in finer detail the specifics on this Wordpress install, provide ongoing support and act as a reference for the modules available within the site.
Alongside the technical specification this will give an overview of the expected sections, modules, fields & options to be delivered. Furthermore during the lifetime of the project this document can be referenced for module information and FAQs.
Ideally once this reference has been delivered with the technical specification it should not change aside from the FAQs which will be updated with a record of support requests and solutions where applicable.
Any notable changes to the specification will be added here within the 'notable updates section'.
"Sections" are distinctive content areas in the CMS such as testimonials, client stories etc. They are kept within their own sections to avoid repitition of content across pages and feature the same page building/editing capabilities as one another with potentially different categorisation functionality and/or custom fields.
Post Urls : /SLUG
Standard pages section built into Wordpress by default. Where the majority of the web site content will be managed.
No taxonomies for this post type.
No custom fields for this content type
Post Urls : /service/SLUG
No taxonomies for this post type.
No custom fields for this post type.
Post Urls : N/A
No taxonomies for this post type.
No custom fields for this post type.
Post Urls : /testimonial/SLUG
No taxonomies for this post type.
Post Urls : /snippet/SLUG
No taxonomies for this post type.
No custom fields for this post type.
"Modules" are the components or building blocks of each of the pages on the web site. These can be added in any combination on any of the pages with specifically inputted content. Certain Modules draw content in from the sections outlined above. Each module in listed here along with the customisable fields and a small preview of the module form as seen in the backend.
Hero Image Carousel Panel
Heading ($introtext)(multiline)
The main heading for this carousel
Introductory Paragraph ($introparagraph)(multiline)
Introductory paragraph
Button Text ($buttontext)(singleline)
CTA Button Text
Button Url ($buttonurl)(singleline)
CTA Button Url
Button Target ($buttontarget)(select)
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
Image ($imagefile)(mediaselection)
The image for this item
Bottom Left Image ($bottomleft)(mediaselection)
The image for the bottom left
Bottom Right Image ($bottomright)(mediaselection)
The image for the bottom right
A list of services
Pre Heading ($mainheading)(singleline)
Pre Heading
List Style ($style)(select)
Display format of this service list
Intro Text ($introtext)(multiline)
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
Service Item ($serviceitem)(post)
A full or partial process list
Pre Heading ($preheading)(singleline)
Pre Heading
Main Heading ($mainheading)(singleline)
Main Heading
Image ($image)(mediaselection)
Accompying Image
Style ($style)(select)
Display format of this process list
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
Process Item ($processitem)(post)
Display products
Pre Heading ($mainheading)(singleline)
Pre Heading
Main Heading ($introheading)(singleline)
Main Heading
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
A CTA Block
Intro Text ($introtext)(multiline)
Introductory Text
CTA Image ($image)(mediaselection)
An image for this CTA
Button Text ($ctabuttontext)(singleline)
The button text
Button Url ($ctabuttonurl)(singleline)
The button url
Image Align ($imagealign)(select)
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
A single image
Image ($image)(mediaselection)
Accompying Image
Style ($style)(select)
How will this image be displayed?
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
Theme ($theme)(select)
Image ($image)(mediaselection)
Pre Heading ($preheading)(singleline)
Main Heading ($mainheading)(singleline)
Text Content ($textcontent)(multiline)
Pull Out Alignment ($alignment)(select)
Button Text ($buttontext)(singleline)
CTA Button Text
Button Url ($buttonurl)(singleline)
CTA Button Url
Button Target ($buttontarget)(select)
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
Standard Text Block with optional columns
Intro Text ($introtext)(multiline)
How would you like to introduce this column?
Theme ($theme)(select)
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
Content Pretitle ($pretitle)(singleline)
The pretitle for the column content
Text Content ($textcontent)(wysiwyg)
Column text
Testimonial to feature ($testimonialid)(post)
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
Resuse previously built modules across multiple pages.
Snippet ($snippetid)(post)
Choose a snippet item to be added
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
Image ($imagefile)(mediaselection)
The image for this item
Quote ($textcontent)(multiline)
Quote Text
Margin Top ($margintop)(select)
Add Margin to the top of this module
Margin Bottom ($marginbottom)(select)
Add Margin to the bottom of this module
Module ID ($moduleid)(singleline)
Add an ID attribute to this module
A list of the plugins installed on the project.
https://servmask.com/
Migration tool for all your blog data. Import or Export your blog content with a single click.
https://servmask.com/
Extension for All-in-One WP Migration that enables unlimited size exports and imports
https://wordpress.org/plugins/classic-editor/
Enables the WordPress classic editor and the old-style Edit Post screen with TinyMCE, Meta Boxes, etc. Supports the older plugins that extend this screen.
https://contactform7.com/
Just another contact form plugin. Simple but flexible.
https://ciphercoin.com/
Save and manage Contact Form 7 messages. Never lose important data. Contact Form CFDB7 plugin is an add-on for the Contact Form 7 plugin.
https://wordpress.org/plugins/file-manager-advanced
Cpanel for files management in wordpress
ReCaptcha v2 Fix for Contact Form 7 5.1 and later.
https://shortpixel.com/
ShortPixel optimizes images automatically, while guarding the quality of your images. Check your Settings > ShortPixel page on how to start optimizing your image library and make your website load faster.
http://www.velvetblues.com/web-development-blog/wordpress-plugin-update-urls/
This plugin updates all urls in your website by replacing old urls with new urls. To get started: 1) Click the "Activate" link to the left of this description, and 2) Go to your Update URLs page to use it.
http://www.wordfence.com/
Wordfence Security - Anti-virus, Firewall and Malware Scan
https://wpmailsmtp.com/
Reconfigures the wp_mail()
function to use Gmail/Mailgun/SendGrid/SMTP instead of the default mail()
and creates an options page to manage the settings.
https://yoa.st/1uj
The first true all-in-one SEO solution for WordPress, including on-page content analysis, XML sitemaps and much more.
These are a list of frequently asked questions specific to this project and the site builder/Wordpress setup in general.
Any notable updates to the sections, modules, fields or plugins will be logged here.
Tips on managing media for the site.
The system uses the default Wordpress media manager. (https://codex.wordpress.org/Media_Library_Screen)