2 |
3 |
104 |
--------------------------------------------------------------------------------
/app/scripts/controllers/metadata.controller.js:
--------------------------------------------------------------------------------
1 | angular.module("umbraco")
2 | .controller("EpiphanySeoMetadataController",
3 | [
4 | '$scope', 'contentResource', function($scope, contentResource) {
5 | $scope.invalidate = true;
6 | $scope.model.hideLabel = true;
7 | $scope.serpTitleLength = !$scope.model.config.serpTitleLength ? $scope.model.config.serpTitleLength : 65;
8 | $scope.serpDescriptionLength = !$scope.model.config.serpDescriptionLength ? $scope.model.config.serpDescriptionLength : 150;
9 | $scope.developerName = $scope.model.config.developerName || 'your agency';
10 | $scope.doNotIndexExplanation = $scope.model.config.doNotIndexExplanation || '';
11 | $scope.siteTitle = $scope.model.config.siteTitle || '';
12 |
13 | // default model.value
14 | if (!$scope.model.value) {
15 | $scope.model.value = { title: '', description: '', urlName: '', noIndex: false };
16 | }
17 |
18 | // a very basic slugify function to replace chars in url
19 | function slugify(text) {
20 | return text.toString()
21 | .toLowerCase()
22 | .trim()
23 | .replace(/\s+/g, '-') // Replace spaces with -
24 | .replace(/&/g, '') // Replace & with nothing
25 | .replace(/[^\w\-]+/g, '') // Remove all non-word chars
26 | .replace(/\-\-+/g, '-'); // Replace multiple - with single -
27 | }
28 |
29 | $scope.init = function() {
30 | var content = $scope.GetParentContent();
31 | if (!content.published) {
32 | // get the URL of the parent document for later
33 | contentResource.getById(content.parentId).then(function(data) {
34 | $scope.parentUrl = data.urls[0];
35 | });
36 | }
37 | };
38 |
39 | $scope.GetUrl = function() {
40 |
41 | var name, url;
42 | var pageContent = $scope.GetParentContent();
43 |
44 | // handle instances where the document is newly created and unpublished
45 | if (!pageContent.published) {
46 | if ($scope.model.value.urlName && $scope.model.value.urlName.length) {
47 | name = slugify($scope.model.value.urlName);
48 | } else if (typeof(pageContent.name) !== 'undefined') {
49 | name = slugify(pageContent.name);
50 | }
51 |
52 | if (typeof(name) === 'undefined' || name.length === 0) {
53 | name = "unpublished-page";
54 | }
55 |
56 | return $scope.ProtocolAndHost() + $scope.parentUrl + name + "/";
57 | }
58 |
59 | var nodeUrl = pageContent.urls[0];
60 |
61 | // test if it is an absolute url: http://stackoverflow.com/a/10687158
62 | url = /^https?:\/\//i.test(nodeUrl) ? nodeUrl : $scope.ProtocolAndHost() + nodeUrl;
63 |
64 | var urlSplit = url.split('/');
65 |
66 | // we got a slug configured?
67 | if ($scope.model.value.urlName && $scope.model.value.urlName.length) {
68 |
69 | // http://mydomain.com will be split into an array of 3 strings: 'http:', '' and 'mydomain.com'
70 | // only handle slugify of urlName under root level
71 | if (urlSplit.length > 4) {
72 | if (urlSplit[urlSplit.length - 1] === "") {
73 | urlSplit[urlSplit.length - 2] = slugify($scope.model.value.urlName);
74 | } else {
75 | urlSplit[urlSplit.length - 1] = slugify($scope.model.value.urlName);
76 | }
77 | }
78 |
79 | // join new values
80 | url = urlSplit.join('/');
81 | } else {
82 | // use the name of the document instead
83 | urlSplit.splice(-2, 2); // pop the last slug off the end of the array, use the document name instead
84 | name = pageContent.name ? slugify(pageContent.name) : 'unpublished-page';
85 | url = urlSplit.join('/') + '/' + name + '/';
86 | }
87 |
88 | return url;
89 | };
90 |
91 | $scope.ProtocolAndHost = function() {
92 |
93 | var http = location.protocol;
94 | var slashes = http.concat("//");
95 | return slashes.concat(window.location.hostname);
96 | };
97 |
98 | $scope.GetTitle = function () {
99 |
100 | var title = $scope.model.value.title || 'Page Title';
101 |
102 | if (title !== 'Page Title' && $scope.siteTitle !== '') {
103 | title += $scope.siteTitle.replace(' ', ' ');
104 | }
105 | return title;
106 | };
107 |
108 | $scope.GetParentContent = function() {
109 | var currentScope = $scope.$parent;
110 |
111 | for (var i = 0; i < 150; i++) {
112 | if (currentScope.content) {
113 | return currentScope.content;
114 | }
115 |
116 | currentScope = currentScope.$parent;
117 | }
118 |
119 | return null;
120 | };
121 |
122 |
123 | $(window).resize(function() {
124 | $scope.$apply(function() {
125 | if (window.innerWidth <= 1500 && !$scope.hideSerp) {
126 | $scope.hideSerp = true;
127 | }
128 | if (window.innerWidth > 1500) {
129 | $scope.hideSerp = false;
130 | }
131 | });
132 | });
133 |
134 | $scope.init();
135 | }
136 | ]);
137 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # SEO Metadata for Umbraco
2 |
3 | **This package is no longer maintained. See https://github.com/ryanlewis/seo-metadata/issues/35**
4 |
5 | [](https://ci.appveyor.com/project/ryanlewis/seo-metadata)
6 |
7 | SEO Metadata for Umbraco is a property editor that is used for maintaining common SEO-related information for a page. It gives users a visual representation of how the page would look on a Google search result page and hints to when the title and description is too long, with optional validation.
8 |
9 | 
10 |
11 | ## Recent Changes
12 |
13 | **0.4.0**
14 |
15 | * Better handling when multiple domains are configured (#20, #23 - thanks @bjarnef!)
16 | * Ability to configure an appended title to SEO titles (#22 - thanks @JJCLane!)
17 |
18 | **0.3.0**
19 |
20 | * Allow for recursive property values if all the fields are blank and the AppSettingKey is set.
21 |
22 | **0.2.1**
23 |
24 | * Fixed some issues with Umbraco package
25 | * Resolved issue with PropertyEditorValueConverter returning null if page is saved when control is unused
26 |
27 | **0.2.0**
28 |
29 | * Fixed issue with custom URL Names not working if `SeoMetadata.NoSegmentProvider` appSetting wasn't present
30 | * Added new option to set the developer name
31 |
32 | **0.1.0**
33 |
34 | * Initial release
35 |
36 |
37 | ## Installation
38 |
39 | Install the latest version through NuGet.
40 | ```
41 | Install-Package Epiphany.SeoMetadata
42 | ```
43 |
44 | After installing via Nuget, create a property editor of type **SEO Metadata** and include on your page. We recommend the property name **"metadata"** to work with all features out-of-the-box (see the [URL Name](#using-the-url-name) section for configuration options)
45 |
46 | 
47 |
48 | Alternatively, if you want to hack around with the project, you can fork, checkout and develop locally. See the [Developing SEO Metadata](#developing-seo-metadata) section.
49 |
50 | ## Configuration
51 |
52 |
4 |
75 |
76 |
5 |
6 |
7 |
10 |
59 |
60 |
11 |
12 |
13 |
14 | {{model.value.title.length}}!
15 |
16 |
17 |
29 |
30 |
33 |
18 |
26 |
27 | Page title is too long
28 | 19 | The Title should be an accurate and concise description of a page's content, and is critical to both a user experience 20 | and search engine optimisation. 21 |
22 |23 | More Information: Title Tag (Moz.com) 24 |
25 |
34 |
35 |
36 | {{model.value.description.length}}!
37 |
38 |
39 |
58 |
40 |
52 |
53 |
54 |
55 |
56 | Page description is too long
57 | 41 | Meta Descriptions are commonly used in search engine result pages, and are extremely important in gaining user click-through. 42 |
43 | 44 |45 | Make sure to let users know whether the page contains the information they're looking for. 46 |
47 | 48 |49 | More Information: Meta Description (Moz.com) 50 |
51 |
61 | Google Preview (Toggle)
62 |
74 |
63 |
64 | 
65 | 
72 |
73 |
65 |
66 |
70 |
71 | {{ GetTitle() || 'Page Title' | ellipsisLimit:serpTitleLength}}
67 | {{ GetUrl() }} 68 |{{ model.value.description || 'My Nice Description of this Page' | ellipsisLimit:serpDescriptionLength }}
69 |
72 |
77 |
90 |
78 |
79 |
89 |
80 |
81 |
88 |
82 |
87 | This is the URL segment that will be used on the site. It is okay to leave this blank (Umbraco will create a URL based off the page name).
83 |Be careful when setting/changing this. It is generally bad practice to change this once a page has been published, unless you've got the Url Tracker installed.
84 |If unsure, leave as-is and speak to {{ developerName }} for advice.
85 | 86 |
91 |
103 |
92 |
93 |
102 |
94 |
95 |
96 |
101 |
97 |
100 | {{ doNotIndexExplanation }}
98 |If unsure, leave as-is and speak to {{ developerName }} for advice.
99 |-
53 |
- Allow long titles 54 |
- If ticked, long titles will not invalidate the property editor. 55 | 56 |
- Allow long descriptions 57 |
- If ticked, long descriptions will not invalidate the property editor. 58 | 59 |
- SERP Title Length 60 |
- The maximum length of a title. This isn't an exact number, so your mileage may vary. The default value of 65 is a conservative value that should work for most cases. Google will truncate overly long titles with ellipses (…) 61 | 62 |
- SERP Description Length 63 |
- The maximum length of the description. This isn't an exact number, so your mileage may vary. The default value of 150 is a conservative value that should work for most cases. Google will truncate overly long descriptions with ellipses (…) 64 | 65 |
- Developer Name 66 |
- Allows you to personalise the template a bit by putting the name of your company/agency/other. This is used within the descriptions on the view and is displayed to your content editors. 67 | 68 |
- Site Title 69 |
- Allows you to configure a site title that is appended to the title (e.g. " | My Company") 70 |
126 |
141 |
142 |