|
|
@@ -0,0 +1,337 @@
|
|
|
+<!DOCTYPE html>
|
|
|
+
|
|
|
+<html>
|
|
|
+<head>
|
|
|
+<title>Building Admin - SEO - QOR5 Document</title>
|
|
|
+
|
|
|
+<meta name='description'>
|
|
|
+<meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
+<base href='/docs/'>
|
|
|
+
|
|
|
+<link href='index.css' rel='stylesheet' type='text/css'>
|
|
|
+
|
|
|
+<script type='text/javascript' defer src='index.js'></script>
|
|
|
+</head>
|
|
|
+
|
|
|
+<body>
|
|
|
+<div id='app' v-cloak>
|
|
|
+<div v-init-context:vars='{hideAside: false}' class='flex h-screen'>
|
|
|
+<div class='flex-1 flex flex-col overflow-hidden'>
|
|
|
+<div class='flex h-full'>
|
|
|
+<aside v-show='!vars.hideAside' id='menuScroller' class='flex flex-col w-80 h-full bg-gray-50 border-r border-gray-200 overflow-y-auto'>
|
|
|
+<div class='h-12'><search></search></div>
|
|
|
+
|
|
|
+<ul class='px-0 py-3 mx-0 text-base font-normal list-none text-gray-700'>
|
|
|
+<li class='m-0'>
|
|
|
+<a href='index.html' id='index.html' onclick='window.storeMenuState("index.html")' class='inline-block px-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Introduction</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>Getting Started</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='getting-started/one-minute-quick-start.html' id='getting-started/one-minute-quick-start.html' onclick='window.storeMenuState("getting-started/one-minute-quick-start.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>1 Minute Quick Start</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>Building Admin</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/listing.html' id='basics/listing.html' onclick='window.storeMenuState("basics/listing.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Listing</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/filter.html' id='basics/filter.html' onclick='window.storeMenuState("basics/filter.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Filters</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='presets-guide/editing-customizations.html' id='presets-guide/editing-customizations.html' onclick='window.storeMenuState("presets-guide/editing-customizations.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Editing</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/brand.html' id='basics/brand.html' onclick='window.storeMenuState("basics/brand.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Brand</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/menu.html' id='basics/menu.html' onclick='window.storeMenuState("basics/menu.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Menu</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='presets-guide/detail-page-for-complex-object.html' id='presets-guide/detail-page-for-complex-object.html' onclick='window.storeMenuState("presets-guide/detail-page-for-complex-object.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Detailing</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/layout.html' id='basics/layout.html' onclick='window.storeMenuState("basics/layout.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Layout</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='presets-guide/permissions.html' id='presets-guide/permissions.html' onclick='window.storeMenuState("presets-guide/permissions.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Permissions</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='presets-guide/role.html' id='presets-guide/role.html' onclick='window.storeMenuState("presets-guide/role.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Role</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/notification-center.html' id='basics/notification-center.html' onclick='window.storeMenuState("basics/notification-center.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Notification Center</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/shortcut.html' id='basics/shortcut.html' onclick='window.storeMenuState("basics/shortcut.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Keyboard Shortcut</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/confirm-dialog.html' id='basics/confirm-dialog.html' onclick='window.storeMenuState("basics/confirm-dialog.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Confirm Dialog</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='slug.html' id='slug.html' onclick='window.storeMenuState("slug.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Slug</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='seo.html' id='seo.html' onclick='window.storeMenuState("seo.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-blue-500'>SEO</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='activity-log.html' id='activity-log.html' onclick='window.storeMenuState("activity-log.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Activity Log</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/worker.html' id='basics/worker.html' onclick='window.storeMenuState("basics/worker.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Worker</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>Web Application</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/page-func-and-event-func.html' id='basics/page-func-and-event-func.html' onclick='window.storeMenuState("basics/page-func-and-event-func.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Page Func and Event Func</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='advanced-functions/the-go-html-builder.html' id='advanced-functions/the-go-html-builder.html' onclick='window.storeMenuState("advanced-functions/the-go-html-builder.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>The Go HTML builder</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='presets-guide/its-the-whole-house.html' id='presets-guide/its-the-whole-house.html' onclick='window.storeMenuState("presets-guide/its-the-whole-house.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Not just scaffolding, it's the whole house</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='vuetify-components/lazy-portals.html' id='vuetify-components/lazy-portals.html' onclick='window.storeMenuState("vuetify-components/lazy-portals.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Lazy Portals</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/layout-function-and-page-injector.html' id='basics/layout-function-and-page-injector.html' onclick='window.storeMenuState("basics/layout-function-and-page-injector.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Layout Function and Page Injector</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/switch-pages-with-push-state.html' id='basics/switch-pages-with-push-state.html' onclick='window.storeMenuState("basics/switch-pages-with-push-state.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Switch Pages with Push State</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/reload-page-with-a-flash.html' id='basics/reload-page-with-a-flash.html' onclick='window.storeMenuState("basics/reload-page-with-a-flash.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Reload Page with a Flash</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/partial-refresh-with-portal.html' id='basics/partial-refresh-with-portal.html' onclick='window.storeMenuState("basics/partial-refresh-with-portal.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Partial Refresh with Portal</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/manipulate-page-url-in-event-func.html' id='basics/manipulate-page-url-in-event-func.html' onclick='window.storeMenuState("basics/manipulate-page-url-in-event-func.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Manipulate Page URL in Event Func</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/summary-of-event-response.html' id='basics/summary-of-event-response.html' onclick='window.storeMenuState("basics/summary-of-event-response.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Summary of Event Response</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/scope-component.html' id='basics/scope-component.html' onclick='window.storeMenuState("basics/scope-component.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Scope Component</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/event-handling.html' id='basics/event-handling.html' onclick='window.storeMenuState("basics/event-handling.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Event Handling</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='basics/form-handling.html' id='basics/form-handling.html' onclick='window.storeMenuState("basics/form-handling.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Form Handling</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>UI Components</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='vuetify-components/basic-inputs.html' id='vuetify-components/basic-inputs.html' onclick='window.storeMenuState("vuetify-components/basic-inputs.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Basic Inputs</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='vuetify-components/a-taste-of-using-vuetify-in-go.html' id='vuetify-components/a-taste-of-using-vuetify-in-go.html' onclick='window.storeMenuState("vuetify-components/a-taste-of-using-vuetify-in-go.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>A Taste of using Vuetify in Go</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='vuetify-components/linkage-select.html' id='vuetify-components/linkage-select.html' onclick='window.storeMenuState("vuetify-components/linkage-select.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Linkage Select</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='vuetify-components/auto-complete.html' id='vuetify-components/auto-complete.html' onclick='window.storeMenuState("vuetify-components/auto-complete.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Auto Complete</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='components-guide/composite-new-component-with-go.html' id='components-guide/composite-new-component-with-go.html' onclick='window.storeMenuState("components-guide/composite-new-component-with-go.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Composite new Component With Go</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='components-guide/integrate-a-heavy-vue-component.html' id='components-guide/integrate-a-heavy-vue-component.html' onclick='window.storeMenuState("components-guide/integrate-a-heavy-vue-component.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Integrate a heavy Vue Component</a>
|
|
|
+</li>
|
|
|
+
|
|
|
+<li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>Appendix</li>
|
|
|
+
|
|
|
+<li class='m-0'>
|
|
|
+<a href='appendix/all-demo-examples.html' id='appendix/all-demo-examples.html' onclick='window.storeMenuState("appendix/all-demo-examples.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>All Demo Examples</a>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</aside>
|
|
|
+
|
|
|
+<main class='flex flex-col w-full bg-white overflow-x-hidden overflow-y-auto'>
|
|
|
+<div id='docContentBox' class='flex flex-row w-full'>
|
|
|
+<div class='flex flex-grow flex-col w-2/3'>
|
|
|
+<div class='flex flex-row'>
|
|
|
+<button @click='vars.hideAside = !vars.hideAside' class='w-12 h-12 p-4'>
|
|
|
+<div class='w-4 h-4 fill-current text-gray-300'>
|
|
|
+<?xml version="1.0" encoding="UTF-8"?>
|
|
|
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="16px" height="16px" viewBox="0 0 16 16" version="1.1">
|
|
|
+<g id="surface1">
|
|
|
+<path style=" stroke:none;fill-rule:nonzero;fill:rgb(0%,0%,0%);fill-opacity:1;" d="M 2 12 L 2 11 L 14 11 L 14 12 Z M 2 8.5 L 2 7.5 L 14 7.5 L 14 8.5 Z M 2 5 L 2 4 L 14 4 L 14 5 Z M 2 5 "/>
|
|
|
+</g>
|
|
|
+</svg>
|
|
|
+</div>
|
|
|
+</button>
|
|
|
+</div>
|
|
|
+
|
|
|
+<div id='docMainBox' class='px-16 pb-12 pt-4 overflow-auto'>
|
|
|
+<h1 class='mb-8'>SEO</h1>
|
|
|
+
|
|
|
+<div class='border-t'><p>The SEO library facilitates the optimization of Search Engine results by managing and injecting dynamic data into HTML tags.</p>
|
|
|
+<h2><a name="usage" class="anchor" href="#usage" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Usage</h2>
|
|
|
+
|
|
|
+<p>Initialize a <code>Collection</code> instance. The <code>Collection</code> manages all the registered models and hold global seo settings</p>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>collection := seo.NewCollection()
|
|
|
+
|
|
|
+// Turn off the default inherit the upper level SEO data when the current SEO data is missing
|
|
|
+collection.SetInherited(false)
|
|
|
+</pre></div>
|
|
|
+<h3><a name="register-models-to-seo" class="anchor" href="#register-models-to-seo" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Register models to SEO</h3>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>// Register mutiple SEO by name
|
|
|
+collection.RegisterSEOByNames("Product", "Announcement")
|
|
|
+
|
|
|
+// Register a SEO by model
|
|
|
+type Product struct{
|
|
|
+ Name string
|
|
|
+ Setting Setting
|
|
|
+}
|
|
|
+collection.RegisterSEO(&Product{})
|
|
|
+</pre></div>
|
|
|
+<h3><a name="remove-models-from-seo" class="anchor" href="#remove-models-from-seo" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Remove models from SEO</h3>
|
|
|
+
|
|
|
+<pre><code>// Remove by struct
|
|
|
+collection.RemoveSEO(&Product{})
|
|
|
+// Remove by name
|
|
|
+collection.RemoveSEO("Not Found")
|
|
|
+</code></pre>
|
|
|
+<h2><a name="configuration" class="anchor" href="#configuration" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Configuration</h2>
|
|
|
+<h3><a name="change-the-default-global-seo-name" class="anchor" href="#change-the-default-global-seo-name" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Change the default global SEO name</h3>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>collection.SetGlobalName("My Global SEO")
|
|
|
+</pre></div>
|
|
|
+<h3><a name="change-the-default-context-db-key" class="anchor" href="#change-the-default-context-db-key" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Change the default context db key</h3>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>collection.SetDBContextKey("My DB")
|
|
|
+</pre></div>
|
|
|
+<h3><a name="change-the-default-seo-name" class="anchor" href="#change-the-default-seo-name" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Change the default SEO name</h3>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>collection.RegisterSEO(&Product{}).SetName("My Product")
|
|
|
+</pre></div>
|
|
|
+<h3><a name="register-customized-variables" class="anchor" href="#register-customized-variables" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Register customized variables</h3>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>collection.RegisterSEO(&Product{}).
|
|
|
+ RegisterContextVariables("og:image", func(obj interface{}, _ *Setting, _ *http.Request) string {
|
|
|
+ // this will render "og:image" with the value of the object in the current request
|
|
|
+ return obj.image.url
|
|
|
+ }).
|
|
|
+ RegisterContextVariables("Name", func(obj interface{}, _ *Setting, _ *http.Request) string {
|
|
|
+ return obj.Name
|
|
|
+ })
|
|
|
+</pre></div>
|
|
|
+<h3><a name="register-setting-variable" class="anchor" href="#register-setting-variable" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Register setting variable</h3>
|
|
|
+
|
|
|
+<p>This variable will be saved in the database and available as a global variable while editing SEO settings.</p>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>collection.RegisterSEO(&Product{}).RegisterSettingVaribles(struct{ProductTag string}{})
|
|
|
+</pre></div>
|
|
|
+<h3><a name="render-seo-html-data" class="anchor" href="#render-seo-html-data" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Render SEO html data</h3>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>// Render Global SEO
|
|
|
+collection.RenderGlobal(request)
|
|
|
+
|
|
|
+// Render SEO by name
|
|
|
+collection.Render("product", request)
|
|
|
+
|
|
|
+// Render SEO by model
|
|
|
+collection.Render(Product{}, request)
|
|
|
+</pre></div>
|
|
|
+<h2><a name="customization" class="anchor" href="#customization" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
|
|
|
+Customization</h2>
|
|
|
+<p>You can customize your SEO settings by implementing the interface and adding functions such as l10n and publish.</p>
|
|
|
+
|
|
|
+<highlightjs :language='"go"' :code='"type QorSEOSettingInterface interface {\n\tGetName() string\n\tSetName(string)\n\tGetSEOSetting() Setting\n\tSetSEOSetting(Setting)\n\tGetVariables() Variables\n\tSetVariables(Variables)\n\tGetTitle() string\n\tGetDescription() string\n\tGetKeywords() string\n\tGetOpenGraphURL() string\n\tGetOpenGraphType() string\n\tGetOpenGraphImageURL() string\n\tGetOpenGraphImageFromMediaLibrary() media_library.MediaBox\n\tGetOpenGraphMetadata() []OpenGraphMetadata\n}\n"'></highlightjs>
|
|
|
+<p>Suppose <code>QorSEOSetting</code> implemented the above interface</p>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>type MySEOSetting struct{
|
|
|
+ QorSEOSetting
|
|
|
+ // publish
|
|
|
+ // l10n
|
|
|
+}
|
|
|
+</pre></div>
|
|
|
+
|
|
|
+<p>Use <code>SetSettingModel</code> function to set it</p>
|
|
|
+
|
|
|
+<div class="highlight highlight-go"><pre>collection.SetSettingModel(&MySEOSetting{})
|
|
|
+</pre></div>
|
|
|
+
|
|
|
+<h2>Example</h2>
|
|
|
+
|
|
|
+<highlightjs :language='"go"' :code='"var SeoCollection *seo.Collection\n\nfunc ConfigureSeo(b *presets.Builder, db *gorm.DB) {\n\tSeoCollection = seo.NewCollection()\n\tSeoCollection.RegisterSEO(\u0026models.Post{}).RegisterContextVariables(\n\t\t\"Title\",\n\t\tfunc(object interface{}, _ *seo.Setting, _ *http.Request) string {\n\t\t\tif article, ok := object.(models.Post); ok {\n\t\t\t\treturn article.Title\n\t\t\t}\n\t\t\treturn \"\"\n\t\t},\n\t).RegisterSettingVaribles(struct{ Test string }{})\n\tSeoCollection.RegisterSEOByNames(\"Not Found\", \"Internal Server Error\")\n\tSeoCollection.Configure(b, db)\n}\n"'></highlightjs>
|
|
|
+<h2><a name="definition" class="anchor" href="#definition" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>Definition</h2>
|
|
|
+
|
|
|
+<p><code>Collection</code> manages all the registered models and hold global seo settings.</p>
|
|
|
+
|
|
|
+<highlightjs :language='"go"' :code='"type Collection struct {\n\tregisteredSEO []*SEO\n\tglobalName string //default name is GlobalSEO\n\tinherited bool //default is true. the order is model seo setting, system seo setting, global seo setting\n\tdbContextKey interface{} // get db from context\n\tsettingModel interface{} // db model\n}\n"'></highlightjs>
|
|
|
+<p><code>SEO</code> provides system-level default page matadata.</p>
|
|
|
+
|
|
|
+<highlightjs :language='"go"' :code='"type SEO struct {\n\tname string\n\tmodelTyp reflect.Type\n\tcontextVariables map[string]contextVariablesFunc // fetch context variables from request\n\tsettingVariables interface{} // fetch setting variables from db\n}\n"'></highlightjs>
|
|
|
+<p>You can use seo setting at the model level, but you need to register the model to the system SEO</p>
|
|
|
+
|
|
|
+<highlightjs :language='"go"' :code='"type Product struct {\n\tName string\n\tSEO Setting\n}\n"'></highlightjs>
|
|
|
+
|
|
|
+<highlightjs :language='"go"' :code='"collection.RegisterSEO(\u0026Product{})"'></highlightjs>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+
|
|
|
+<div class='font-medium text-base hidden xl:block text-gray-600 pt-4'>
|
|
|
+<div class='sticky top-4 w-52'>On This Page<toc></toc></div>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<search-result></search-result></main>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+</body>
|
|
|
+</html>
|
Raven