Add canonical tag

Added canonical tag for doc pages, also redirects if there was a stripped char in the url
foundeo · Sep 13, 2024 · 9c871b9 · 9c871b9
1 parent d781ed2
commit 9c871b9
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/doc.cfm b/doc.cfm
@@ -1,10 +1,12 @@
 <cfparam name="url.name" default="cfquery">
+<cfset request.unsafe_name = url.name>
 <cfset url.name = ReReplace(url.name, "[^a-zA-Z0-9_-]", "", "ALL")>
 <cfif url.name IS "index">
-	<cfset data = {name="CFDocs", description="Ultra Fast CFML Documentation", type="index"}>
+	<cfset data = {name="CFDocs", description="Ultra Fast CFML / ColdFusion Documentation", type="index"}>
 <cfelseif FileExists(ExpandPath("./guides/en/#url.name#.md")) OR url.name is "how-to-contribute">
 	<cfset request.ogname = url.name>
 	<cfset request.hasExamples = true>
+	<cfset request.canonical_url = "https://cfdocs.org/#lcase(url.name)#">
 	<cftry>
 		<!--- convert md to HTML --->
 		<cfset flexmark = new lib.Processor() >
@@ -21,6 +23,7 @@
 	<cfset data = DeserializeJSON( FileRead(ExpandPath("./data/en/#url.name#.json")))>
 	<cfset request.ogname = url.name>
 	<cfset request.gitFilePath = "/edit/master/data/en/" & url.name & ".json">
+	<cfset request.canonical_url = "https://cfdocs.org/#lcase(url.name)#">
 <cfelse>
 	<cfset url.name = ReReplace(url.name, "[^a-zA-Z0-9._-]", "", "ALL")>
 	<cfset possible = []>
@@ -43,6 +46,10 @@
 	}>
 	<cfheader statuscode="404" statustext="Not Found">
 </cfif>
+<cfif request.keyExists("canonical_url") AND request.unsafe_name IS NOT url.name>
+	<!--- there was a stripped char in url, redirect --->
+	<cflocation url="#request.canonical_url#" addtoken="false" statuscode="301">
+</cfif>
 <cfif isStruct(data)>
 	<cfset request.title = data.name>
 	<cfif structKeyExists(data, "examples") AND arrayLen(data.examples) GT 0>

diff --git a/index.cfm b/index.cfm
@@ -1,2 +1,3 @@
 <cfset url.name = "index">
+<cfset request.canonical_url = "https://cfdocs.org/">
 <cfinclude template="views/index.cfm">
diff --git a/views/index.cfm b/views/index.cfm
@@ -19,7 +19,7 @@ qPeople = oLeader.get();
     </div>
     <div class="col-lg-4">
       <h2><span class="glyphicon glyphicon-thumbs-up"></span> &nbsp; Handy</h2>
-      <p>Easy urls like: <a href="/hash">cfdocs.org/hash</a> just hit <code>/tag-name</code> or <code>/function-name</code>.</p>
+      <p>Easy urls like: <a href="/cfquery">cfdocs.org/cfquery</a> just hit <code>/tag-name</code> or <code>/function-name</code>.</p>
     </div>
     <div class="col-lg-4">
       <h2><span class="glyphicon glyphicon-cutlery"></span> &nbsp; Forkable</h2>

diff --git a/views/layout.cfm b/views/layout.cfm
@@ -31,6 +31,9 @@
 		<meta name="twitter:card" content="summary_large_image" />
 		<meta name="twitter:title" content="#ReReplace(request.title, "[^a-zA-Z0-9 ._-]", "", "ALL")# CFML Documentation" />
 		<meta name="twitter:description" content="#EncodeForHTMLAttribute(request.description)#" />
+		<cfif request.keyExists("canonical_url")>
+			<link rel="canonical" href="#reReplace(lcase(request.canonical_url), "[^a-z:/-]", "", "ALL")#">
+		</cfif>
 </cfoutput>
 </head>
 <body>