-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
151 lines (95 loc) · 7.69 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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
=== Web Developer's Portfolio ===
Contributors: wpkaren
Donate Link: https://karenattfield.com/giving/
Tags: portfolio, post type, images, shortcode
Requires at least: 4.4
Tested up to: 5.6.2
Stable tag: 1.2.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Allowing web designers / developers a custom front-end portfolio display through shortcodes, showing both desktop & mobile images.
== Description ==
Web Developer's Portfolio is a plugin designed to showcase screenshots from both desktop and mobile devices for each portfolio listing. Portfolio items are displayed on any page of your choice using shortcodes.
This plugin works by creating a custom post type for portfolio items, and allows you to upload two separate images per portfolio item - one for a desktop screenshot and one for a mobile screenshot. Through the use of shortcodes you can then display portfolio items on a page of your choice - displaying either a desktop screenshot only, mobile screenshot only, or both.
The output is styled with Flexbox, with an excerpt and button to the project page of your choice. You can also set the portfolio items to be publicly-queryable, meaning you can add single-portfolio.php or archive-portfolio.php templates to your site to customize the design of your individual portfolio pages.
Note: If you intend to use the default styling provided by the shortcodes it is recommended that you utilize full-width pages for the best visual effect (though you are welcome to modify the CSS through your theme to fit your needs).
### Features
* **Project Link:** Add a link to the page you'd like your portfolio item to link to.
* **Mobile Image:** A second featured image upload option for each portfolio item.
* **Shortcodes:** Two different shortcodes to display either individual portfolio items by ID or all portfolio items.
* **Item ordering:** You can set the order number for each portfolio item.
* **Rich text excerpts:** Customized excerpt boxes allow for the addition of html elements as with the normal post editor.
== Installation ==
1. Upload `wdp-plugin` to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly.
1. Activate the plugin through the 'Plugins' menu in WordPress.
1. Go to the Web Developers Portfolio settings option in the admin to set whether you'd like each portfolio item to be available on a page of it's own by default.
1. Head to the 'Portfolio' menu in the admin and start building your portfolio.
== Frequently Asked Questions ==
= What are the shortcodes? =
[wd_portfolio] will output all portfolio items (images and excerpts, styled using Flexbox).
[wd_portfolio_single id="{id}"] (for example [wd_portfolio_single id="5"]) will output the portfolio item with the id specified (images and excerpt, styled using Flexbox).
= What is the point of the content editor on the portfolio editor page? =
While the purpose of this plugin is to enable you to display portfolio items via shortcodes linking to custom pages, you may choose to create custom pages on your site for your portfolio items based on the content you add directly in the portfolio editor. In the Wordpress Admin Menu, you will see a setting called ‘Web Developers Portfolio Plugin’ (Administrator-level access only). If you check the box in this settings page it will enable you to view each portfolio listing as a page. You will need to get your hands dirty with code and create a single-portfolio.php template in order to customize the page layout or an archive-portfolio.php template for an archive page – alternatively you can use the default portfolio page that is created for each portfolio item and make adjustments with php or css, depending on your theme / template.
The content within the content field will be what displays on the custom portfolio page created by this post-type.
= How can I customise the button colour? =
Add this to your child theme's style sheet:
// Main button background:
.wdp-btn {
background: #yourhexvaluehere !important; // eg. background: #27a6bc !important;
}
// On hover and active button background
.wdp-btn:hover, .wdp-btn:active {
background: #yourhexvaluehere !important; // eg. background: #52B8C9 !important;
}
= What are the recommended image sizes? =
For desktop screenshots, aim for an image ratio of width:height = 1.5:1 (for example 2550px x 1700px).
For mobile screenshots, aim for an image ratio of width:height = 1:2 (for example 250px x 500px).
= The excerpt is too long? =
WDP plugin is best suited to display on full-width pages, with reasonable excerpts (not too long). Though excerpts are capped at 70 words, your site's font size may mean this can distort the layout of the preview. Experiment with excerpt sizes until you find the display that works best for your site.
= The mobile image doesn't sit quite right with the desktop image? =
The mobile screenshot is designed to sit over the bottom right of the desktop screenshot, with an overlap into the white space below. Depending on the size of the image you've uploaded, as well as the width of the screen space available (full-width recommended), this might not sit perfectly. The recommended image proportion for the mobile screenshot is width: height = 1:2 (height double the width). If you want to increase the width of the displayed mobile image (the height is automatic based on the width) add the following to your child themes style sheet:
.wdp-mobile-preview {
max-width: yourwidthvalue !important; // adjust appropriately, for example 20%, 10em, etc.
}
= Do I need to use the shortcodes? =
No, you can use this plugin to create the portfolio custom post type and customize the portfolio page output as you wish through single-portfolio.php and archive-portfolio.php.
= Why was this plugin created? =
I had a need to display both desktop and mobile screenshots for individual portfolio items, and didn't want to have to hand-code every new item into the page template. I created this plugin to allow the process to be quick, efficient and scalable.
== Screenshots ==
1. Edit portfolio item admin screen
2. Portfolio item management admin screen
3. Portfolio settings admin screen
4. Screenshot of portfolio shortcode output on front-end
== Changelog ==
= 1.2.0 =
* Added ability to change portfolio slug, avoiding page name conflicts
= 1.1.1 =
* Fix: Implode function wasn't displaying button text in some instances
= 1.1.0 =
* Added ability to change portfolio url button text in WDP Portfolio Settings page
* Fix: Changed call to title and button text in mobile media uploader to avoid Ninja Forms plugin conflict
* Fix: Edited several instances of translatable strings for internationalisation
= 1.0.1 =
* Fix: Changing target page from button url's to be internal rather than external
* Changing short description in readme.txt
= 1.0.0 =
* First stable version
* Fix to prevent shortcode output always displaying before content
* Fix to over-ride max posts per page setting for shortcode output
* Changing ordering of portfolio items on listings page to be by date added
* Updated readme.txt - added to 'short description' of plugin
= 0.1.0 =
* Initial release
== Upgrade Notice ==
= 1.2.0 =
* Added ability to change portfolio slug, avoiding page name conflicts
= 1.1.1 =
* Fix: Implode function wasn't displaying button text in some instances
= 1.1.0 =
* Adding ability to change portfolio url button text, and fixing Ninja Forms conflict with mobile image uploader
= 1.0.1 =
* Changing target page from button url's to be internal, and changing short description
= 1.0.0 =
* First stable version. Fix to prevent shortcode output always displaying before content, and to allow unlimited number of items to display on the shortcode page
= 0.1.0 =
* Initial release, no upgrade notice