Home Explore Help
Register Sign In
qor5
/
docs
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 9bb5594747
Branches Tags
docs
/
docs
/
seo.html

seo.html 21 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345 
  1. <!DOCTYPE html>
    2. 

  2. 

  3. <html>
    4. 

  4. <head>
    5. 

  5. <title>Building Admin - SEO - QOR5 Document</title>
    6. 

  6. 

  7. <meta name='description'>
    8. 

  8. <meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1">
    9. 

  9. <base href='/docs/'>
    10. 

  10. 

  11. <link href='index.css' rel='stylesheet' type='text/css'>
    12. 

  12. 

  13. <script type='text/javascript' defer src='index.js'></script>
    14. 

  14. </head>
    15. 

  15. 

  16. <body>
    17. 

  17. <div id='app' v-cloak>
    18. 

  18. <div v-init-context:vars='{hideAside: false}' class='flex h-screen'>
    19. 

  19. <div class='flex-1 flex flex-col overflow-hidden'>
    20. 

  20. <div class='flex h-full'>
    21. 

  21. <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'>
    22. 

  22. <div class='h-12'><search></search></div>
    23. 

  23. 

  24. <ul class='px-0 py-3 mx-0 text-base font-normal list-none text-gray-700'>
    25. 

  25. <li class='m-0'>
    26. 

  26. <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>
    27. 

  27. </li>
    28. 

  28. 

  29. <li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>Getting Started</li>
    30. 

  30. 

  31. <li class='m-0'>
    32. 

  32. <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>
    33. 

  33. </li>
    34. 

  34. 

  35. <li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>Building Admin</li>
    36. 

  36. 

  37. <li class='m-0'>
    38. 

  38. <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>
    39. 

  39. </li>
    40. 

  40. 

  41. <li class='m-0'>
    42. 

  42. <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>
    43. 

  43. </li>
    44. 

  44. 

  45. <li class='m-0'>
    46. 

  46. <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>
    47. 

  47. </li>
    48. 

  48. 

  49. <li class='m-0'>
    50. 

  50. <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>
    51. 

  51. </li>
    52. 

  52. 

  53. <li class='m-0'>
    54. 

  54. <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>
    55. 

  55. </li>
    56. 

  56. 

  57. <li class='m-0'>
    58. 

  58. <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>
    59. 

  59. </li>
    60. 

  60. 

  61. <li class='m-0'>
    62. 

  62. <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>
    63. 

  63. </li>
    64. 

  64. 

  65. <li class='m-0'>
    66. 

  66. <a href='basics/login.html' id='basics/login.html' onclick='window.storeMenuState("basics/login.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Login</a>
    67. 

  67. </li>
    68. 

  68. 

  69. <li class='m-0'>
    70. 

  70. <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>
    71. 

  71. </li>
    72. 

  72. 

  73. <li class='m-0'>
    74. 

  74. <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>
    75. 

  75. </li>
    76. 

  76. 

  77. <li class='m-0'>
    78. 

  78. <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>
    79. 

  79. </li>
    80. 

  80. 

  81. <li class='m-0'>
    82. 

  82. <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>
    83. 

  83. </li>
    84. 

  84. 

  85. <li class='m-0'>
    86. 

  86. <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>
    87. 

  87. </li>
    88. 

  88. 

  89. <li class='m-0'>
    90. 

  90. <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>
    91. 

  91. </li>
    92. 

  92. 

  93. <li class='m-0'>
    94. 

  94. <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>
    95. 

  95. </li>
    96. 

  96. 

  97. <li class='m-0'>
    98. 

  98. <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>
    99. 

  99. </li>
    100. 

  100. 

  101. <li class='m-0'>
    102. 

  102. <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>
    103. 

  103. </li>
    104. 

  104. 

  105. <li class='m-0'>
    106. 

  106. <a href='basics/l10n.html' id='basics/l10n.html' onclick='window.storeMenuState("basics/l10n.html")' class='inline-block pl-10 pr-4 py-1 truncate break-words w-64 hover:text-blue-400 text-gray-700'>Localization</a>
    107. 

  107. </li>
    108. 

  108. 

  109. <li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>Web Application</li>
    110. 

  110. 

  111. <li class='m-0'>
    112. 

  112. <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>
    113. 

  113. </li>
    114. 

  114. 

  115. <li class='m-0'>
    116. 

  116. <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>
    117. 

  117. </li>
    118. 

  118. 

  119. <li class='m-0'>
    120. 

  120. <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&#39;s the whole house</a>
    121. 

  121. </li>
    122. 

  122. 

  123. <li class='m-0'>
    124. 

  124. <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>
    125. 

  125. </li>
    126. 

  126. 

  127. <li class='m-0'>
    128. 

  128. <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>
    129. 

  129. </li>
    130. 

  130. 

  131. <li class='m-0'>
    132. 

  132. <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>
    133. 

  133. </li>
    134. 

  134. 

  135. <li class='m-0'>
    136. 

  136. <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>
    137. 

  137. </li>
    138. 

  138. 

  139. <li class='m-0'>
    140. 

  140. <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>
    141. 

  141. </li>
    142. 

  142. 

  143. <li class='m-0'>
    144. 

  144. <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>
    145. 

  145. </li>
    146. 

  146. 

  147. <li class='m-0'>
    148. 

  148. <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>
    149. 

  149. </li>
    150. 

  150. 

  151. <li class='m-0'>
    152. 

  152. <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>
    153. 

  153. </li>
    154. 

  154. 

  155. <li class='m-0'>
    156. 

  156. <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>
    157. 

  157. </li>
    158. 

  158. 

  159. <li class='m-0'>
    160. 

  160. <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>
    161. 

  161. </li>
    162. 

  162. 

  163. <li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>UI Components</li>
    164. 

  164. 

  165. <li class='m-0'>
    166. 

  166. <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>
    167. 

  167. </li>
    168. 

  168. 

  169. <li class='m-0'>
    170. 

  170. <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>
    171. 

  171. </li>
    172. 

  172. 

  173. <li class='m-0'>
    174. 

  174. <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>
    175. 

  175. </li>
    176. 

  176. 

  177. <li class='m-0'>
    178. 

  178. <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>
    179. 

  179. </li>
    180. 

  180. 

  181. <li class='m-0'>
    182. 

  182. <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>
    183. 

  183. </li>
    184. 

  184. 

  185. <li class='m-0'>
    186. 

  186. <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>
    187. 

  187. </li>
    188. 

  188. 

  189. <li class='cursor-default px-4 py-1 truncate break-words w-64 m-0'>Appendix</li>
    190. 

  190. 

  191. <li class='m-0'>
    192. 

  192. <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>
    193. 

  193. </li>
    194. 

  194. </ul>
    195. 

  195. </aside>
    196. 

  196. 

  197. <main class='flex flex-col w-full bg-white overflow-x-hidden overflow-y-auto'>
    198. 

  198. <div id='docContentBox' class='flex flex-row w-full'>
    199. 

  199. <div class='flex flex-grow flex-col w-2/3'>
    200. 

  200. <div class='flex flex-row'>
    201. 

  201. <button @click='vars.hideAside = !vars.hideAside' class='w-12 h-12 p-4'>
    202. 

  202. <div class='w-4 h-4 fill-current text-gray-300'>
    203. 

  203. <?xml version="1.0" encoding="UTF-8"?>
    204. 

  204. <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">
    205. 

  205. <g id="surface1">
    206. 

  206. <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 "/>
    207. 

  207. </g>
    208. 

  208. </svg>
    209. 

  209. </div>
    210. 

  210. </button>
    211. 

  211. </div>
    212. 

  212. 

  213. <div id='docMainBox' class='px-16 pb-12 pt-4 overflow-auto'>
    214. 

  214. <h1 class='mb-8'>SEO</h1>
    215. 

  215. 

  216. <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>
    217. 

  217. <h2><a name="usage" class="anchor" href="#usage" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
    218. 

  218. Usage</h2>
    219. 

  219. 

  220. <p>Initialize a <code>Collection</code> instance. The <code>Collection</code> manages all the registered models and hold global seo settings</p>
    221. 

  221. 

  222. <div class="highlight highlight-go"><pre>collection := seo.NewCollection()
    223. 

  223. 

  224. // Turn off the default inherit the upper level SEO data when the current SEO data is missing
    225. 

  225. collection.SetInherited(false)
    226. 

  226. </pre></div>
    227. 

  227. <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>
    228. 

  228. Register models to SEO</h3>
    229. 

  229. 

  230. <div class="highlight highlight-go"><pre>// Register mutiple SEO by name
    231. 

  231. collection.RegisterSEOByNames(&#34;Product&#34;, &#34;Announcement&#34;)
    232. 

  232. 

  233. // Register a SEO by model
    234. 

  234. type Product struct{
    235. 

  235. 	Name  string
    236. 

  236. 	Setting Setting
    237. 

  237. }
    238. 

  238. collection.RegisterSEO(&amp;Product{})
    239. 

  239. </pre></div>
    240. 

  240. <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>
    241. 

  241. Remove models from SEO</h3>
    242. 

  242. 

  243. <pre><code>// Remove by struct
    244. 

  244. collection.RemoveSEO(&amp;Product{})
    245. 

  245. // Remove by name
    246. 

  246. collection.RemoveSEO(&#34;Not Found&#34;)
    247. 

  247. </code></pre>
    248. 

  248. <h2><a name="configuration" class="anchor" href="#configuration" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
    249. 

  249. Configuration</h2>
    250. 

  250. <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>
    251. 

  251. Change the default global SEO name</h3>
    252. 

  252. 

  253. <div class="highlight highlight-go"><pre>collection.SetGlobalName(&#34;My Global SEO&#34;)
    254. 

  254. </pre></div>
    255. 

  255. <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>
    256. 

  256. Change the default context db key</h3>
    257. 

  257. 

  258. <div class="highlight highlight-go"><pre>collection.SetDBContextKey(&#34;My DB&#34;)
    259. 

  259. </pre></div>
    260. 

  260. <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>
    261. 

  261. Change the default SEO name</h3>
    262. 

  262. 

  263. <div class="highlight highlight-go"><pre>collection.RegisterSEO(&amp;Product{}).SetName(&#34;My Product&#34;)
    264. 

  264. </pre></div>
    265. 

  265. <h3><a name="register-customized-variables" class="anchor" href="#register-customized-variables" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
    266. 

  266. Register customized variables</h3>
    267. 

  267. 

  268. <div class="highlight highlight-go"><pre>collection.RegisterSEO(&amp;Product{}).
    269. 

  269. 	RegisterContextVariables(&#34;og:image&#34;, func(obj interface{}, _ *Setting, _ *http.Request) string {
    270. 

  270. 		// this will render &#34;og:image&#34; with the value of the object in the current request
    271. 

  271. 		return obj.image.url
    272. 

  272. 	}).
    273. 

  273. 	RegisterContextVariables(&#34;Name&#34;, func(obj interface{}, _ *Setting, _ *http.Request) string {
    274. 

  274. 		return obj.Name
    275. 

  275. 	})
    276. 

  276. </pre></div>
    277. 

  277. <h3><a name="register-setting-variable" class="anchor" href="#register-setting-variable" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
    278. 

  278. Register setting variable</h3>
    279. 

  279. 

  280. <p>This variable will be saved in the database and available as a global variable while editing SEO settings.</p>
    281. 

  281. 

  282. <div class="highlight highlight-go"><pre>collection.RegisterSEO(&amp;Product{}).RegisterSettingVaribles(struct{ProductTag string}{})
    283. 

  283. </pre></div>
    284. 

  284. <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>
    285. 

  285. Render SEO html data</h3>
    286. 

  286. 

  287. <div class="highlight highlight-go"><pre>// Render Global SEO
    288. 

  288. collection.RenderGlobal(request)
    289. 

  289. 

  290. // Render SEO by name
    291. 

  291. collection.Render(&#34;product&#34;, request)
    292. 

  292. 

  293. // Render SEO by model
    294. 

  294. collection.Render(Product{}, request)
    295. 

  295. </pre></div>
    296. 

  296. <h2><a name="customization" class="anchor" href="#customization" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
    297. 

  297. Customization</h2>
    298. 

  298. <p>You can customize your SEO settings by implementing the interface and adding functions such as l10n and publish.</p>
    299. 

  299. 

  300. <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>
    301. 

  301. <p>Suppose <code>MySEOSetting</code> implemented the above interface</p>
    302. 

  302. 

  303. <div class="highlight highlight-go"><pre>type MySEOSetting struct{
    304. 

  304. 		QorSEOSetting
    305. 

  305. 		// publish
    306. 

  306. 		// l10n
    307. 

  307. }
    308. 

  308. </pre></div>
    309. 

  309. 

  310. <p>Use <code>SetSettingModel</code> function to set it</p>
    311. 

  311. 

  312. <div class="highlight highlight-go"><pre>collection.SetSettingModel(&amp;MySEOSetting{})
    313. 

  313. </pre></div>
    314. 

  314. 

  315. <h2>Example</h2>
    316. 

  316. 

  317. <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>
    318. 

  318. <h2><a name="definition" class="anchor" href="#definition" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>Definition</h2>
    319. 

  319. 

  320. <p><code>Collection</code> manages all the registered models and hold global seo settings.</p>
    321. 

  321. 

  322. <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>
    323. 

  323. <p><code>SEO</code> provides system-level default page matadata.</p>
    324. 

  324. 

  325. <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>
    326. 

  326. <p>You can use seo setting at the model level, but you need to register the model to the system SEO</p>
    327. 

  327. 

  328. <highlightjs :language='"go"' :code='"type Product struct {\n\tName string\n\tSEO  Setting\n}\n"'></highlightjs>
    329. 

  329. 

  330. <highlightjs :language='"go"' :code='"collection.RegisterSEO(\u0026Product{})"'></highlightjs>
    331. 

  331. </div>
    332. 

  332. </div>
    333. 

  333. </div>
    334. 

  334. 

  335. <div class='font-medium text-base hidden xl:block text-gray-600 pt-4'>
    336. 

  336. <div class='sticky top-4 w-52'>On This Page<toc></toc></div>
    337. 

  337. </div>
    338. 

  338. </div>
    339. 

  339. <search-result></search-result></main>
    340. 

  340. </div>
    341. 

  341. </div>
    342. 

  342. </div>
    343. 

  343. </div>
    344. 

  344. </body>
    345. 

  345. </html>
    346.