Last active
March 22, 2023 10:23
-
-
Save thibaudcolas/a29959a20dafbd9ce9f54d8836e682c1 to your computer and use it in GitHub Desktop.
Comparing 3 implementations of Wagtail’s documentation search
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!DOCTYPE html> <html lang=en><meta charset=utf-8> | |
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"> | |
| <link rel="stylesheet" href="https://docs.wagtail.org/en/stable/_static/css/docsearch.overrides.css"> | |
| <meta name=viewport content="width=device-width, initial-scale=1.0"> | |
| <title>Welcome to Wagtail’s documentation — Wagtail Documentation 4.2.1 documentation</title> | |
| <style>:root{--blue:#007bff;--indigo:#2e1f5e;--purple:#6f42c1;--pink:#e83e8c;--red:#dc3545;--orange:#fd7e14;--yellow:#ffc107;--green:#28a745;--teal:#007d7e;--cyan:#17a2b8;--white:#fff;--gray:#6c6c6c;--gray-dark:#313131;--primary:#2e1f5e;--secondary:#6c6c6c;--success:#a456c9;--info:#007d7e;--warning:#2f128d;--danger:#a72925;--light:#f2f2f2;--dark:#313131;--breakpoint-xs:0;--breakpoint-sm:576px;--breakpoint-md:768px;--breakpoint-lg:992px;--breakpoint-xl:1200px;--font-family-sans-serif:"-apple-system","BlinkMacSystemFont","Segoe UI","system-ui","Roboto","Helvetica Neue","Arial",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";--font-family-monospace:"ui-monospace","Menlo","Monaco","Cascadia Mono","Segoe UI Mono","Roboto Mono","Oxygen Mono","Ubuntu Monospace","Source Code Pro","Fira Mono","Droid Sans Mono","Courier New",monospace,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji"}*,*::before,*::after{box-sizing:border-box}html{font-family:sans-serif;line-height:1.15;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:rgba(0,0,0,0)}header,main{display:block}body{margin:0;font-family:"-apple-system","BlinkMacSystemFont","Segoe UI","system-ui","Roboto","Helvetica Neue","Arial",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212121;text-align:left;background-color:#fff}h1,h2{margin-top:0}a{background-color:transparent}a:hover{color:#13c7a8;text-decoration:underline}a:not([href]):not([class]){color:inherit;text-decoration:none}a:not([href]):not([class]):hover{color:inherit;text-decoration:none}img{vertical-align:middle;border-style:none}input{margin:0;font-family:inherit}input{overflow:visible}[type=search]{outline-offset:-2px;-webkit-appearance:none}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}h1,h2{margin-bottom:.5em;font-weight:700;line-height:1.2}h1{font-size:2em}h2{font-size:1.75em}.container-fluid{width:100%;padding-right:20px;padding-left:20px;margin-right:auto;margin-left:auto}.row{display:flex;flex-wrap:wrap;margin-right:-20px;margin-left:-20px}.col-12,.col-6{position:relative;width:100%;padding-right:20px;padding-left:20px}.col-6{flex:0 0 50%;max-width:50%}.col-12{flex:0 0 100%;max-width:100%}@media (min-width:992px){.col-lg-9{flex:0 0 75%;max-width:75%}}.form-control{display:block;padding:.375rem .75rem;font-size:1rem;font-weight:400;line-height:1.5;color:#494949;background-color:#fff;background-clip:padding-box;border:1px solid #cecece;border-radius:.25rem;transition:border-color .15s ease-in-out,box-shadow .15s ease-in-out}@media (prefers-reduced-motion:reduce){.form-control{transition:none}}.form-control:focus{color:#494949;background-color:#fff;border-color:#5d3fbe;outline:0;box-shadow:0 0 0 .2rem rgba(46,31,94,.25)}.form-control::placeholder{color:#6c6c6c;opacity:1}.form-control:disabled,.form-control[readonly]{background-color:#e9e9e9;opacity:1}.btn{display:inline-block;font-weight:400;text-align:center;vertical-align:middle;user-select:none;border:1px solid transparent}@media (prefers-reduced-motion:reduce){.btn{transition:none}}.btn:hover{color:#212121;text-decoration:none}.btn:focus,.btn.focus{outline:0;box-shadow:0 0 0 .2rem rgba(46,31,94,.25)}.btn.disabled,.btn:disabled{opacity:.65}.btn:not(:disabled):not(.disabled){cursor:pointer}.btn-light{color:#212121;background-color:#f2f2f2;border-color:#f2f2f2}.btn-light:hover{color:#212121;background-color:#dfdfdf;border-color:#d9d9d9}.btn-light:focus,.btn-light.focus{color:#212121;background-color:#dfdfdf;border-color:#d9d9d9;box-shadow:0 0 0 .2rem rgba(211,211,211,.5)}.btn-light.disabled,.btn-light:disabled{color:#212121;background-color:#f2f2f2;border-color:#f2f2f2}.btn-light:not(:disabled):not(.disabled):active,.btn-light:not(:disabled):not(.disabled).active,.show>.btn-light.dropdown-toggle{color:#212121;background-color:#d9d9d9;border-color:#d2d2d2}.btn-light:not(:disabled):not(.disabled):active:focus,.btn-light:not(:disabled):not(.disabled).active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(211,211,211,.5)}.btn-sm{padding:.25rem .5rem;font-size:0.875rem;line-height:1.5;border-radius:.2rem}.input-group{position:relative;display:flex;align-items:stretch;width:100%}.input-group>.form-control{position:relative;flex:1 1 auto;width:1%;min-width:0;margin-bottom:0}.input-group>.form-control:focus,.input-group>.custom-select:focus,.input-group>.custom-file .custom-file-input:focus~.custom-file-label{z-index:3}.input-group>.form-control:not(:first-child),.input-group>.custom-select:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.input-group:not(.has-validation)>.form-control:not(:last-child),.input-group:not(.has-validation)>.custom-select:not(:last-child),.input-group:not(.has-validation)>.custom-file:not(:last-child) .custom-file-label::after{border-top-right-radius:0;border-bottom-right-radius:0}.input-group-prepend{display:flex}.input-group-prepend{margin-right:-1px}.input-group-text{display:flex;align-items:center;padding:.375rem .75rem;margin-bottom:0;font-size:1rem;font-weight:400;line-height:1.5;color:#494949;text-align:center;white-space:nowrap;border:1px solid #cecece;border-radius:.25rem}.input-group>.input-group-prepend>.input-group-text{border-top-right-radius:0;border-bottom-right-radius:0}.input-group>.input-group-append>.btn,.input-group>.input-group-append>.input-group-text,.input-group>.input-group-prepend:not(:first-child)>.btn,.input-group>.input-group-prepend:not(:first-child)>.input-group-text,.input-group>.input-group-prepend:first-child>.btn:not(:first-child),.input-group>.input-group-prepend:first-child>.input-group-text:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.navbar{position:relative;display:flex;align-items:center;justify-content:space-between}.navbar-brand{padding-top:.3125rem;padding-bottom:.3125rem}.navbar-brand:hover,.navbar-brand:focus{text-decoration:none}@media (min-width:992px){.navbar-expand-lg{flex-flow:row nowrap;justify-content:flex-start}}.navbar-dark .navbar-brand{color:#fff}.navbar-dark .navbar-brand:hover,.navbar-dark .navbar-brand:focus{color:#fff}@keyframes progress-bar-stripes{from{background-position:1rem 0}to{background-position:0 0}}@keyframes spinner-border{to{transform:rotate(360deg)}}@keyframes spinner-grow{0%{transform:scale(0)}50%{opacity:1;transform:none}}.bg-primary{background-color:#2e1f5e!important}.bg-white{background-color:#fff!important}.border-right-0{border-right:0!important}.border-left-0{border-left:0!important}.flex-nowrap{flex-wrap:nowrap!important}@supports (position:sticky){.sticky-top{position:sticky;top:0;z-index:1020}}.h-100{height:100%!important}.pr-2{padding-right:.5rem!important}.py-3{padding-top:1rem!important}.pr-3{padding-right:1rem!important}.py-3{padding-bottom:1rem!important}.pl-3{padding-left:1rem!important}.pt-5{padding-top:3rem!important}.font-weight-bold{font-weight:700!important}header>.container-fluid{padding:0}header .navbar{padding:.75rem 0;flex-wrap:unset}header .navbar-brand{display:flex;padding:0;text-decoration:none;margin-right:0;font-size:1.5em;line-height:1.2;white-space:unset;align-items:center;justify-content:space-between}header .logo-img{flex-shrink:0;margin-right:.75rem;position:relative;top:-1px}img{max-width:100%;height:auto}a{text-decoration:underline;text-underline-offset:3px;text-decoration-thickness:2px;text-decoration-style:solid;text-decoration-color:#3beccd}a:focus,a:hover{color:#13c7a8;text-decoration-color:currentcolor}a:active{color:#0d816d;text-decoration-color:currentcolor}*:focus{outline:3px solid #1f7e9a!important;outline-offset:1px;box-shadow:none}.skip-to-content-link{left:50%;position:absolute;transform:translateY(-100%);transition:transform .3s}.skip-to-content-link:focus{transform:translateY(0%)}</style> | |
| <link rel=search title=Search href=https://docs.wagtail.org/en/stable/search.html> | |
| <link rel=top title="Wagtail Documentation 4.2.1 documentation" href=#> | |
| <link rel=next title="Getting started" href=https://docs.wagtail.org/en/stable/getting_started/index.html> | |
| <meta name=docsearch:version content=stable> | |
| <style>@-webkit-keyframes sbx-reset-in{0%{-webkit-transform:translate3d(-20%,0,0);transform:translate3d(-20%,0,0);opacity:0}to{-webkit-transform:none;transform:none;opacity:1}}@keyframes sbx-reset-in{0%{-webkit-transform:translate3d(-20%,0,0);transform:translate3d(-20%,0,0);opacity:0}to{-webkit-transform:none;transform:none;opacity:1}}@keyframes bounce{0%,100%{transform:translateY(0)}50%{transform:translateY(-5px)}}</style> | |
| <link rel="shortcut icon" href="data:image/vnd.microsoft.icon;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABmJLR0QAAAAAAAD5Q7t/AAAACXBIWXMAAAsTAAALEwEAmpwYAAAACXZwQWcAAAAwAAAAMADO7oxXAAAIYklEQVRo3u2ZWWxU1xnHf+fcxTPexmBsJcRsZYkqQkG0eWgNFARhadWgVDwgtVGUt6QvzfKURFFDpSoJQe0DSlPSiiKxtGqVqhAVmhB4iGixsWpIYsckxoQaDMXGG55hbN97zunDnXs9hpnx2AlLpX7SaEYz957z/3/f/1vOHbH24F8N/8Mm7zaA/xO42wC+rNm3Y1FjcqeVEOLeJBAB1poQuggQhxcEP4ffSzlGyJix6+4UAWMMQogAuNYBGMvCKitD2DYYg9E6Ao4QCClBCIzWqOE0xvMRloXJrDPV6EyOgDGYjOdMBrhdXo6QEm9oiJ6GRgbOtjFy7RreUBKjVIDftnHKynCrqqiY/zWqly/HnT6ddCqFG643RRJFE4g2MAatFE5ZGQA9DQ3858MPGWhpJX316pjXC5hbVcW0xYvZ9PzznLctpFLYUqKnQEIU08giyWgNQuCUl9P38cdc+NOf6WloyFpNRACyc0EIEek8lJYxhqbGRrpnz+b1f/4DKeWUSEwYgWzwwrIQUtKxbx8d+/ZjfD8CbYyJgAFIKRGAykrs0KSUGGPwjOF7992H/c1v8YvTzWPynASJggTGgbdtjFKceWUbvc3NQSWRMqg8WbKRmQqjwxyxbRJVVcTicZTvk0omSSaTwbWZe9bPmYOH4edNTSRcF/1VRCAbvHRd1PAw/3rhBa5/3h5Uj0yC5vKsMYZv19fz3HPPsXTJEmpqa3FcF6M1qVSKK1eu0NDQQG1tLQC+Unx/zlza+vt5p6ODCtdFaV1UFArmQOh5PTrK6Z+9wkBLC0LKqAJlm2VZKKVYuHAhv37rLdatXRtFJh+Q7HIshGBodJQnjh+jd3gYV8qxvlHAZL6FIy07Dp/t2hWAt6yc4KWUKKX4Tn09x44fZ93atSilUEphjEFnZBZ+Vkrh+z5KKTzPC74zhgrX5ceLFuGHvaUICd1CIPKKUriJBBcPHuTy+0fzykYIgdaauXPncuDAAWbV1eF5XlBVbBshRJDQmWQXQmBZVvRyHCf4PeOwjbNmM6u8nFGtp0Yg1L0VK2Hoiy84/4c/RnLKFy2Avfv2MWf2bDzPw3Gccevlc1JDQwM7duygubkZKSW+UpQ6Dt+ormZY+WPVrYDZuRbGGKRbQvvu3YwODETVJpd0tNb84NFHWVFfj+/7OI5TsAwaY5BS0tHRwfr160kmk1RXV9PY2Mj8+fMBWFJdzaELF/I6IG8EIu/H4wy0fkr3yUyTyuP9sFS+/PLLY/dPUMNDj7a1tZFMJiktLaW3t5cTJ05Eey2ZNp0qx4lyoSgC2YkLcG7PngB4HjAhyAULFrBs6dIoIhNumLlm9erVLF26lBs3brBixQq2bt0a4agtKyNRUYHv+4iQdB4pRRIKE9cuL6PvzEf0nTkTMstNQEqMUsyaMwfHcdBKITLJWsjCKJWXl3P06FHa29tZtGgRJSUlUf4c3L+fs60tzNywgdHe3mDChZzRtbPDKiwLlR6m/fd7wt3yE8i819bUBJE3BmtC/4+v/TNmzKCmpgatdZQ/LZ9+yk+ffZae/n4EgvsfWcdIf38wxuSQqIy8ojV2WRk9p04x2NYGUhQ1WU52AM4GYYyJeoVt2wwODvLDxx6jp6cHqTUfv/EGXX9/DzeRiEaWmyuTDLUvbZuRvj469u7LuKo4QNf6+iJgkyERvkspo2r2o8cfp/3zz7EsC20MRik+2b6dS4cP4+QhYQsh0L6PW1nJpcNHSHV25h0XbpYCwNUrVwJPZEDcXLdDkLkIQFDJLMvixZde4m/vvott2/i+n30xrb/8FX46zdwtW/CGhsbJSBpjsFyXVFcX//7LO+PAFUOg8+JFuru7x3VZ27axbTvqtiHQUC7h/UopLMti19tv89qrr2JZ1njwwYUgBJ+99RvO7z+AdN1xY7ttlMKurOTc3r0Md/fkbVq5CAghGBwY4PRHH7HhkUdobW2lu7ubVCqFMQbLspgxYwaLFy+moqIi2tT3fazM2QLg0sz7+fr215kWL0XpW8eV8CyNNuiRkUAhIQErFmPowgW63ns/jGnRWg4X+cnTT5OorKSlpQXP8265bt68eSxfvpw1a9awefNm6urq0FpHleuhhx7iA6DScVD5op+RjB4ZGSchseHYB+aT117n8tGjRXu/kN2s95sbZCKRYNu2bTz11FPYjoMlJccvXeTFkyepcF30RPLNOgEKIZCDZ89yNauNT8WyE1VrPe4VbhTmw/Xr13nmmWdYuXIl3d3dANTE4pQ4Dibz+KXgK6uCAci2N99EpdNf6uFSOOcX+j08H0BwzGxqaqK+vp7LFy/yQCJBSeZAP+mID7adDXeZMoHJkvV9H9u2+eL8eZ548klKlKKuvBxPqUk3Rgt45Y4gv8m01jiOw7lz56iKx1n03VWc7Oyk1HWL7aHAXX46Hdb83b/9Hamuy8RiMUyOZljI7loEQhOWxbX+flICKh9+GC+dLmosD+22R0BOMGKHI8tnp5pQIyNFHSPvKAFdpCSS167h3bgRded7hsCqVauYN28ekGdizZDzUsloTLgnCIRgd+7cyZYtWwCiwS6X6VEPNTISTAP3koRc12VgYAAoPOVqz0ONjE768fptIxCCjcfjXMmcGYq4a9L73BYCoRcrKiqIxWJ0dXWNI/VV2m2VUF1dHQCdnZ0TE8j6E+SuEwgb0YMPPkh/fz+9vb0TEpCOgx2LR/8C3VUCoa1Zs4ZDhw4BBSpQBqwVi2HFSiYts9tCQCmFEIJNmzZx5MgRYGL9u5WVWPF4zifgd5RAKJ9ly5YhpaSxsREg/3khE4FYbQ1WScmkx/qvnEBYgTZu3EhzczPpdLpgAwvVXjrzgeB/OGMQkzgV/BcB03HyYgRdBQAAAFl6VFh0U29mdHdhcmUAAHja88xNTE/1TUzPTM5WMNMz0rNQMDDVNzDXNzRSCDQ0U0jLzEm10i8tLtIvzkgsStX3RCjXNdMz0rPQT8lP1s/MS0mt0Msoyc0BAK1OGKx0FS5rAAAAIXpUWHRUaHVtYjo6RG9jdW1lbnQ6OlBhZ2VzAAB42jMEAAAyADIMEuKEAAAAIXpUWHRUaHVtYjo6SW1hZ2U6OmhlaWdodAAAeNozMjAAAAEpAJPr0zSRAAAAIHpUWHRUaHVtYjo6SW1hZ2U6OldpZHRoAAB42jMyMAAAASkAk2fGMsQAAAAielRYdFRodW1iOjpNaW1ldHlwZQAAeNrLzE1MT9UvyEsHABF7A3hfOUfiAAAAIHpUWHRUaHVtYjo6TVRpbWUAAHjaMzS2NDQ3NDI0sQQACxkCB4HPyIsAAAAaelRYdFRodW1iOjpTaXplAAB42jPWM8tOAgADlgFlvDEMWQAAABx6VFh0VGh1bWI6OlVSSQAAeNpLy8xJtdLX1wcADJoCaJRAUaoAAAAASUVORK5CYII="><style>.sf-hidden{display:none!important}</style><link rel=canonical href=https://docs.wagtail.org/en/stable/index.html><style>img[src="data:,"],source[src="data:,"]{display:none!important}</style></head> | |
| <body> | |
| <header class="container-fluid bg-primary"> | |
| <a class="btn btn-sm btn-light skip-to-content-link" href=#main>Skip to content</a> | |
| <div class=container-fluid> | |
| <div class="navbar navbar-expand-lg navbar-dark font-weight-bold"> | |
| <a href=# title=Wagtail class="logo navbar-brand"> | |
| Wagtail Documentation | |
| </a> | |
| <button class="navbar-toggler btn btn-primary d-lg-none sf-hidden" type=button data-toggle=collapse data-target=#collapseSidebar aria-expanded=false aria-controls=collapseExample> | |
| </button> | |
| </div> | |
| </div> | |
| </header> | |
| <main style="padding: 1rem"> | |
| <h1>Search trial</h1> | |
| <h2>Trial form</h2> | |
| <aside data-term="404" style="display: grid; grid-template-columns: 1fr 1fr 1fr; padding: 1rem; gap: 5px"> | |
| <div><h3>Algolia as-is</h3><input class="form-control" type=search data-search="1"></div> | |
| <div><h3>Algolia code blocks</h3><input class="form-control" type=search data-search="2"></div> | |
| <div><h3><a href="https://readthedocs.org/search/?q=project%3Awagtail&type=file" data-rtd-search>Read the Docs</a></h3></div> | |
| </aside> | |
| <template id="section-template"> | |
| <section data-term="TEMPLATE" style="display: grid; grid-template-columns: 1fr 1fr 1fr; padding: 1rem; gap: 5px;"> | |
| <div><h3>Algolia as-is</h3><input class="form-control" type=search data-search="1"></div> | |
| <div><h3>Algolia code blocks</h3><input class="form-control" type=search data-search="2"></div> | |
| <div><h3><a href="https://readthedocs.org/search/?q=project%3Awagtail&type=file" data-rtd-search>Read the Docs</a></h3><ul></ul></div> | |
| </section> | |
| </template> | |
| </main> | |
| <script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> | |
| <script> | |
| docsearch({ | |
| appId: 'XSYGEO7KMJ', | |
| apiKey: 'd50a485660ed9280079aada4e09454b2', | |
| indexName: 'wagtail', | |
| inputSelector: '[data-search="1"]', | |
| algoliaOptions: { | |
| facetFilters: ['version:stable'], | |
| }, | |
| autocompleteOptions: { | |
| autoSelect: false | |
| }, | |
| debug: true, | |
| }) | |
| </script> | |
| <script> | |
| docsearch({ | |
| appId: 'XSYGEO7KMJ', | |
| apiKey: '9779c718cfb08178df32d1ca8380ad73', | |
| indexName: 'crawler_wagtail-code', | |
| inputSelector: '[data-search="2"]', | |
| algoliaOptions: { | |
| facetFilters: ['version:stable'], | |
| }, | |
| autocompleteOptions: { | |
| autoSelect: false | |
| }, | |
| debug: true, | |
| }) | |
| </script> | |
| <script> | |
| const terms = [ | |
| '404', | |
| 'admin', | |
| 'api', | |
| 'author', | |
| 'blocks', | |
| 'chooserviewset', | |
| 'chosefield', | |
| 'crispy', | |
| 'database', | |
| 'documentchooserblock', | |
| 'embed', | |
| 'embedblock', | |
| 'emoji', | |
| 'fieldpanel', | |
| 'groupmenuitem', | |
| 'hooks', | |
| 'image', | |
| 'language', | |
| 'listblockfactory', | |
| 'menu', | |
| 'modeladmin', | |
| 'page', | |
| 'parentalkey', | |
| 'richtext', | |
| 'richtextfield', | |
| 'robots', | |
| 'search', | |
| 'streamfield', | |
| 'structblock', | |
| 'tabularinline', | |
| 'use_json_field', | |
| 'video', | |
| 'wagtail.core.apps', | |
| 'wagtailadmin_base_url', | |
| 'pageurl', | |
| 'ChoiceBlock', | |
| 'ImageChooserBlock', | |
| 'modeladmin_register', | |
| 'TabbedInterface', | |
| 'ClusterableModel', | |
| 'RoutablePageMixin', | |
| 'postgres', | |
| 'get_children', | |
| 'icons', | |
| 'image_url', | |
| 'base_form_class', | |
| ]; | |
| /** | |
| * To keep this up-to-date: | |
| * copy($$('.module-list-wrapper li:nth-child(1), .module-list-wrapper li:nth-child(2), .module-list-wrapper li:nth-child(3), .module-list-wrapper li:nth-child(4), .module-list-wrapper li:nth-child(5)').map(e => e.outerHTML.replace(/\s+/g, ' ')).join('')) | |
| */ | |
| const rtdResults = { | |
| '404': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/admin_templates.html?highlight=404"> wagtail - Customising admin templates </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/admin_templates.html?highlight=404#branding-logo"> branding_logo </a> </p> <p class="fragment"> ... template file dashboard/templates/wagtailadmin/login.html that overwrites the branding_logo block. <span>404</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/project_template.html?highlight=404"> wagtail - The project template </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/project_template.html?highlight=404#the-project-template"> The project template </a> </p> <p class="fragment"> ... settings/ __init__.py base.py dev.py production.py static/ css/ mysite.css js/ mysite.js templates/ <span>404</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/project_template.html?highlight=404#default-templates-and-static-files"> Default templates and static files </a> </p> <p class="fragment"> ... Location: /mysite/mysite/templates/ and /mysite/mysite/static/ The templates directory contains base.html, <span>404</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.15.4.html?highlight=404"> wagtail - Wagtail 2.15.4 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.15.4.html?highlight=404#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... invalid bulk action URLs would incorrectly trigger a server error (500) instead of a valid not found (<span>404</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/api/v2/usage.html?highlight=404"> wagtail - Wagtail API v2 Usage Guide </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/api/v2/usage.html?highlight=404#finding-pages-by-html-path"> Finding pages by HTML path </a> </p> <p class="fragment"> ... This will return either a 302 redirect response to that page’s detail view, or a <span>404</span> not found response ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.14.html?highlight=404"> wagtail - Wagtail 2.14 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.14.html?highlight=404#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... the page explorer API (Andre Fonseca) Deleting a page from its listing view no longer results in a <span>404</span> ... </p> <p></p> </li>`, | |
| 'admin': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=admin"> wagtail - Using forms in <span>admin</span> views </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=admin#using-forms-in-admin-views"> Using forms in <span>admin</span> views </a> </p> <p class="fragment"> ... Django’s forms framework can be used within Wagtail <span>admin</span> views just like in any other Django app. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=admin#defining-admin-form-widgets"> Defining <span>admin</span> form widgets </a> </p> <p class="fragment"> ... ModelAdmin use WagtailAdminModelForm as standard, so this change will take effect across the Wagtail <span>admin</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/0.5.html?highlight=admin"> wagtail - Wagtail 0.5 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/0.5.html?highlight=admin#admin"> <span>Admin</span> </a> </p> <p class="fragment"> ... This improves the general performance of the <span>admin</span> interface for large sites. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/0.5.html?highlight=admin#urlconf-entries-for-admin-images-admin-embeds-etc-need-to-be-removed"> Urlconf entries for /<span>admin</span>/images/, /<span>admin</span>/embeds/ etc need to be removed </a> </p> <p class="fragment"> ... <span>admin</span>/documents/', include(wagtaildocs_admin_urls)), url(r'^<span>admin</span>/snippets/', include(wagtailsnippets_urls ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.12.html?highlight=admin"> wagtail - Wagtail 2.12 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.12.html?highlight=admin#admin-colour-themes"> <span>Admin</span> colour themes </a> </p> <p class="fragment"> ... Wagtail’s <span>admin</span> now uses CSS custom properties for its primary teal colour. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/admin_views.html?highlight=admin"> wagtail - Creating <span>admin</span> views </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/admin_views.html?highlight=admin#creating-admin-views"> Creating <span>admin</span> views </a> </p> <p class="fragment"> ... them as part of the Wagtail <span>admin</span> through hooks. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/admin_views.html?highlight=admin#registering-a-url-route"> Registering a URL route </a> </p> <p class="fragment"> ... This is done through the Register <span>Admin</span> URLs hook. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/admin_views.html?highlight=admin#adding-a-menu-item"> Adding a menu item </a> </p> <p class="fragment"> ... To add an item to the sidebar menu, we’ll use another hook, Register <span>Admin</span> Menu Item. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/admin_templates.html?highlight=admin"> wagtail - Customising <span>admin</span> templates </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/admin_templates.html?highlight=admin#customising-admin-templates"> Customising <span>admin</span> templates </a> </p> <p class="fragment"> ... In your projects with Wagtail, you may wish to replace elements such as the Wagtail logo within the <span>admin</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/admin_templates.html?highlight=admin#specifying-a-site-or-page-in-the-branding"> Specifying a site or page in the branding </a> </p> <p class="fragment"> ... the branding in the <span>admin</span> page. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/admin_templates.html?highlight=admin#extending-client-side-components"> Extending client-side components </a> </p> <p class="fragment"> ... Some of Wagtail’s <span>admin</span> interface is written as client-side JavaScript with React. ... </p> <p></p> </li>`, | |
| 'api': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/api/index.html?highlight=api"> wagtail - Wagtail <span>API</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/api/index.html?highlight=api#wagtail-api"> Wagtail <span>API</span> </a> </p> <p class="fragment"> ... The <span>API</span> module provides a public-facing, JSON-formatted <span>API</span> to allow retrieving content as raw field ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/panel_api.html?highlight=api"> wagtail - Panel <span>API</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/panel_api.html?highlight=api#module-wagtail.admin.panels"> Panel <span>API</span> </a> </p> <p class="fragment"> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/api/v2/configuration.html?highlight=api"> wagtail - Wagtail <span>API</span> v2 Configuration Guide </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/api/v2/configuration.html?highlight=api#images-in-the-api"> Images in the <span>API</span> </a> </p> <p class="fragment"> ... The ImageRenditionField serializer allows you to add renditions of images into your <span>API</span>. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/api/v2/configuration.html?highlight=api#wagtail-api-v2-configuration-guide"> Wagtail <span>API</span> v2 Configuration Guide </a> </p> <p class="fragment"> ... This section of the docs will show you how to set up a public <span>API</span> for your Wagtail site. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/api/v2/configuration.html?highlight=api#adding-form-fields-to-the-api"> Adding form fields to the <span>API</span> </a> </p> <p class="fragment"> ... FormBuilder page called FormPage this is an example of how you would expose the form fields to the <span>API</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/index.html?highlight=api"> wagtail - StreamField reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/index.html?highlight=api#id3"> Form widget client-side <span>API</span> </a> </p> <p class="fragment"> ... Defines the JavaScript <span>API</span> that must be implemented for any form widget used within a StreamField block ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/widget_api.html?highlight=api"> wagtail - Form widget client-side <span>API</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/widget_api.html?highlight=api#form-widget-client-side-api"> Form widget client-side <span>API</span> </a> </p> <p class="fragment"> In order for the StreamField editing interface to dynamically create form fields, any Django form wi ... </p> <p></p> </li>`, | |
| 'author': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=author"> wagtail - Embedded content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=author#wagtail.embeds.models.Embed.author_name"> [py:attribute]: wagtail.embeds.models.Embed.<span>author</span>_name </a> </p> <p class="fragment"> (text) The <span>author</span> name of the content that is being embedded. </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=author#custom-embed-finder-classes"> Custom embed finder classes </a> </p> <p class="fragment"> ... external APIs. """ # TODO: Perform the request return { 'title': "Title of the content", 'author_name': "<span>Author</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=author"> wagtail - ModelAdmin </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=author#a-more-complicated-example"> A more complicated example </a> </p> <p class="fragment"> ... ') list_filter = ('genre', '<span>author</span>') search_fields = ('title', '<span>author</span>') class AuthorAdmin(ModelAdmin ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=author#a-simple-example"> A simple example </a> </p> <p class="fragment"> ... ') list_filter = ('<span>author</span>',) search_fields = ('title', '<span>author</span>') # Now you just need to register your ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/search/indexing.html?highlight=author"> wagtail - Indexing </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/search/indexing.html?highlight=author#indexing-custom-models"> Indexing custom models </a> </p> <p class="fragment"> ... = models.CharField(max_length=255) genre = models.CharField(max_length=255, choices=GENRE_CHOICES) <span>author</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/search/indexing.html?highlight=author#index-relatedfields"> index.RelatedFields </a> </p> <p class="fragment"> ... For example, if we have a book that has a ForeignKey to its <span>author</span>, we can nest the author’s name and ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.3.html?highlight=author"> wagtail - Wagtail 1.3 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.3.html?highlight=author#indexing-fields-across-relations-in-elasticsearch"> Indexing fields across relations in Elasticsearch </a> </p> <p class="fragment"> ... , [ index.SearchField('name'), index.FilterField('date_of_birth'), ]), ] # Search books where their <span>author</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=author"> wagtail - Reversing ModelAdmin URLs </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=author#getting-the-edit-or-delete-or-inspect-url-for-an-object"> Getting the edit or delete or inspect URL for an object </a> </p> <p class="fragment"> ... The BlogPage model has an <span>author</span> field (a ForeignKey to the <span>Author</span> model) to allow a single <span>author</span> to ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=author#getting-the-index-or-create-url-for-a-model"> Getting the index or create URL for a model </a> </p> <p class="fragment"> ... url_helper.index_url # note: do not call this property as a function # both will output /admin/my-app/<span>author</span> ... </p> <p></p> </li>`, | |
| 'blocks': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=blocks"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=blocks#wagtail.blocks.ListBlock"> [py:class]: wagtail.<span>blocks</span>.ListBlock </a> </p> <p class="fragment"> When true, all sub-<span>blocks</span> are initially collapsed. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=blocks#wagtail.blocks.ListBlock"> [py:class]: wagtail.<span>blocks</span>.list_block.ListBlock </a> </p> <p class="fragment"> When true, all sub-<span>blocks</span> are initially collapsed. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=blocks#wagtail.blocks.StreamBlock"> [py:class]: wagtail.<span>blocks</span>.StreamBlock </a> </p> <p class="fragment"> Bases: BaseStreamBlock A block consisting of a sequence of sub-<span>blocks</span> of different types, which can be </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=blocks#structural-block-types"> Structural block types </a> </p> <p class="fragment"> ... that the stream must have. param max_num Maximum number of sub-<span>blocks</span> that the stream may have. param ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=blocks#block-options"> Block options </a> </p> <p class="fragment"> ... Any <span>blocks</span> with the same group name will be shown together in the editor interface with the group name ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/contributing/documentation_guidelines.html?highlight=blocks"> wagtail - Documentation guidelines </a> </p><p> <a href="https://docs.wagtail.org/en/stable/contributing/documentation_guidelines.html?highlight=blocks#code-blocks"> Code <span>blocks</span> </a> </p> <p class="fragment"> Make sure to include the correct language code for syntax highlighting, and to format your code acco ... </p> <p> <a href="https://docs.wagtail.org/en/stable/contributing/documentation_guidelines.html?highlight=blocks#when-using-console-terminal-code-blocks"> When using console (terminal) code <span>blocks</span> </a> </p> <p class="fragment"> Note $ or > prompts are not needed, this makes it harder to copy and paste the lines and can be diff ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=blocks"> wagtail - How to build custom StreamField <span>blocks</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=blocks#how-to-build-custom-streamfield-blocks"> How to build custom StreamField <span>blocks</span> </a> </p> <p class="fragment"> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=blocks#custom-block-types"> Custom block types </a> </p> <p class="fragment"> ... __init__(**kwargs) Since the StreamField editing interface needs to create <span>blocks</span> dynamically, certain ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=blocks#handling-block-definitions-within-migrations"> Handling block definitions within migrations </a> </p> <p class="fragment"> ... StructBlock, StreamBlock and ChoiceBlock implement additional logic to ensure that any subclasses of these <span>blocks</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.11.8.html?highlight=blocks"> wagtail - Wagtail 2.11.8 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.11.8.html?highlight=blocks#cve-2021-32681-improper-escaping-of-html-cross-site-scripting-in-wagtail-streamfield-blocks"> CVE-2021-32681: Improper escaping of HTML (‘Cross-site Scripting’) in Wagtail StreamField <span>blocks</span> </a> </p> <p class="fragment"> ... implementors who wish to retain the existing behaviour of allowing editors to insert HTML content in these <span>blocks</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.12.5.html?highlight=blocks"> wagtail - Wagtail 2.12.5 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.12.5.html?highlight=blocks#cve-2021-32681-improper-escaping-of-html-cross-site-scripting-in-wagtail-streamfield-blocks"> CVE-2021-32681: Improper escaping of HTML (‘Cross-site Scripting’) in Wagtail StreamField <span>blocks</span> </a> </p> <p class="fragment"> ... implementors who wish to retain the existing behaviour of allowing editors to insert HTML content in these <span>blocks</span> ... </p> <p></p> </li>`, | |
| 'chooserviewset': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/viewsets.html?highlight=chooserviewset"> wagtail - Viewsets </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/viewsets.html?highlight=chooserviewset#chooserviewset"> <span>ChooserViewSet</span> </a> </p> <p class="fragment"> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/viewsets.html?highlight=chooserviewset#wagtail.admin.viewsets.chooser.ChooserViewSet"> [py:class]: wagtail.admin.viewsets.chooser.<span>ChooserViewSet</span> </a> </p> <p class="fragment"> A viewset that creates a chooser modal interface for choosing model instances. Required; the model c ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/viewsets.html?highlight=chooserviewset#wagtail.admin.viewsets.chooser.ChooserViewSet.icon"> [py:attribute]: wagtail.admin.viewsets.chooser.<span>ChooserViewSet</span>.icon </a> </p> <p class="fragment"> The icon to use in the header of the chooser modal, and on the chooser widget ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/viewsets.html?highlight=chooserviewset#wagtail.admin.viewsets.chooser.ChooserViewSet.model"> [py:attribute]: wagtail.admin.viewsets.chooser.<span>ChooserViewSet</span>.model </a> </p> <p class="fragment"> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/generic_views.html?highlight=chooserviewset"> wagtail - Generic views </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/generic_views.html?highlight=chooserviewset#chooserviewset"> <span>ChooserViewSet</span> </a> </p> <p class="fragment"> ... class PersonChooserViewSet(<span>ChooserViewSet</span>): # The model can be specified as either the model class or ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/generic_views.html?highlight=chooserviewset#chooser-viewsets-for-non-model-datasources"> Chooser viewsets for non-model datasources </a> </p> <p class="fragment"> ... ChosenResponseMixin, ChosenViewMixin, CreationFormMixin ) from wagtail.admin.viewsets.chooser import <span>ChooserViewSet</span> ... </p> <p></p> </li>`, | |
| 'chosefield': `No results`, | |
| 'crispy': `No results`, | |
| 'database': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=database"> wagtail - Model Reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=database#database-fields"> <span>Database</span> fields </a> </p> <p class="fragment"> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=database#id1"> <span>Database</span> fields </a> </p> <p class="fragment"> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=database#id4"> <span>Database</span> fields </a> </p> <p class="fragment"> The locale and translation_key fields have a unique key constraint to prevent the object being trans ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=database#wagtail.models.Page.specific_class"> [py:attribute]: wagtail.models.Page.specific_class </a> </p> <p class="fragment"> (usually a result of switching between git branches without running or reverting <span>database</span> migrations </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=database#wagtail.models.Page.specific"> [py:attribute]: wagtail.models.Page.specific </a> </p> <p class="fragment"> Returns this page in its most specific subclassed form with all field values fetched from the <span>database</span> </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=database#wagtail.models.Page.cached_content_type"> [py:attribute]: wagtail.models.Page.cached_content_type </a> </p> <p class="fragment"> Return this page’s content_type value from the ContentType model’s cached manager, which will avoid a <span>database</span> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/contributing/developing.html?highlight=database"> wagtail - Development </a> </p><p> <a href="https://docs.wagtail.org/en/stable/contributing/developing.html?highlight=database#testing-against-a-different-database"> Testing against a different <span>database</span> </a> </p> <p class="fragment"> ... as described in Django’s Databases documentation or the 3rd-party <span>database</span> backend’s documentation. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.15.html?highlight=database"> wagtail - Wagtail 2.15 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.15.html?highlight=database#new-database-search-backend"> New <span>database</span> search backend </a> </p> <p class="fragment"> ... Wagtail has a new search backend that uses the full-text search features of the <span>database</span> in use. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/2.15.html?highlight=database#database-search-backends-replaced"> <span>Database</span> search backends replaced </a> </p> <p class="fragment"> ... english', } } However, as a PostgreSQL specific feature, this will be ignored when using a different <span>database</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=database"> wagtail - Performance </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=database#database"> <span>Database</span> </a> </p> <p class="fragment"> ... It may work on some third-party <span>database</span> backends as well, but this is not guaranteed. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=database#search"> Search </a> </p> <p class="fragment"> ... for Elasticsearch - both in the editor interface and for users of your site - but can fall back to a <span>database</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=database#page-urls"> Page URLs </a> </p> <p class="fragment"> ... content, providing request or current_site can result in a drastic reduction in the number of cache or <span>database</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/search/backends.html?highlight=database"> wagtail - Backends </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/search/backends.html?highlight=database#database-backend-default"> <span>Database</span> Backend (default) </a> </p> <p class="fragment"> ... wagtail.search.backends.database The <span>database</span> search backend searches content in the <span>database</span> using the ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/search/backends.html?highlight=database#backends"> Backends </a> </p> <p class="fragment"> ... Wagtailsearch has support for multiple backends, giving you the choice between using the <span>database</span> for ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/search/backends.html?highlight=database#auto-update"> AUTO_UPDATE </a> </p> <p class="fragment"> ... auto-update, you must run the update_index command on a regular basis to keep the index in sync with the <span>database</span> ... </p> <p></p> </li>`, | |
| 'documentchooserblock': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=documentchooserblock"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=documentchooserblock#wagtail.documents.blocks.DocumentChooserBlock"> [py:class]: wagtail.documents.blocks.<span>DocumentChooserBlock</span> </a> </p> <p class="fragment"> Bases: BaseDocumentChooserBlock A control to allow the editor to select an existing document object, ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/4.0.html?highlight=documentchooserblock"> wagtail - Wagtail 4.0 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/4.0.html?highlight=documentchooserblock#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... Kumar Sen) Ensure that BaseSiteSetting / BaseGenericSetting objects can be pickled (Andy Babic) Ensure <span>DocumentChooserBlock</span> ... </p> <p></p> </li>`, | |
| 'embed': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embed"> wagtail - Embedded content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embed#embed-tag"> {% <span>embed</span> %} tag </a> </p> <p class="fragment"> ... %} {# <span>Embed</span> a YouTube video #} {% <span>embed</span> 'https://www.youtube.com/watch? ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embed#configuring-embed-finders"> Configuring <span>embed</span> “finders” </a> </p> <p class="fragment"> ... <span>Embed</span> finders are the modules within Wagtail that are responsible for producing <span>embed</span> code from a URL ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embed#custom-embed-finder-classes"> Custom <span>embed</span> finder classes </a> </p> <p class="fragment"> ... self, **options): pass def accept(self, url): """ Returns True if this finder knows how to fetch an <span>embed</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embed#wagtail.embeds.models.Embed"> [py:class]: wagtail.embeds.models.<span>Embed</span> </a> </p> <p class="fragment"> do not hit the <span>embed</span> finders again. </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embed#wagtail.embeds.models.Embed.url"> [py:attribute]: wagtail.embeds.models.<span>Embed</span>.url </a> </p> <p class="fragment"> (text) The URL of the original content of this <span>embed</span>. </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embed#wagtail.embeds.models.Embed.height"> [py:attribute]: wagtail.embeds.models.<span>Embed</span>.height </a> </p> <p class="fragment"> (integer, nullable) The height of the <span>embed</span> (images and videos only). </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.11.2.html?highlight=embed"> wagtail - Wagtail 2.11.2 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.11.2.html?highlight=embed#facebook-and-instagram-embed-finders"> Facebook and Instagram <span>embed</span> finders </a> </p> <p class="fragment"> ... Two new <span>embed</span> finders have been added for Facebook and Instagram, to replace the previous configuration ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.7.html?highlight=embed"> wagtail - Wagtail 1.7 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.7.html?highlight=embed#embed-template-filter-is-now-a-template-tag"> <span>embed</span> template filter is now a template tag </a> </p> <p class="fragment"> ... as: {% load wagtailembeds_tags %} ... {% <span>embed</span> my_media_url %} ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/1.7.html?highlight=embed#minor-features"> Minor features </a> </p> <p class="fragment"> ... The |<span>embed</span> filter has been converted into a templatetag {% <span>embed</span> %} (Janneke Janssen) The wagtailforms ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=embed"> wagtail - Rich text internals </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=embed#FeatureRegistry.register_embed_type"> [py:method]: FeatureRegistry.register_<span>embed</span>_type </a> </p> <p class="fragment"> </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=embed#data-format"> Data format </a> </p> <p class="fragment"> ... "> and <<span>embed</span> embedtype="..." /> are left unchanged in the converted HTML. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=embed#registering-rewrite-handlers"> Registering rewrite handlers </a> </p> <p class="fragment"> ... Independent methods for registering both link handlers and <span>embed</span> handlers are provided. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=embed#rewrite-handlers"> Rewrite handlers </a> </p> <p class="fragment"> ... "> and <<span>embed</span> embedtype="..." /> into front-end HTML. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=embed#LinkHandler.expand_db_attributes"> [py:method]: LinkHandler.expand_db_attributes </a> </p> <p class="fragment"> expand_db_attributes method is expected to take a dictionary of attributes from a database rich text <a> tag (<<span>embed</span> </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=embed#LinkHandler.get_instance"> [py:method]: LinkHandler.get_instance </a> </p> <p class="fragment"> This method is expected to take a dictionary of attributes from a database rich text <a> tag (<<span>embed</span>> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.12.html?highlight=embed"> wagtail - Wagtail 1.12 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.12.html?highlight=embed#improved-embed-configuration"> Improved <span>embed</span> configuration </a> </p> <p class="fragment"> New configuration options for embedded media have been added, to give greater control over how media ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/1.12.html?highlight=embed#old-configuration-settings-for-embeds-are-deprecated"> Old configuration settings for embeds are deprecated </a> </p> <p class="fragment"> ... Please see Configuring <span>embed</span> “finders” for the new configuration to use. ... </p> <p></p> </li>`, | |
| 'embedblock': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embedblock"> wagtail - Embedded content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=embedblock#embedblock-streamfield-block-type"> <span>EmbedBlock</span> StreamField block type </a> </p> <p class="fragment"> ... . embed = <span>EmbedBlock</span>(max_width=800, max_height=400) ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=embedblock"> wagtail - How to use StreamField for mixed content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=embedblock#streamblock"> StreamBlock </a> </p> <p class="fragment"> ... follows: body = StreamField([ ('carousel', blocks.StreamBlock([ ('image', ImageChooserBlock()), ('video', <span>EmbedBlock</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.3.html?highlight=embedblock"> wagtail - Wagtail 2.3 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.3.html?highlight=embedblock#other-features"> Other features </a> </p> <p class="fragment"> ... (Oliver Wilkerson) Added meta tag to prevent search engines from indexing admin pages (Karl Hobley) <span>EmbedBlock</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=embedblock"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=embedblock#wagtail.embeds.blocks.EmbedBlock"> [py:class]: wagtail.embeds.blocks.<span>EmbedBlock</span> </a> </p> <p class="fragment"> Bases: URLBlock A field for the editor to enter a URL to a media item (such as a YouTube video) to a ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=embedblock#wagtail.blocks.StreamBlock"> [py:class]: wagtail.blocks.StreamBlock </a> </p> <p class="fragment"> , blocks.StructBlock([ ('text', blocks.TextBlock()), ('author', blocks.CharBlock()), ])), ('video', <span>EmbedBlock</span> </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=embedblock#wagtail.blocks.StreamBlock"> [py:class]: wagtail.blocks.stream_block.StreamBlock </a> </p> <p class="fragment"> , blocks.StructBlock([ ('text', blocks.TextBlock()), ('author', blocks.CharBlock()), ])), ('video', <span>EmbedBlock</span> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.14.html?highlight=embedblock"> wagtail - Wagtail 2.14 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.14.html?highlight=embedblock#new-features"> New features </a> </p> <p class="fragment"> ... disabling moderation workflows globally (Matt Westcott) Allow specifying max_width and max_height on <span>EmbedBlock</span> ... </p> <p></p> </li>`, | |
| 'emoji': `No results`, | |
| 'fieldpanel': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/permissions.html?highlight=fieldpanel"> wagtail - Permissions </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/permissions.html?highlight=fieldpanel#fieldpanel-permissions"> <span>FieldPanel</span> permissions </a> </p> <p class="fragment"> ... See permission on <span>FieldPanel</span>. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=fieldpanel"> wagtail - Panel types </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=fieldpanel#fieldpanel"> <span>FieldPanel</span> </a> </p> <p class="fragment"> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=fieldpanel#wagtail.admin.panels.FieldPanel"> [py:class]: wagtail.admin.panels.<span>FieldPanel</span> </a> </p> <p class="fragment"> This is the panel used for basic Django field types. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=fieldpanel#collapsible"> Collapsible </a> </p> <p class="fragment"> ... ('cover'), <span>FieldPanel</span>('book_file'), <span>FieldPanel</span>('publisher'), ], heading="Collection of Book Fields", ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=fieldpanel#wagtail.admin.panels.FieldPanel.classname"> [py:attribute]: wagtail.admin.panels.<span>FieldPanel</span>.classname </a> </p> <p class="fragment"> This is a string of optional CSS classes given to the panel which are used in formatting and scripte ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=fieldpanel#wagtail.admin.panels.FieldPanel.heading"> [py:attribute]: wagtail.admin.panels.<span>FieldPanel</span>.heading </a> </p> <p class="fragment"> This allows you to override the heading for the panel, which will otherwise be set automatically usi ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=fieldpanel#placeholder-text"> Placeholder Text </a> </p> <p class="fragment"> ... To change it, pass to the <span>FieldPanel</span> a widget with a placeholder attribute set to your desired text. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/create_edit_delete_views.html?highlight=fieldpanel"> wagtail - Customising CreateView, EditView and DeleteView </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/create_edit_delete_views.html?highlight=fieldpanel#changing-which-fields-appear-in-createview-editview"> Changing which fields appear in CreateView & EditView </a> </p> <p class="fragment"> ... = [ <span>FieldPanel</span>('title'), <span>FieldPanel</span>('author'), ] edit_handler = ObjectList(custom_panels) ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=fieldpanel"> wagtail - Form builder customisation </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=fieldpanel#custom-related-name-for-form-fields"> Custom related_name for form fields </a> </p> <p class="fragment"> ... ([ FieldRowPanel([ <span>FieldPanel</span>('from_address', classname="col6"), <span>FieldPanel</span>('to_address', classname=" ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=fieldpanel#custom-form-submission-model"> Custom form submission model </a> </p> <p class="fragment"> ... ([ FieldRowPanel([ <span>FieldPanel</span>('from_address', classname="col6"), <span>FieldPanel</span>('to_address', classname=" ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=fieldpanel#custom-landing-page-redirect"> Custom landing page redirect </a> </p> <p class="fragment"> ... ([ FieldRowPanel([ <span>FieldPanel</span>('from_address', classname='col6'), <span>FieldPanel</span>('to_address', classname=' ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/4.0.4.html?highlight=fieldpanel"> wagtail - Wagtail 4.0.4 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/4.0.4.html?highlight=fieldpanel#what-s-new"> What’s new </a> </p> <p class="fragment"> ... Render help_text when set on <span>FieldPanel</span>, MultiFieldPanel, FieldRowPanel, and other panel APIs where it ... </p> <p></p> </li>`, | |
| 'groupmenuitem': `No results`, | |
| 'hooks': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/hooks.html?highlight=hooks"> wagtail - <span>Hooks</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/hooks.html?highlight=hooks#hooks"> <span>Hooks</span> </a> </p> <p class="fragment"> ... If order is not specified then the <span>hooks</span> proceed in the order given by INSTALLED_APPS. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/hooks.html?highlight=hooks#unit-testing-hooks"> Unit testing <span>hooks</span> </a> </p> <p class="fragment"> ... are registered here .. # All <span>hooks</span> are unregistered here The available <span>hooks</span> are listed below. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/hooks.html?highlight=hooks#snippets"> Snippets </a> </p> <p class="fragment"> ... <span>Hooks</span> for working with registered Snippets. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/0.4.html?highlight=hooks"> wagtail - Wagtail 0.4 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/0.4.html?highlight=hooks#wagtailadmins-hooks-module-has-moved-to-wagtailcore"> Wagtailadmins <span>hooks</span> module has moved to wagtailcore </a> </p> <p class="fragment"> ... Change this to: from wagtail.core import <span>hooks</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.10.html?highlight=hooks"> wagtail - Wagtail 2.10 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.10.html?highlight=hooks#new-next-url-keyword-argument-on-register-page-listing-buttons-and-register-page-listing-more-buttons-hooks"> New next_url keyword argument on register_page_listing_buttons and register_page_listing_more_buttons <span>hooks</span> </a> </p> <p class="fragment"> ... Functions registered through the <span>hooks</span> register_page_listing_buttons and register_page_listing_more_buttons ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/2.10.html?highlight=hooks#other-features"> Other features </a> </p> <p class="fragment"> ... Redirect to previous url when deleting/copying/unpublish a page and modify this url via the relevant <span>hooks</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.15.html?highlight=hooks"> wagtail - Wagtail 2.15 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.15.html?highlight=hooks#bulk-action-views-not-covered-by-existing-hooks"> Bulk action views not covered by existing <span>hooks</span> </a> </p> <p class="fragment"> ... functionality, those <span>hooks</span> will not be called on the corresponding bulk action views. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/2.15.html?highlight=hooks#passing-callables-as-messages-in-register-log-actions-is-deprecated"> Passing callables as messages in register_log_actions is deprecated </a> </p> <p class="fragment"> ... now be rewritten as: from django.utils.translation import gettext_lazy as _ from wagtail.core import <span>hooks</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/2.15.html?highlight=hooks#admin-homepage-panels-summary-items-and-action-menu-items-now-use-components"> Admin homepage panels, summary items and action menu items now use components </a> </p> <p class="fragment"> ... Several Wagtail <span>hooks</span> provide a mechanism for passing Python objects to be rendered as HTML inside admin ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/4.0.html?highlight=hooks"> wagtail - Wagtail 4.0 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/4.0.html?highlight=hooks#is-parent-removed-from-page-button-hooks"> is_parent removed from page button <span>hooks</span> </a> </p> <p class="fragment"> ... The following <span>hooks</span> construct_page_listing_buttons, register_page_listing_buttons, register_page_listing_more_buttons ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/4.0.html?highlight=hooks#slim-header-on-page-listings"> Slim header on page listings </a> </p> <p class="fragment"> ... Those <span>hooks</span> still work as-is to define actions for each page within the listings. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/4.0.html?highlight=hooks#other-features"> Other features </a> </p> <p class="fragment"> ... RichTextField and RichTextBlock (Matt Westcott, Thibaud Colas) Remove is_parent kwarg in various page button <span>hooks</span> ... </p> <p></p> </li>`, | |
| 'image': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/custom_image_model.html?highlight=image"> wagtail - Custom <span>image</span> models </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/custom_image_model.html?highlight=image#custom-image-models"> Custom <span>image</span> models </a> </p> <p class="fragment"> ... The <span>Image</span> model can be customised, allowing additional fields to be added to images. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/custom_image_model.html?highlight=image#wagtail.images.get_image_model"> [py:function]: wagtail.images.get_<span>image</span>_model </a> </p> <p class="fragment"> Get the <span>image</span> model from the WAGTAILIMAGES_IMAGE_MODEL setting. </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/custom_image_model.html?highlight=image#migrating-from-the-builtin-image-model"> Migrating from the builtin <span>image</span> model </a> </p> <p class="fragment"> ... When changing an existing site to use a custom <span>image</span> model, no images will be copied to the new model ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/custom_image_model.html?highlight=image#wagtail.images.get_image_model_string"> [py:function]: wagtail.images.get_<span>image</span>_model_string </a> </p> <p class="fragment"> Get the dotted app.Model name for the <span>image</span> model as a string. </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/custom_image_model.html?highlight=image#module-wagtail.images"> Referring to the <span>image</span> model </a> </p> <p class="fragment"> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/custom_image_filters.html?highlight=image"> wagtail - Custom <span>image</span> filters </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/custom_image_filters.html?highlight=image#custom-image-filters"> Custom <span>image</span> filters </a> </p> <p class="fragment"> ... If you use another <span>image</span> library, or like to support multiple <span>image</span> libraries, you need to update the ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/jinja2.html?highlight=image"> wagtail - Jinja2 template support </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/jinja2.html?highlight=image#image"> <span>image</span>() </a> </p> <p class="fragment"> ... Resize an <span>image</span>, and print an <img> tag: {# Print an <span>image</span> tag #} {{ <span>image</span>(page.header_image, "fill-1024x200 ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https:\/\/docs.wagtail.org/en/stable/advanced_topics/images/image_serve_view.html?highlight=image"> wagtail - Dynamic <span>image</span> serve view </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/image_serve_view.html?highlight=image#dynamic-image-serve-view"> Dynamic <span>image</span> serve view </a> </p> <p class="fragment"> ... The view takes an <span>image</span> id, filter spec, and security signature in the URL. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/image_serve_view.html?highlight=image#image-url-generator-ui"> <span>Image</span> URL generator UI </a> </p> <p class="fragment"> ... This interface allows editors to generate URLs to cropped versions of the <span>image</span>. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/image_serve_view.html?highlight=image#generating-dynamic-image-urls-in-python"> Generating dynamic <span>image</span> URLs in Python </a> </p> <p class="fragment"> ... (<span>image</span>, 'fill-100x100') }) <span>Image</span> operations can be chained by joining them with a | character: return ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=image"> wagtail - Performance </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=image#image-urls"> <span>Image</span> URLs </a> </p> <p class="fragment"> ... If an <span>image</span> is too large for Willow to handle (the size of an <span>image</span> can be constrained with WAGTAILIMAGES_MAX_IMAGE_PIXELS ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=image#image-attributes"> <span>Image</span> attributes </a> </p> <p class="fragment"> ... It can be configured site-wide Adding default attributes to all images or per-<span>image</span> More control over ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=image#caching-image-renditions"> Caching <span>image</span> renditions </a> </p> <p class="fragment"> ... you define a cache named ‘renditions’ (typically alongside your ‘default’ cache), Wagtail will cache <span>image</span> ... </p> <p></p> </li>`, | |
| 'language': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/contributing/general_guidelines.html?highlight=language"> wagtail - General coding guidelines </a> </p><p> <a href="https://docs.wagtail.org/en/stable/contributing/general_guidelines.html?highlight=language#language"> <span>Language</span> </a> </p> <p class="fragment"> ... code should use American English if the British or international spelling would conflict with built-in <span>language</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.10.html?highlight=language"> wagtail - Wagtail 1.10 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.10.html?highlight=language#user-language-preference"> User <span>language</span> preference </a> </p> <p class="fragment"> ... Users can now set their preferred <span>language</span> for the Wagtail admin interface under Account Settings → <span>Language</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=language"> wagtail - Model Reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=language#wagtail.models.Locale.language_code"> [py:attribute]: wagtail.models.Locale.<span>language</span>_code </a> </p> <p class="fragment"> The <span>language</span> code that represents this locale The <span>language</span> code can either be a <span>language</span> code on its </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=language#wagtail.models.Locale.get_active"> [py:method]: wagtail.models.Locale.get_active </a> </p> <p class="fragment"> Returns the Locale that corresponds to the currently activated <span>language</span> in Django. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=language#wagtail.models.Page.localized_draft"> [py:attribute]: wagtail.models.Page.localized_draft </a> </p> <p class="fragment"> Finds the translation in the current active <span>language</span>. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=language#locale"> Locale </a> </p> <p class="fragment"> ... Wagtail will initially set up one Locale to act as the default <span>language</span> for all existing content. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=language#id4"> Database fields </a> </p> <p class="fragment"> ... and translation_key fields have a unique key constraint to prevent the object being translated into a <span>language</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=language#changing-wagtail-content-languages"> Changing WAGTAIL_CONTENT_LANGUAGES </a> </p> <p class="fragment"> ... WAGTAIL_CONTENT_LANGUAGES, it’s important that the Locale record is updated to a use a different content <span>language</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/i18n.html?highlight=language"> wagtail - Internationalisation </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/i18n.html?highlight=language#bypass-language-prefix-for-the-default-language"> Bypass <span>language</span> prefix for the default <span>language</span> </a> </p> <p class="fragment"> ... If you want your default <span>language</span> to have URLs that resolve normally without a <span>language</span> prefix, you can ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/i18n.html?highlight=language#user-language-auto-detection"> User <span>language</span> auto-detection </a> </p> <p class="fragment"> ... To fix this, we need to detect the user’s browser <span>language</span> and redirect them to the best <span>language</span> prefix ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/i18n.html?highlight=language#custom-routing-language-detection"> Custom routing/<span>language</span> detection </a> </p> <p class="fragment"> ... All Wagtail needs is the <span>language</span> to be activated (using Django’s django.utils.translation.activate function ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.11.html?highlight=language"> wagtail - Wagtail 2.11 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.11.html?highlight=language#site-get-site-root-paths-now-returns-language-code"> Site.get_site_root_paths now returns <span>language</span> code </a> </p> <p class="fragment"> In previous releases, Site.get_site_root_paths returned a list of (site_id, root_path, root_url) tup ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/2.11.html?highlight=language#multi-lingual-content"> Multi-lingual content </a> </p> <p class="fragment"> ... To find out more about this feature, see Multi-<span>language</span> content. ... </p> <p></p> </li>`, | |
| 'listblockfactory': `No results`, | |
| 'menu': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=menu"> wagtail - Page QuerySet reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=menu#wagtail.query.PageQuerySet.in_menu"> [py:method]: wagtail.query.PageQuerySet.in_<span>menu</span> </a> </p> <p class="fragment"> Example: # Build a <span>menu</span> from live pages that are children of the homepage menu_items = homepage.get_children </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=menu#getting-a-list-of-menu-items"> Getting a list of <span>menu</span> items </a> </p> <p class="fragment"> # This gets a QuerySet of live children of the homepage with \`\`show_in_menus\`\` set menu_items = home ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=menu#wagtail.query.PageQuerySet.not_in_menu"> [py:method]: wagtail.query.PageQuerySet.not_in_<span>menu</span> </a> </p> <p class="fragment"> This filters the QuerySet to only contain pages that are not in the menus. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/menu_item.html?highlight=menu"> wagtail - Customising the <span>menu</span> item </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/menu_item.html?highlight=menu#customising-the-menu-item"> Customising the <span>menu</span> item </a> </p> <p class="fragment"> ... You can use the following attributes and methods on the ModelAdmin class to alter the <span>menu</span> item used ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/menu_item.html?highlight=menu#modeladmin-menu-order"> ModelAdmin.menu_order </a> </p> <p class="fragment"> ... wish to keep the explorer <span>menu</span> item at the top. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/menu_item.html?highlight=menu#modeladmin-menu-label"> ModelAdmin.menu_label </a> </p> <p class="fragment"> ... If not set, the <span>menu</span> item will use verbose_name_plural from your model’s Meta data. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.11.html?highlight=menu"> wagtail - Wagtail 1.11 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.11.html?highlight=menu#browser-requirements-for-the-new-explorer-menu"> Browser requirements for the new explorer <span>menu</span> </a> </p> <p class="fragment"> ... The new explorer <span>menu</span> does not support IE8, IE9, and IE10. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/1.11.html?highlight=menu#explorer-menu-built-with-the-admin-api-and-react"> Explorer <span>menu</span> built with the admin API and React </a> </p> <p class="fragment"> ... Navigate the <span>menu</span> via keyboard. View Draft pages, and go to page editing, directly from the <span>menu</span>. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/admin_views.html?highlight=menu"> wagtail - Creating admin views </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/admin_views.html?highlight=menu#adding-a-menu-item"> Adding a <span>menu</span> item </a> </p> <p class="fragment"> ... To add an item to the sidebar <span>menu</span>, we’ll use another hook, Register Admin <span>Menu</span> Item. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/admin_views.html?highlight=menu#adding-a-group-of-menu-items"> Adding a group of <span>menu</span> items </a> </p> <p class="fragment"> ... Sometimes you want to group custom views in a single <span>menu</span> item in the sidebar. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/admin_views.html?highlight=menu#registering-a-url-route"> Registering a URL route </a> </p> <p class="fragment"> ... points in Wagtail’s operation, such as building the URL config for the admin and constructing the main <span>menu</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/adding_reports.html?highlight=menu"> wagtail - Adding reports </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/adding_reports.html?highlight=menu#adding-a-menu-item-and-admin-url"> Adding a <span>menu</span> item and admin URL </a> </p> <p class="fragment"> ... hook (see: Register Reports <span>Menu</span> Item). ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/adding_reports.html?highlight=menu#setting-up-permission-restriction"> Setting up permission restriction </a> </p> <p class="fragment"> ... Even with the <span>menu</span> item hidden, it would still be possible for any user to visit the report’s URL directly ... </p> <p></p> </li>`, | |
| 'modeladmin': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.5.html?highlight=modeladmin"> wagtail - Wagtail 1.5 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.5.html?highlight=modeladmin#modeladmin"> <span>ModelAdmin</span> </a> </p> <p class="fragment"> ... See <span>ModelAdmin</span> for full documentation. This feature was developed by Andy Babic. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=modeladmin"> wagtail - <span>ModelAdmin</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=modeladmin#modeladmin"> <span>ModelAdmin</span> </a> </p> <p class="fragment"> ... The <span>modeladmin</span> module allows you to add any model in your project to the Wagtail admin. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=modeladmin#a-more-complicated-example"> A more complicated example </a> </p> <p class="fragment"> ... , ModelAdminGroup, modeladmin_register) from .models import ( Book, Author, Genre) class BookAdmin(<span>ModelAdmin</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=modeladmin#registering-multiple-classes-in-one-wagtail-hooks-py-file"> Registering multiple classes in one wagtail_hooks.py file </a> </p> <p class="fragment"> ... The example below will create 3 top-level menus. class BookAdmin(<span>ModelAdmin</span>): model = Book ... class ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=modeladmin"> wagtail - Reversing <span>ModelAdmin</span> URLs </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=modeladmin#reversing-modeladmin-urls"> Reversing <span>ModelAdmin</span> URLs </a> </p> <p class="fragment"> ... You can take a similar approach in your own code too, by creating a <span>ModelAdmin</span> instance yourself, and ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=modeladmin#getting-the-edit-or-delete-or-inspect-url-for-an-object"> Getting the edit or delete or inspect URL for an object </a> </p> <p class="fragment"> ... NOTE: This will only work if inspect_view_enabled is set to True on your <span>ModelAdmin</span> class. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=modeladmin#getting-the-index-or-create-url-for-a-model"> Getting the index or create URL for a model </a> </p> <p class="fragment"> ... function # both will output /admin/my-app/author/create Note If you have registered a page type with <span>modeladmin</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/primer.html?highlight=modeladmin"> wagtail - <span>modeladmin</span> customisation primer </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/primer.html?highlight=modeladmin#modeladmin-customisation-primer"> <span>modeladmin</span> customisation primer </a> </p> <p class="fragment"> ... The <span>modeladmin</span> app is designed to offer you as much flexibility as possible in how your model and its ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/primer.html?highlight=modeladmin#wagtail-s-modeladmin-class-is-modular"> Wagtail’s <span>ModelAdmin</span> class is ‘modular’ </a> </p> <p class="fragment"> ... your <span>ModelAdmin</span> class to use them instead of the defaults. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/primer.html?highlight=modeladmin#wagtail-s-modeladmin-class-isn-t-the-same-as-django-s"> Wagtail’s <span>ModelAdmin</span> class isn’t the same as Django’s </a> </p> <p class="fragment"> ... Wagtail’s <span>ModelAdmin</span> class is designed to be used in a similar way to Django’s class of the same name ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/custom_clean.html?highlight=modeladmin"> wagtail - Adding a custom clean method to your <span>ModelAdmin</span> models </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/custom_clean.html?highlight=modeladmin#adding-a-custom-clean-method-to-your-modeladmin-models"> Adding a custom clean method to your <span>ModelAdmin</span> models </a> </p> <p class="fragment"> ... The simplest way is to extend your <span>ModelAdmin</span> model and add a clean() model to it. ... </p> <p></p> </li>`, | |
| 'page': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=page"> wagtail - <span>Page</span> QuerySet reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=page#wagtail.query.PageQuerySet.page"> [py:method]: wagtail.query.PageQuerySet.<span>page</span> </a> </p> <p class="fragment"> This filters the QuerySet so it only contains the specified <span>page</span>. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=page#wagtail.query.PageQuerySet.not_page"> [py:method]: wagtail.query.PageQuerySet.not_<span>page</span> </a> </p> <p class="fragment"> This filters the QuerySet so it doesn’t contain the specified <span>page</span>. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=page#page-queryset-reference"> <span>Page</span> QuerySet reference </a> </p> <p class="fragment"> ... All models that inherit from <span>Page</span> are given some extra QuerySet methods accessible from their .objects ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=page#wagtail.query.PageQuerySet.first_common_ancestor"> [py:method]: wagtail.query.PageQuerySet.first_common_ancestor </a> </p> <p class="fragment"> <span>Page</span> 2/ - Bar Event Index/ - Bar Event <span>Page</span> 1/ - Bar Event <span>Page</span> 2/ The common ancestors for some queries </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/pages.html?highlight=page"> wagtail - <span>Page</span> models </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/pages.html?highlight=page#page-descriptions"> <span>Page</span> descriptions </a> </p> <p class="fragment"> ... you create a new <span>page</span>, edit an existing <span>page</span> or when you’re prompted to select a child <span>page</span> type. class ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/pages.html?highlight=page#page-urls"> <span>Page</span> URLs </a> </p> <p class="fragment"> ... <span>Page</span> models also include several low-level methods for overriding or accessing <span>page</span> URLs. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/pages.html?highlight=page#page-models"> <span>Page</span> models </a> </p> <p class="fragment"> ... All <span>page</span> models must inherit from the wagtail.models.Page class. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/permissions.html?highlight=page"> wagtail - Permissions </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/permissions.html?highlight=page#page-permissions"> <span>Page</span> permissions </a> </p> <p class="fragment"> ... <span>page</span>. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=page"> wagtail - Model Reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=page#wagtail.models.Page.parent_page_types"> [py:attribute]: wagtail.models.<span>Page</span>.parent_<span>page</span>_types </a> </p> <p class="fragment"> A list of <span>page</span> models which are allowed as parent <span>page</span> types. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=page#wagtail.models.PageLogEntry.page"> [py:attribute]: wagtail.models.PageLogEntry.<span>page</span> </a> </p> <p class="fragment"> (foreign key to <span>Page</span>) A foreign key to the <span>page</span> the action is performed on. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=page#wagtail.models.Comment.page"> [py:attribute]: wagtail.models.Comment.<span>page</span> </a> </p> <p class="fragment"> (parental key to <span>Page</span>) A parental key to the <span>page</span> the comment has been added to. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=page#page"> <span>Page</span> </a> </p> <p class="fragment"> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=page#revision"> Revision </a> </p> <p class="fragment"> ... Every time a <span>page</span> is edited, a new Revision is created and saved to the database. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=page#methods-and-properties"> Methods and properties </a> </p> <p class="fragment"> ... <span>Page</span> is a subclass of materialized path tree nodes. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/simple_translation.html?highlight=page"> wagtail - Simple translation </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/simple_translation.html?highlight=page#page-tree-synchronisation"> <span>Page</span> tree synchronisation </a> </p> <p class="fragment"> ... , Wagtail creates an alias for that <span>page</span> under the <span>page</span> trees of all the other locales. ... </p> <p></p> </li>`, | |
| 'parentalkey': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/pages.html?highlight=parentalkey"> wagtail - Page models </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/pages.html?highlight=parentalkey#inline-models"> Inline models </a> </p> <p class="fragment"> ... field type must be imported from there: from modelcluster.fields import <span>ParentalKey</span> <span>ParentalKey</span> is a ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/pages.html?highlight=parentalkey#an-example-wagtail-page-model"> An example Wagtail page model </a> </p> <p class="fragment"> ... example represents a typical blog post: from django.db import models from modelcluster.fields import <span>ParentalKey</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/snippets.html?highlight=parentalkey"> wagtail - Snippets </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/snippets.html?highlight=parentalkey#tagging-snippets"> Tagging snippets </a> </p> <p class="fragment"> ... TaggedItemBase from taggit.managers import TaggableManager class AdvertTag(TaggedItemBase): content_object = <span>ParentalKey</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/snippets.html?highlight=parentalkey#binding-pages-to-snippets"> Binding pages to snippets </a> </p> <p class="fragment"> ... # ... class BookPageAdvertPlacement(Orderable, models.Model): page = <span>ParentalKey</span>('demo.BookPage', on_delete ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/snippets.html?highlight=parentalkey#saving-revisions-of-snippets"> Saving revisions of snippets </a> </p> <p class="fragment"> ... Inline models should continue to use <span>ParentalKey</span> instead of ForeignKey. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=parentalkey"> wagtail - Form builder customisation </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=parentalkey#custom-related-name-for-form-fields"> Custom related_name for form fields </a> </p> <p class="fragment"> ... You can do this as shown below. from modelcluster.fields import <span>ParentalKey</span> from wagtail.admin.panels ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=parentalkey#custom-form-submission-model"> Custom form submission model </a> </p> <p class="fragment"> ... json from django.conf import settings from django.db import models from modelcluster.fields import <span>ParentalKey</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=parentalkey#add-custom-data-to-csv-export"> Add custom data to CSV export </a> </p> <p class="fragment"> ... json from django.conf import settings from django.db import models from modelcluster.fields import <span>ParentalKey</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=parentalkey"> wagtail - Panel types </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=parentalkey#inline-panels-and-model-clusters"> Inline Panels and Model Clusters </a> </p> <p class="fragment"> ... for streamlined relation of extra models to a Wagtail page via a ForeignKey-like relationship called <span>ParentalKey</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=parentalkey#multiplechooserpanel"> MultipleChooserPanel </a> </p> <p class="fragment"> ... child model that provies a gallery of images on BlogPage: class BlogPageGalleryImage(Orderable): page = <span>ParentalKey</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_recipes.html?highlight=parentalkey"> wagtail - Recipes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_recipes.html?highlight=parentalkey#custom-tag-models"> Custom tag models </a> </p> <p class="fragment"> ... models from modelcluster.contrib.taggit import ClusterTaggableManager from modelcluster.fields import <span>ParentalKey</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_recipes.html?highlight=parentalkey#tagging"> Tagging </a> </p> <p class="fragment"> ... set up tagging on BlogPage through a BlogPageTag model: # models.py from modelcluster.fields import <span>ParentalKey</span> ... </p> <p></p> </li>`, | |
| 'richtext': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/legacy_richtext.html?highlight=richtext"> wagtail - Legacy <span>richtext</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/legacy_richtext.html?highlight=richtext#module-wagtail.contrib.legacy.richtext"> Legacy <span>richtext</span> </a> </p> <p class="fragment"> ... Provides the legacy <span>richtext</span> wrapper. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/legacy_richtext.html?highlight=richtext#module-wagtail.contrib.legacy.richtext"> [py:module]: wagtail.contrib.legacy.<span>richtext</span> </a> </p> <p class="fragment"> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/jinja2.html?highlight=richtext"> wagtail - Jinja2 template support </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/jinja2.html?highlight=richtext#richtext"> |<span>richtext</span> </a> </p> <p class="fragment"> ... Wagtail’s internal HTML representation, expanding internal references to pages and images. {{ page.body|<span>richtext</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/index.html?highlight=richtext"> wagtail - Contrib modules </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/index.html?highlight=richtext#id12"> Legacy <span>richtext</span> </a> </p> <p class="fragment"> ... Provides the legacy <span>richtext</span> wrapper (<div class="rich-text"></div>). ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=richtext"> wagtail - Rich text internals </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=richtext#data-format"> Data format </a> </p> <p class="fragment"> ... automatically when rendered as a string, so the |<span>richtext</span> filter is not necessary. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=richtext"> wagtail - How to use StreamField for mixed content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=richtext#modifying-streamfield-data"> Modifying StreamField data </a> </p> <p class="fragment"> ... my_page.body.append(('paragraph', <span>RichText</span>("<p>And they all lived happily ever after. ... </p> <p></p> </li>`, | |
| 'richtextfield': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=richtextfield"> wagtail - Form builder customisation </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=richtextfield#custom-related-name-for-form-fields"> Custom related_name for form fields </a> </p> <p class="fragment"> ... (blank=True) thank_you_text = <span>RichTextField</span>(blank=True) content_panels = AbstractEmailForm.content_panels ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=richtextfield#using-formmixin-or-emailformmixin-to-use-with-other-page-subclasses"> Using FormMixin or EmailFormMixin to use with other Page subclasses </a> </p> <p class="fragment"> ... (blank=True) # ... class EmailFormPage(EmailFormMixin, FormMixin, BasePage): intro = <span>RichTextField</span>(blank ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html?highlight=richtextfield#custom-form-submission-model"> Custom form submission model </a> </p> <p class="fragment"> ... (blank=True) thank_you_text = <span>RichTextField</span>(blank=True) content_panels = AbstractEmailForm.content_panels ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=richtextfield"> wagtail - Customising the editing interface </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=richtextfield#rich-text-html"> Rich Text (HTML) </a> </p> <p class="fragment"> ... import <span>RichTextField</span> from wagtail.admin.panels import FieldPanel class BookPage(Page): body = <span>RichTextField</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=richtextfield#image-formats-in-the-rich-text-editor"> Image Formats in the Rich Text Editor </a> </p> <p class="fragment"> ... provides a way to customise the formatting options shown to the editor when inserting images in the <span>RichTextField</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=richtextfield#limiting-features-in-a-rich-text-field"> Limiting features in a rich text field </a> </p> <p class="fragment"> ... for the features you wish to allow: body = <span>RichTextField</span>(features=['h2', 'h3', 'bold', 'italic', 'link ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/settings.html?highlight=richtextfield"> wagtail - Settings </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/settings.html?highlight=richtextfield#wagtailadmin-rich-text-editors"> WAGTAILADMIN_RICH_TEXT_EDITORS </a> </p> <p class="fragment"> ... By default, <span>RichTextField</span> and RichTextBlock use the configuration given under the 'default' key, but ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/writing_templates.html?highlight=richtextfield"> wagtail - Writing templates </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/writing_templates.html?highlight=richtextfield#rich-text-filter"> Rich text (filter) </a> </p> <p class="fragment"> ... Only fields using <span>RichTextField</span> need this applied in the template. {% load wagtailcore_tags %} ... {{ ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/index.html?highlight=richtextfield"> wagtail - Form builder </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/forms/index.html?highlight=richtextfield#usage\"> Usage </a> </p> <p class="fragment"> ... (blank=True) thank_you_text = <span>RichTextField</span>(blank=True) content_panels = AbstractEmailForm.content_panels ... </p> <p></p> </li>`, | |
| 'robots': `No results`, | |
| 'search': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/searchpromotions.html?highlight=search"> wagtail - Promoted <span>search</span> results </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/searchpromotions.html?highlight=search#module-wagtail.contrib.search_promotions"> Promoted <span>search</span> results </a> </p> <p class="fragment"> ... “Promoted <span>search</span> results” allow editors to explicitly link relevant content to <span>search</span> terms, so results ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/searchpromotions.html?highlight=search#displaying-on-a-search-results-page"> Displaying on a <span>search</span> results page </a> </p> <p class="fragment"> ... To retrieve a list of promoted <span>search</span> results for a particular <span>search</span> query, you can use the {% get_search_promotions ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/searchpromotions.html?highlight=search#module-wagtail.contrib.search_promotions"> [py:module]: wagtail.contrib.<span>search</span>_promotions </a> </p> <p class="fragment"> </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/searchpromotions.html?highlight=search#usage"> Usage </a> </p> <p class="fragment"> ... This is where you can assign pages to popular <span>search</span> terms. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/search/index.html?highlight=search"> wagtail - <span>Search</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/search/index.html?highlight=search#search"> <span>Search</span> </a> </p> <p class="fragment"> ... Wagtail provides a comprehensive and extensible <span>search</span> interface. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/search/index.html?highlight=search#backends"> Backends </a> </p> <p class="fragment"> ... Wagtail provides two backends for storing the <span>search</span> index and performing <span>search</span> queries: one using the ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/search/index.html?highlight=search#indexing"> Indexing </a> </p> <p class="fragment"> ... To make objects searchable, they must first be added to the <span>search</span> index. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=search"> wagtail - Performance </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=search#search"> <span>Search</span> </a> </p> <p class="fragment"> ... Elasticsearch is faster and more powerful than the Django ORM for text <span>search</span>, so we recommend installing ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/index.html?highlight=search"> wagtail - Contrib modules </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/index.html?highlight=search#id7"> Promoted <span>search</span> results </a> </p> <p class="fragment"> ... A module for managing “Promoted <span>Search</span> Results” ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=search"> wagtail - Page QuerySet reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/queryset_reference.html?highlight=search#wagtail.query.PageQuerySet.search"> [py:method]: wagtail.query.PageQuerySet.<span>search</span> </a> </p> <p class="fragment"> This runs a <span>search</span> query on all the items in the QuerySet See: Searching QuerySets Example: # <span>Search</span> </p> <p></p> </li>`, | |
| 'streamfield': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=streamfield"> wagtail - <span>StreamField</span> block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=streamfield#streamfield-block-reference"> <span>StreamField</span> block reference </a> </p> <p class="fragment"> ... This document details the block types provided by Wagtail for use in <span>StreamField</span>, and how they can be ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=streamfield#wagtail.fields.StreamField"> [py:class]: wagtail.fields.<span>StreamField</span> </a> </p> <p class="fragment"> See How to use <span>StreamField</span> for mixed content. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=streamfield#structural-block-types"> Structural block types </a> </p> <p class="fragment"> ... Since <span>StreamField</span> accepts an instance of StreamBlock as a parameter, in place of a list of block types ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=streamfield#wagtail.blocks.FieldBlock"> [py:class]: wagtail.blocks.FieldBlock </a> </p> <p class="fragment"> Bases: Block A block that wraps a Django form field The parent class of all <span>StreamField</span> field block types </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=streamfield#wagtail.blocks.FieldBlock"> [py:class]: wagtail.blocks.field_block.FieldBlock </a> </p> <p class="fragment"> Bases: Block A block that wraps a Django form field The parent class of all <span>StreamField</span> field block types </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/index.html?highlight=streamfield"> wagtail - <span>StreamField</span> reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/index.html?highlight=streamfield#id2"> <span>StreamField</span> block reference </a> </p> <p class="fragment"> ... Details the block types provided by Wagtail for use in <span>StreamField</span> and how they can be combined into ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/index.html?highlight=streamfield#id4"> <span>StreamField</span> data migration reference </a> </p> <p class="fragment"> ... Details the tools provided in wagtail.blocks.migrations for <span>StreamField</span> data migrations. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/index.html?highlight=streamfield#streamfield-reference"> <span>StreamField</span> reference </a> </p> <p class="fragment"> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/testing.html?highlight=streamfield"> wagtail - Testing your Wagtail site </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/testing.html?highlight=streamfield#wagtail.test.utils.form_data.streamfield"> [py:function]: wagtail.test.utils.form_data.<span>streamfield</span> </a> </p> <p class="fragment"> Takes a list of (block_type, value) tuples and turns it in to <span>StreamField</span> form data. </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/testing.html?highlight=streamfield#wagtailpagetestcase"> WagtailPageTestCase </a> </p> <p class="fragment"> ... POST data self.assertCanCreate(root_page, ContentPage, nested_form_data({ 'title': 'About us', 'body': <span>streamfield</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/boundblocks_and_values.html?highlight=streamfield"> wagtail - About <span>StreamField</span> BoundBlocks and values </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/boundblocks_and_values.html?highlight=streamfield#about-streamfield-boundblocks-and-values"> About <span>StreamField</span> BoundBlocks and values </a> </p> <p class="fragment"> ... All <span>StreamField</span> block types accept a template parameter to determine how they will be rendered on a page ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/streamfield_migrations.html?highlight=streamfield"> wagtail - <span>StreamField</span> migrations </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/streamfield_migrations.html?highlight=streamfield#streamfield-data-migrations"> <span>StreamField</span> data migrations </a> </p> <p class="fragment"> ... Wagtail provides a set of utilities for creating data migrations on <span>StreamField</span> data. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/streamfield_migrations.html?highlight=streamfield#migrating-richtextfields-to-streamfield"> Migrating RichTextFields to <span>StreamField</span> </a> </p> <p class="fragment"> ... If you change an existing RichTextField to a <span>StreamField</span>, the database migration will complete with no ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/streamfield_migrations.html?highlight=streamfield#streamfield-migrations"> <span>StreamField</span> migrations </a> </p> <p class="fragment"> ... </p> <p></p> </li>`, | |
| 'structblock': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=structblock"> wagtail - How to build custom StreamField blocks </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=structblock#custom-editing-interfaces-for-structblock"> Custom editing interfaces for <span>StructBlock</span> </a> </p> <p class="fragment"> ... attribute (either as a keyword argument to the <span>StructBlock</span> constructor, or in a subclass’s Meta) to ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=structblock#additional-javascript-on-structblock-forms"> Additional JavaScript on <span>StructBlock</span> forms </a> </p> <p class="fragment"> ... Often it may be desirable to attach custom JavaScript behaviour to a <span>StructBlock</span> form. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=structblock#additional-methods-and-properties-on-structblock-values"> Additional methods and properties on <span>StructBlock</span> values </a> </p> <p class="fragment"> ... When rendering StreamField content on a template, <span>StructBlock</span> values are represented as dict-like objects ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=structblock"> wagtail - How to use StreamField for mixed content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=structblock#structblock"> <span>StructBlock</span> </a> </p> <p class="fragment"> ... <span>StructBlock</span> allows you to group several ‘child’ blocks together to be presented as a single block. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=structblock#subclassing-structblock"> Subclassing <span>StructBlock</span> </a> </p> <p class="fragment"> ... As an alternative, <span>StructBlock</span> can be subclassed, with the child blocks defined as attributes on the ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=structblock#block-icons"> Block icons </a> </p> <p class="fragment"> ... For <span>StructBlock</span> and other structural block types, a placeholder icon is used, since the purpose of these ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=structblock"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=structblock#wagtail.blocks.StructBlock"> [py:class]: wagtail.blocks.<span>StructBlock</span> </a> </p> <p class="fragment"> See Custom editing interfaces for <span>StructBlock</span>. value_class – A subclass of wagtail.blocks.StructValue </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=structblock#wagtail.blocks.StructBlock"> [py:class]: wagtail.blocks.struct_block.<span>StructBlock</span> </a> </p> <p class="fragment"> See Custom editing interfaces for <span>StructBlock</span>. value_class – A subclass of wagtail.blocks.StructValue </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=structblock#wagtail.blocks.StreamBlock"> [py:class]: wagtail.blocks.StreamBlock </a> </p> <p class="fragment"> blocks.CharBlock()), ])), ('video', EmbedBlock()), ], icon='cogs' )), ], use_json_field=True) As with <span>StructBlock</span> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/data_migrations.html?highlight=structblock"> wagtail - StreamField data migration reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/data_migrations.html?highlight=structblock#map-struct-block-value"> map_struct_block_value </a> </p> <p class="fragment"> ... Returns: mapped_value: The value of the <span>StructBlock</span> after transforming its children. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/data_migrations.html?highlight=structblock#streamchildrentostructblockoperation"> StreamChildrenToStructBlockOperation </a> </p> <p class="fragment"> ... as a child of that <span>StructBlock</span>. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/data_migrations.html?highlight=structblock#removestructchildrenoperation"> RemoveStructChildrenOperation </a> </p> <p class="fragment"> ... class RemoveStructChildrenOperation(BaseBlockOperation) Removes all <span>StructBlock</span> children of the given ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.13.html?highlight=structblock"> wagtail - Wagtail 2.13 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.13.html?highlight=structblock#new-client-side-implementation-for-custom-streamfield-blocks"> New client-side implementation for custom StreamField blocks </a> </p> <p class="fragment"> ... See Custom editing interfaces for <span>StructBlock</span>. ... </p> <p></p> </li>`, | |
| 'tabularinline': `No results`, | |
| 'use_json_field': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/3.0.html?highlight=use_json_field"> wagtail - Wagtail 3.0 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/3.0.html?highlight=use_json_field#use-json-field-argument-added-to-streamfield"> <span>use_json_field</span> argument added to StreamField </a> </p> <p class="fragment"> ... All uses of StreamField should be updated to include the argument <span>use_json_field</span>=True. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=use_json_field"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=use_json_field#streamfield-block-reference"> StreamField block reference </a> </p> <p class="fragment"> ... Changed in version 3.0: The required <span>use_json_field</span> argument is added. body = StreamField([ ('heading ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=use_json_field#structural-block-types"> Structural block types </a> </p> <p class="fragment"> ... HomePage(Page): carousel = StreamField( CarouselBlock(max_num=10, block_counts={'video': {'max_num': 2}}), <span>use_json_field</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=use_json_field#wagtail.blocks.ListBlock"> [py:class]: wagtail.blocks.ListBlock </a> </p> <p class="fragment"> ('ingredients_list', blocks.ListBlock(blocks.CharBlock(label="Ingredient"))), ], <span>use_json_field</span>=True) </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=use_json_field#wagtail.blocks.ListBlock"> [py:class]: wagtail.blocks.list_block.ListBlock </a> </p> <p class="fragment"> ('ingredients_list', blocks.ListBlock(blocks.CharBlock(label="Ingredient"))), ], <span>use_json_field</span>=True) </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=use_json_field#wagtail.blocks.StreamBlock"> [py:class]: wagtail.blocks.StreamBlock </a> </p> <p class="fragment"> blocks.TextBlock()), ('author', blocks.CharBlock()), ])), ('video', EmbedBlock()), ], icon='cogs' )), ], <span>use_json_field</span> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=use_json_field"> wagtail - How to use StreamField for mixed content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=use_json_field#limiting-block-counts"> Limiting block counts </a> </p> <p class="fragment"> ... )), ('paragraph', blocks.RichTextBlock()), ('image', ImageChooserBlock()), ], min_num=2, max_num=5, <span>use_json_field</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=use_json_field#streamblock"> StreamBlock </a> </p> <p class="fragment"> ... form_classname="title")), ('paragraph', blocks.RichTextBlock()), ('image', ImageChooserBlock()), ], <span>use_json_field</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=use_json_field#using-streamfield"> Using StreamField </a> </p> <p class="fragment"> ... Changed in version 3.0: The <span>use_json_field</span>=True argument was added. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/streamfield_migrations.html?highlight=use_json_field"> wagtail - StreamField migrations </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/streamfield_migrations.html?highlight=use_json_field#migrating-richtextfields-to-streamfield"> Migrating RichTextFields to StreamField </a> </p> <p class="fragment"> ... To migrate, set the <span>use_json_field</span> argument to False first, migrate the data, then set it back to True ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/boundblocks_and_values.html?highlight=use_json_field"> wagtail - About StreamField BoundBlocks and values </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/boundblocks_and_values.html?highlight=use_json_field#about-streamfield-boundblocks-and-values"> About StreamField BoundBlocks and values </a> </p> <p class="fragment"> ... ('heading', HeadingBlock()), # ... ], <span>use_json_field</span>=True) {% load wagtailcore_tags %} {% for block in ... </p> <p></p> </li>`, | |
| 'video': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=video"> wagtail - Embedded content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=video#wagtail.embeds.models.Embed.type"> [py:attribute]: wagtail.embeds.models.Embed.type </a> </p> <p class="fragment"> This can be either ‘<span>video</span>’, ‘photo’, ‘link’ or ‘rich’. </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=video#how-wagtail-uses-multiple-finders"> How Wagtail uses multiple finders </a> </p> <p class="fragment"> ... If multiple providers can handle a URL (for example, a YouTube <span>video</span> was requested using the configuration ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=video#embed-tag"> {% embed %} tag </a> </p> <p class="fragment"> ... . {% load wagtailembeds_tags %} {# Embed a YouTube <span>video</span> #} {% embed 'https://www.youtube.com/watch? ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=video#embed-ly"> Embed.ly </a> </p> <p class="fragment"> ... They also provide some helpful features such as giving embeds a consistent look and a common <span>video</span> playback ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=video"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=video#wagtail.blocks.StreamBlock"> [py:class]: wagtail.blocks.StreamBlock </a> </p> <p class="fragment"> quotation', blocks.StructBlock([ ('text', blocks.TextBlock()), ('author', blocks.CharBlock()), ])), ('<span>video</span> </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=video#wagtail.blocks.StreamBlock"> [py:class]: wagtail.blocks.stream_block.StreamBlock </a> </p> <p class="fragment"> quotation', blocks.StructBlock([ ('text', blocks.TextBlock()), ('author', blocks.CharBlock()), ])), ('<span>video</span> </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=video#structural-block-types"> Structural block types </a> </p> <p class="fragment"> ... definitions: class HomePage(Page): carousel = StreamField( CarouselBlock(max_num=10, block_counts={'<span>video</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=video#wagtail.embeds.blocks.EmbedBlock"> [py:class]: wagtail.embeds.blocks.EmbedBlock </a> </p> <p class="fragment"> Bases: URLBlock A field for the editor to enter a URL to a media item (such as a YouTube <span>video</span>) to appear </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=video"> wagtail - Using forms in admin views </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=video#defining-admin-form-widgets"> Defining admin form widgets </a> </p> <p class="fragment"> ... that WagtailAdminModelForm selects VideoChooser as the form widget for any foreign keys pointing to <span>Video</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/privacy.html?highlight=video"> wagtail - Private pages </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/privacy.html?highlight=video#setting-a-password-required-page-for-a-specific-page-type"> Setting a “password required” page for a specific page type </a> </p> <p class="fragment"> ... : ... password_required_template = '<span>video</span>/password_required.html' ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.0.html?highlight=video"> wagtail - Wagtail 1.0 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.0.html?highlight=video#streamfield-a-field-type-for-freeform-content"> StreamField - a field type for freeform content </a> </p> <p class="fragment"> ... such as blog posts and news stories, allowing diverse content types such as text, images, headings, <span>video</span> ... </p> <p></p> </li>`, | |
| 'wagtail.core.apps': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/contributing/documentation_guidelines.html?highlight=wagtail.core.apps"> wagtail - Documentation guidelines </a> </p><p> <a href="https://docs.wagtail.org/en/stable/contributing/documentation_guidelines.html?highlight=wagtail.core.apps#module-wagtail.coreutils"> [py:module]: <span>wagtail</span>.coreutils </a> </p> <p class="fragment"> </p> <p> <a href="https://docs.wagtail.org/en/stable/contributing/documentation_guidelines.html?highlight=wagtail.core.apps#wagtail.coreutils.cautious_slugify"> [py:function]: <span>wagtail</span>.coreutils.cautious_slugify </a> </p> <p class="fragment"> Convert a string to ASCII exactly as Django’s slugify does, with the exception that any non-ASCII al ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=wagtail.core.apps"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=wagtail.core.apps#wagtail.blocks.BlockQuoteBlock"> [py:class]: <span>wagtail</span>.blocks.BlockQuoteBlock </a> </p> <p class="fragment"> Bases: TextBlock A text field, the contents of which will be wrapped in an HTML <blockquote> tag pai ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=wagtail.core.apps#wagtail.blocks.BooleanBlock"> [py:class]: <span>wagtail</span>.blocks.BooleanBlock </a> </p> <p class="fragment"> Bases: FieldBlock A checkbox. The following keyword arguments are accepted in addition to the standa ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=wagtail.core.apps#wagtail.blocks.CharBlock"> [py:class]: <span>wagtail</span>.blocks.CharBlock </a> </p> <p class="fragment"> Bases: FieldBlock A single-line text input. The following keyword arguments are accepted in addition ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=wagtail.core.apps"> wagtail - Customising the editing interface </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=wagtail.core.apps#wagtail.admin.forms.WagtailAdminModelForm"> [py:class]: <span>wagtail</span>.admin.forms.WagtailAdminModelForm </a> </p> <p class="fragment"> </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=wagtail.core.apps#wagtail.admin.forms.WagtailAdminPageForm"> [py:class]: <span>wagtail</span>.admin.forms.WagtailAdminPageForm </a> </p> <p class="fragment"> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/legacy_richtext.html?highlight=wagtail.core.apps"> wagtail - Legacy richtext </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/legacy_richtext.html?highlight=wagtail.core.apps#module-wagtail.contrib.legacy.richtext"> [py:module]: <span>wagtail</span>.contrib.legacy.richtext </a> </p> <p class="fragment"> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/searchpromotions.html?highlight=wagtail.core.apps"> wagtail - Promoted search results </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/searchpromotions.html?highlight=wagtail.core.apps#module-wagtail.contrib.search_promotions"> [py:module]: <span>wagtail</span>.contrib.search_promotions </a> </p> <p class="fragment"> </p> <p></p> </li>`, | |
| 'wagtailadmin_base_url': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/settings.html?highlight=wagtailadmin_base_url"> wagtail - Settings </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/settings.html?highlight=wagtailadmin_base_url#wagtailadmin-base-url"> <span>WAGTAILADMIN_BASE_URL</span> </a> </p> <p class="fragment"> ... <span>WAGTAILADMIN_BASE_URL</span> = 'http://example.com' This is the base URL used by the Wagtail admin site. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/3.0.html?highlight=wagtailadmin_base_url"> wagtail - Wagtail 3.0 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/3.0.html?highlight=wagtailadmin_base_url#base-url-setting-renamed-to-wagtailadmin-base-url"> BASE_URL setting renamed to <span>WAGTAILADMIN_BASE_URL</span> </a> </p> <p class="fragment"> ... References to BASE_URL in your settings should be updated to <span>WAGTAILADMIN_BASE_URL</span>. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/3.0.html?highlight=wagtailadmin_base_url#other-features"> Other features </a> </p> <p class="fragment"> ... how to use ModelAdmin to manage Tags (Abdulmajeed Isa) Rename the setting BASE_URL (undocumented) to <span>WAGTAILADMIN_BASE_URL</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/3.0.1.html?highlight=wagtailadmin_base_url"> wagtail - Wagtail 3.0.1 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/3.0.1.html?highlight=wagtailadmin_base_url#other-features"> Other features </a> </p> <p class="fragment"> ... Add warning when <span>WAGTAILADMIN_BASE_URL</span> is not configured (Matt Westcott) ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/3.0.1.html?highlight=wagtailadmin_base_url#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... when the initial editor did not have publish permission (Matt Westcott) Stop emails from breaking when <span>WAGTAILADMIN_BASE_URL</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/images.html?highlight=wagtailadmin_base_url"> wagtail - How to use images in templates </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/images.html?highlight=wagtailadmin_base_url#full-url"> full_url </a> </p> <p class="fragment"> ... This requires <span>WAGTAILADMIN_BASE_URL</span> to be set in the project settings. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=wagtailadmin_base_url"> wagtail - Embedded content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=wagtailadmin_base_url#wagtail.embeds.models.Embed.url"> [py:attribute]: wagtail.embeds.models.Embed.<span>url</span> </a> </p> <p class="fragment"> (text) The URL of the original content of this embed. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/embeds.html?highlight=wagtailadmin_base_url#wagtail.embeds.models.Embed.thumbnail_url"> [py:attribute]: wagtail.embeds.models.Embed.thumbnail_<span>url</span> </a> </p> <p class="fragment"> (text) a URL to a thumbnail image of the content that is being embedded. ... </p> <p></p> </li>`, | |
| 'pageurl': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/jinja2.html?highlight=pageurl"> wagtail - Jinja2 template support </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/jinja2.html?highlight=pageurl#pageurl"> <span>pageurl</span>() </a> </p> <p class="fragment"> ... </a> See <span>pageurl</span> for more information ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/writing_templates.html?highlight=pageurl"> wagtail - Writing templates </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/writing_templates.html?highlight=pageurl#pageurl"> <span>pageurl</span> </a> </p> <p class="fragment"> ... <a href="{% <span>pageurl</span> page.get_parent %}">Back to index</a> A fallback keyword argument can be provided ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/writing_templates.html?highlight=pageurl#fullpageurl"> fullpageurl </a> </p> <p class="fragment"> ... <meta property="og:url" content="{% fullpageurl page %}" /> Much like <span>pageurl</span>, a fallback keyword argument ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/writing_templates.html?highlight=pageurl#slugurl"> slugurl </a> </p> <p class="fragment"> ... Like <span>pageurl</span>, this will try to provide a relative link if possible, but will default to an absolute link ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=pageurl"> wagtail - RoutablePageMixin </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=pageurl#wagtail.contrib.routable_page.templatetags.wagtailroutablepage_tags.routablepageurl"> [py:function]: wagtail.contrib.routable_page.templatetags.wagtailroutablepage_tags.routablepageurl </a> </p> <p class="fragment"> routablepageurl is similar to <span>pageurl</span>, but works with pages using RoutablePageMixin. </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/settings.html?highlight=pageurl"> wagtail - Settings </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/settings.html?highlight=pageurl#utilising-the-page-url-setting-shortcut"> Utilising the page_url setting shortcut </a> </p> <p class="fragment"> ... page_url shortcut, there are a couple of points worth noting: The same limitations that apply to the {% <span>pageurl</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/settings.html?highlight=pageurl#utilising-select-related-to-improve-efficiency"> Utilising select_related to improve efficiency </a> </p> <p class="fragment"> ... three (one to fetch the settings, and two more to fetch each page): {% load wagtailcore_tags %} {% <span>pageurl</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/0.4.html?highlight=pageurl"> wagtail - Wagtail 0.4 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/0.4.html?highlight=pageurl#template-tag-libraries-renamed"> Template tag libraries renamed </a> </p> <p class="fragment"> ... The following template tag libraries have been renamed: <span>pageurl</span> => wagtailcore_tags rich_text => wagtailcore_tags ... </p> <p></p> </li>`, | |
| 'ChoiceBlock': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=ChoiceBlock"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=ChoiceBlock#wagtail.blocks.ChoiceBlock"> [py:class]: wagtail.blocks.<span>ChoiceBlock</span> </a> </p> <p class="fragment"> <span>ChoiceBlock</span> can also be subclassed to produce a reusable block with the same list of choices everywhere </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=ChoiceBlock#wagtail.blocks.ChoiceBlock"> [py:class]: wagtail.blocks.field_block.<span>ChoiceBlock</span> </a> </p> <p class="fragment"> <span>ChoiceBlock</span> can also be subclassed to produce a reusable block with the same list of choices everywhere </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=ChoiceBlock"> wagtail - How to build custom StreamField blocks </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=ChoiceBlock#handling-block-definitions-within-migrations"> Handling block definitions within migrations </a> </p> <p class="fragment"> ... To mitigate this, StructBlock, StreamBlock and <span>ChoiceBlock</span> implement additional logic to ensure that ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=ChoiceBlock#additional-javascript-on-structblock-forms"> Additional JavaScript on StructBlock forms </a> </p> <p class="fragment"> ... AddressBlock(StructBlock): street = CharBlock() town = CharBlock() state = CharBlock(required=False) country = <span>ChoiceBlock</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.9.html?highlight=ChoiceBlock"> wagtail - Wagtail 1.9 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.9.html?highlight=ChoiceBlock#other-features"> Other features </a> </p> <p class="fragment"> ... Bratfisch) View live / draft links in the admin now consistently open in a new window (Marco Fucci) <span>ChoiceBlock</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/typed_table_block.html?highlight=ChoiceBlock"> wagtail - Typed table block </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/typed_table_block.html?highlight=ChoiceBlock#usage"> Usage </a> </p> <p class="fragment"> ... blocks.FloatBlock()), ('rich_text', blocks.RichTextBlock()), ('image', ImageChooserBlock()), ('country', <span>ChoiceBlock</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.9.html?highlight=ChoiceBlock"> wagtail - Wagtail 2.9 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.9.html?highlight=ChoiceBlock#other-features"> Other features </a> </p> <p class="fragment"> ... unpublishing a page (Samir Shah) Added MultipleChoiceBlock block type for StreamField (James O’Toole) <span>ChoiceBlock</span> ... </p> <p></p> </li>`, | |
| 'ImageChooserBlock': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=ImageChooserBlock"> wagtail - StreamField block reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=ImageChooserBlock#wagtail.images.blocks.ImageChooserBlock"> [py:class]: wagtail.images.blocks.<span>ImageChooserBlock</span> </a> </p> <p class="fragment"> Bases: ChooserBlock A control to allow the editor to select an existing image, or upload a new one. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=ImageChooserBlock#streamfield-block-reference"> StreamField block reference </a> </p> <p class="fragment"> ... heading', blocks.CharBlock(form_classname="title")), ('paragraph', blocks.RichTextBlock()), ('image', <span>ImageChooserBlock</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=ImageChooserBlock#wagtail.blocks.StreamBlock"> [py:class]: wagtail.blocks.StreamBlock </a> </p> <p class="fragment"> ('carousel', blocks.StreamBlock( [ ('image', <span>ImageChooserBlock</span>()), ('quotation', blocks.StructBlock([ </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/streamfield/blocks.html?highlight=ImageChooserBlock#wagtail.blocks.StreamBlock"> [py:class]: wagtail.blocks.stream_block.StreamBlock </a> </p> <p class="fragment"> ('carousel', blocks.StreamBlock( [ ('image', <span>ImageChooserBlock</span>()), ('quotation', blocks.StructBlock([ </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/typed_table_block.html?highlight=ImageChooserBlock"> wagtail - Typed table block </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/typed_table_block.html?highlight=ImageChooserBlock#usage"> Usage </a> </p> <p class="fragment"> ... blocks.CharBlock()), ('numeric', blocks.FloatBlock()), ('rich_text', blocks.RichTextBlock()), ('image', <span>ImageChooserBlock</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=ImageChooserBlock"> wagtail - How to use StreamField for mixed content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=ImageChooserBlock#limiting-block-counts"> Limiting block counts </a> </p> <p class="fragment"> ... heading', blocks.CharBlock(form_classname="title")), ('paragraph', blocks.RichTextBlock()), ('image', <span>ImageChooserBlock</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=ImageChooserBlock#block-icons"> Block icons </a> </p> <p class="fragment"> ... blocks.StructBlock([ ('first_name', blocks.CharBlock()), ('surname', blocks.CharBlock()), ('photo', <span>ImageChooserBlock</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=ImageChooserBlock#streamblock"> StreamBlock </a> </p> <p class="fragment"> ... slides could be defined as follows: body = StreamField([ ('carousel', blocks.StreamBlock([ ('image', <span>ImageChooserBlock</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=ImageChooserBlock"> wagtail - How to build custom StreamField blocks </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/streamfield_blocks.html?highlight=ImageChooserBlock#custom-editing-interfaces-for-structblock"> Custom editing interfaces for StructBlock </a> </p> <p class="fragment"> ... PersonBlock(blocks.StructBlock): first_name = blocks.CharBlock() surname = blocks.CharBlock() photo = <span>ImageChooserBlock</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.3.html?highlight=ImageChooserBlock"> wagtail - Wagtail 1.3 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.3.html?highlight=ImageChooserBlock#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... Restored correct highlighting behaviour of rich text toolbar buttons Rendering a missing image through <span>ImageChooserBlock</span> ... </p> <p></p> </li>`, | |
| 'modeladmin_register': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=modeladmin_register"> wagtail - ModelAdmin </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=modeladmin_register#registering-multiple-classes-in-one-wagtail-hooks-py-file"> Registering multiple classes in one wagtail_hooks.py file </a> </p> <p class="fragment"> ... (BookAdmin) <span>modeladmin_register</span>(MovieAdmin) <span>modeladmin_register</span>(MusicAdminGroup) ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=modeladmin_register#a-simple-example"> A simple example </a> </p> <p class="fragment"> ... = ('title', 'author') # Now you just need to register your customised ModelAdmin class with Wagtail <span>modeladmin_register</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/index.html?highlight=modeladmin_register#a-more-complicated-example"> A more complicated example </a> </p> <p class="fragment"> ... something like this: from wagtail.contrib.modeladmin.options import ( ModelAdmin, ModelAdminGroup, <span>modeladmin_register</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/primer.html?highlight=modeladmin_register"> wagtail - modeladmin customisation primer </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/primer.html?highlight=modeladmin_register#modeladmin-permission-helper-class"> ModelAdmin.permission_helper_class </a> </p> <p class="fragment"> ... ): ... class MyModelAdmin(ModelAdmin): model = MyModel permission_helper_class = MyPermissionHelper <span>modeladmin_register</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/primer.html?highlight=modeladmin_register#modeladmin-url-helper-class"> ModelAdmin.url_helper_class </a> </p> <p class="fragment"> ... AdminURLHelper): ... class MyModelAdmin(ModelAdmin): model = MyModel url_helper_class = MyURLHelper <span>modeladmin_register</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/primer.html?highlight=modeladmin_register#modeladmin-button-helper-class"> ModelAdmin.button_helper_class </a> </p> <p class="fragment"> ... wagtail.contrib.modeladmin.helpers import ButtonHelper from wagtail.contrib.modeladmin.options import ModelAdmin, <span>modeladmin_register</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/menu_item.html?highlight=modeladmin_register"> wagtail - Customising the menu item </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/menu_item.html?highlight=modeladmin_register#modeladmin-add-to-settings-menu"> ModelAdmin.add_to_settings_menu </a> </p> <p class="fragment"> ... This will only work for individual ModelAdmin classes registered with their own <span>modeladmin_register</span> call ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_recipes.html?highlight=modeladmin_register"> wagtail - Recipes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_recipes.html?highlight=modeladmin_register#managing-tags-with-wagtail-s-modeladmin"> Managing tags with Wagtail’s ModelAdmin </a> </p> <p class="fragment"> ... put in 3rd place (000 being 1st, 100 2nd) list_display = ["name", "slug"] search_fields = ("name",) <span>modeladmin_register</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=modeladmin_register"> wagtail - Reversing ModelAdmin URLs </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/reversing_urls.html?highlight=modeladmin_register#getting-the-edit-or-delete-or-inspect-url-for-an-object"> Getting the edit or delete or inspect URL for an object </a> </p> <p class="fragment"> ... wagtail.admin.widgets import PageListingButton from wagtail.contrib.modeladmin.options import ModelAdmin, <span>modeladmin_register</span> ... </p> <p></p> </li>`, | |
| 'TabbedInterface': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=TabbedInterface"> wagtail - Customising the editing interface </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=TabbedInterface#customising-the-tabbed-interface"> Customising the tabbed interface </a> </p> <p class="fragment"> ... For example: from wagtail.admin.panels import <span>TabbedInterface</span>, ObjectList class BlogPage(Page): # field ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/settings.html?highlight=TabbedInterface"> wagtail - Settings </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/settings.html?highlight=TabbedInterface#edit-handlers"> Edit handlers </a> </p> <p class="fragment"> ... you would do for Page model with a custom edit_handler attribute: from wagtail.admin.panels import <span>TabbedInterface</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/3.0.1.html?highlight=TabbedInterface"> wagtail - Wagtail 3.0.1 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/3.0.1.html?highlight=TabbedInterface#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... Ensure <span>TabbedInterface</span> will not show a tab if no panels are visible due to permissions (Paarth Agarwal ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/create_edit_delete_views.html?highlight=TabbedInterface"> wagtail - Customising CreateView, EditView and DeleteView </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/create_edit_delete_views.html?highlight=TabbedInterface#changing-which-fields-appear-in-createview-editview"> Changing which fields appear in CreateView & EditView </a> </p> <p class="fragment"> ... ('address', classname='custom1',) ]) ] edit_handler = ObjectList(custom_panels) # or edit_handler = <span>TabbedInterface</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=TabbedInterface"> wagtail - Using forms in admin views </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=TabbedInterface#panels"> Panels </a> </p> <p class="fragment"> ... A single panel object (usually ObjectList or <span>TabbedInterface</span>) exists at the top level and is the only ... </p> <p></p> </li>`, | |
| 'ClusterableModel': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/4.1.3.html?highlight=ClusterableModel"> wagtail - Wagtail 4.1.3 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/4.1.3.html?highlight=ClusterableModel#documentation"> Documentation </a> </p> <p class="fragment"> ... Docs: Clarify <span>ClusterableModel</span> requirements for using relations with RevisionMixin-enabled models (Sage ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/4.2.1.html?highlight=ClusterableModel"> wagtail - Wagtail 4.2.1 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/4.2.1.html?highlight=ClusterableModel#documentation"> Documentation </a> </p> <p class="fragment"> ... Docs: Clarify <span>ClusterableModel</span> requirements for using relations with RevisionMixin-enabled models (Sage ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.11.6.html?highlight=ClusterableModel"> wagtail - Wagtail 2.11.6 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.11.6.html?highlight=ClusterableModel#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... on page editing after changing LANGUAGE_CODE (Matt Westcott) Correctly handle model inheritance and <span>ClusterableModel</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.12.3.html?highlight=ClusterableModel"> wagtail - Wagtail 2.12.3 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.12.3.html?highlight=ClusterableModel#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... on page editing after changing LANGUAGE_CODE (Matt Westcott) Correctly handle model inheritance and <span>ClusterableModel</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/snippets.html?highlight=ClusterableModel"> wagtail - Snippets </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/snippets.html?highlight=ClusterableModel#tagging-snippets"> Tagging snippets </a> </p> <p class="fragment"> ... ClusterTaggableManager. from modelcluster.fields import ParentalKey from modelcluster.models import <span>ClusterableModel</span> ... </p> <p> <a href="https://docs.wagtail.org/en/stable/topics/snippets.html?highlight=ClusterableModel#saving-revisions-of-snippets"> Saving revisions of snippets </a> </p> <p class="fragment"> ... from modelcluster.fields import ParentalKey, ParentalManyToManyField from modelcluster.models import <span>ClusterableModel</span> ... </p> <p></p> </li>`, | |
| 'RoutablePageMixin': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=RoutablePageMixin"> wagtail - <span>RoutablePageMixin</span> </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=RoutablePageMixin#module-wagtail.contrib.routable_page"> <span>RoutablePageMixin</span> </a> </p> <p class="fragment"> ... The <span>RoutablePageMixin</span> mixin provides a convenient way for a page to respond on multiple sub-URLs with ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=RoutablePageMixin#module-wagtail.contrib.routable_page.models"> The <span>RoutablePageMixin</span> class </a> </p> <p class="fragment"> Example: url = page.url + page.reverse_subpage('events_for_year', kwargs={'year': '2014'}) ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=RoutablePageMixin#wagtail.contrib.routable_page.models.RoutablePageMixin.render"> [py:method]: wagtail.contrib.routable_page.models.<span>RoutablePageMixin</span>.render </a> </p> <p class="fragment"> This method replicates what Page.serve() usually does when <span>RoutablePageMixin</span> is not used. </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=RoutablePageMixin#changing-route-names"> Changing route names </a> </p> <p class="fragment"> ... , re_path class EventPage(<span>RoutablePageMixin</span>, Page): ... ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=RoutablePageMixin#wagtail.contrib.routable_page.models.RoutablePageMixin"> [py:class]: wagtail.contrib.routable_page.models.<span>RoutablePageMixin</span> </a> </p> <p class="fragment"> This class can be mixed in to a Page model, allowing extra routes to be added to it. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/routablepage.html?highlight=RoutablePageMixin#wagtail.contrib.routable_page.models.RoutablePageMixin.resolve_subpage"> [py:method]: wagtail.contrib.routable_page.models.<span>RoutablePageMixin</span>.resolve_subpage </a> </p> <p class="fragment"> This method takes a URL path and finds the view to call. Example: view, args, kwargs = page.resolve_ ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/index.html?highlight=RoutablePageMixin"> wagtail - Contrib modules </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/index.html?highlight=RoutablePageMixin#id5"> <span>RoutablePageMixin</span> </a> </p> <p class="fragment"> Provides a way of embedding Django URLconfs into pages. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.12.html?highlight=RoutablePageMixin"> wagtail - Wagtail 1.12 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.12.html?highlight=RoutablePageMixin#routablepagemixin-now-has-a-default-index-route"> <span>RoutablePageMixin</span> now has a default index route </a> </p> <p class="fragment"> ... If you’ve used <span>RoutablePageMixin</span> on a Page model, you may have had to manually define an index route ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/1.12.html?highlight=RoutablePageMixin#other-features"> Other features </a> </p> <p class="fragment"> ... The admin interface now displays a title of the latest draft (Mikalai Radchuk) <span>RoutablePageMixin</span> now ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.0.html?highlight=RoutablePageMixin"> wagtail - Wagtail 1.0 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.0.html?highlight=RoutablePageMixin#routablepage-now-uses-decorator-syntax-for-defining-views"> RoutablePage now uses decorator syntax for defining views </a> </p> <p class="fragment"> ... In previous versions of Wagtail, page types that used the <span>RoutablePageMixin</span> had endpoints configured ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/0.5.html?highlight=RoutablePageMixin"> wagtail - Wagtail 0.5 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/0.5.html?highlight=RoutablePageMixin#routablepage"> RoutablePage </a> </p> <p class="fragment"> ... <span>RoutablePageMixin</span> ... </p> <p></p> </li>`, | |
| 'postgres': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/contributing/developing.html?highlight=postgres"> wagtail - Development </a> </p><p> <a href="https://docs.wagtail.org/en/stable/contributing/developing.html?highlight=postgres#testing-against-postgresql"> Testing against PostgreSQL </a> </p> <p class="fragment"> ... You can switch to using PostgreSQL by using the --<span>postgres</span> argument: python runtests.py --<span>postgres</span> If ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.12.3.html?highlight=postgres"> wagtail - Wagtail 1.12.3 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.12.3.html?highlight=postgres#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... crash in XML sitemap generator when all pages on the site are private (Stein Strindhaug) Fixed error in <span>Postgres</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.6.2.html?highlight=postgres"> wagtail - Wagtail 2.6.2 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.6.2.html?highlight=postgres#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... Prevent search indexing failures on <span>Postgres</span> 9.4 and Django >= 2.2.1 (Matt Westcott) ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.13.1.html?highlight=postgres"> wagtail - Wagtail 1.13.1 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.13.1.html?highlight=postgres#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... incorrect z-index on userbar causing it to appear behind page content (Stein Strindhaug) Fixed error in <span>Postgres</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.3.1.html?highlight=postgres"> wagtail - Wagtail 1.3.1 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.3.1.html?highlight=postgres#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... Applied workaround for failing wagtailimages migration on Django 1.8.8 / 1.9.1 with <span>Postgres</span> (see Django ... </p> <p></p> </li>`, | |
| 'get_children': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/getting_started/tutorial.html?highlight=get_children"> wagtail - Your first Wagtail site </a> </p><p> <a href="https://docs.wagtail.org/en/stable/getting_started/tutorial.html?highlight=get_children#parents-and-children"> Parents and Children </a> </p> <p class="fragment"> ... This has to do with the way we defined our model: class BlogPage(Page): The <span>get_children</span>() method gets ... </p> <p> <a href="https://docs.wagtail.org/en/stable/getting_started/tutorial.html?highlight=get_children#blog-index-and-posts"> Blog Index and Posts </a> </p> <p class="fragment"> ... post.specific.body|richtext }} {% endfor %} {% endblock %} Most of this should be familiar, but we’ll explain <span>get_children</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=get_children"> wagtail - Panel types </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=get_children#wagtail.admin.panels.FieldRowPanel.children"> [py:attribute]: wagtail.admin.panels.FieldRowPanel.<span>children</span> </a> </p> <p class="fragment"> A list or tuple of child panels to display on the row ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/panels.html?highlight=get_children#wagtail.admin.panels.MultiFieldPanel.children"> [py:attribute]: wagtail.admin.panels.MultiFieldPanel.<span>children</span> </a> </p> <p class="fragment"> A list or tuple of child panels ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/adding_reports.html?highlight=get_children"> wagtail - Adding reports </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/adding_reports.html?highlight=get_children#get_queryset"> [py:method]: <span>get</span>_queryset </a> </p> <p class="fragment"> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=get_children"> wagtail - Rich text internals </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=get_children#LinkHandler.get_instance"> [py:method]: LinkHandler.<span>get</span>_instance </a> </p> <p class="fragment"> Optional. The static or classmethod get_instance method also only applies to those handlers that are ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=get_children#LinkHandler.get_model"> [py:method]: LinkHandler.<span>get</span>_model </a> </p> <p class="fragment"> Optional. The static get_model method only applies to those handlers that are used to render content ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/rich_text_internals.html?highlight=get_children#FeatureRegistry.get_converter_rule"> [py:method]: FeatureRegistry.<span>get</span>_converter_rule </a> </p> <p class="fragment"> </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/documents/custom_document_model.html?highlight=get_children"> wagtail - Custom document model </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/documents/custom_document_model.html?highlight=get_children#wagtail.documents.get_document_model"> [py:function]: wagtail.documents.<span>get</span>_document_model </a> </p> <p class="fragment"> Get the document model from the WAGTAILDOCS_DOCUMENT_MODEL setting. Defaults to the standard Documen ... </p> <p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/documents/custom_document_model.html?highlight=get_children#wagtail.documents.get_document_model_string"> [py:function]: wagtail.documents.<span>get</span>_document_model_string </a> </p> <p class="fragment"> Get the dotted app.Model name for the document model as a string. Useful for developers making Wagta ... </p> <p></p> </li>`, | |
| 'icons': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=icons"> wagtail - How to use StreamField for mixed content </a> </p><p> <a href="https://docs.wagtail.org/en/stable/topics/streamfield.html?highlight=icons#block-icons"> Block <span>icons</span> </a> </p> <p class="fragment"> In the menu that content authors use to add new blocks to a StreamField, each block type has an asso ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.13.html?highlight=icons"> wagtail - Wagtail 2.13 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.13.html?highlight=icons#switched-register-setting-register-settings-menu-item-to-use-svg-icons"> Switched register_setting, register_settings_menu_item to use SVG <span>icons</span> </a> </p> <p class="fragment"> ... Setting menu items now use SVG <span>icons</span> by default. ... </p> <p> <a href="https://docs.wagtail.org/en/stable/releases/2.13.html?highlight=icons#other-features"> Other features </a> </p> <p class="fragment"> ... single database query (Andy Babic) Switched register_setting, register_settings_menu_item to use SVG <span>icons</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.10.html?highlight=icons"> wagtail - Wagtail 2.10 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.10.html?highlight=icons#accessibility-and-usability"> Accessibility and usability </a> </p> <p class="fragment"> ... on small devices, so that content is not blocked and more easily editable (Saeed Tahmasebi) Add SVG <span>icons</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/1.4.1.html?highlight=icons"> wagtail - Wagtail 1.4.1 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/1.4.1.html?highlight=icons#bug-fixes"> Bug fixes </a> </p> <p class="fragment"> ... Fixed erroneous rendering of up arrow <span>icons</span> (Rob Moorman) ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/contributing/ui_guidelines.html?highlight=icons"> wagtail - UI Guidelines </a> </p><p> <a href="https://docs.wagtail.org/en/stable/contributing/ui_guidelines.html?highlight=icons#ui-guidelines"> UI Guidelines </a> </p> <p class="fragment"> ... with: HTML using Django templates CSS using Sass and Tailwind JavaScript with TypeScript SVG for our <span>icons</span> ... </p> <p></p> </li>`, | |
| 'image_url': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/image_serve_view.html?highlight=image_url"> wagtail - Dynamic image serve view </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/images/image_serve_view.html?highlight=image_url#generating-dynamic-image-urls-in-python"> Generating dynamic image URLs in Python </a> </p> <p class="fragment"> ... -- Get the url for the image scaled to a width of 400 pixels: --> {% <span>image_url</span> page.photo "width-400" ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=image_url"> wagtail - Performance </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/performance.html?highlight=image_url#image-urls"> Image URLs </a> </p> <p class="fragment"> ... %} tag: <meta property="og:image" content="{% <span>image_url</span> page.hero_image width-600 %}" /> Rather than ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/2.4.html?highlight=image_url"> wagtail - Wagtail 2.4 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/2.4.html?highlight=image_url#other-features"> Other features </a> </p> <p class="fragment"> ... and image choosers now show the document / image’s collection (Alejandro Garza, Janneke Janssen) New <span>image_url</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/releases/4.1.html?highlight=image_url"> wagtail - Wagtail 4.1 release notes </a> </p><p> <a href="https://docs.wagtail.org/en/stable/releases/4.1.html?highlight=image_url#other-features"> Other features </a> </p> <p class="fragment"> ... aimed at developers who are very new to Python and have no Django experience (Damilola Oladele) The <span>image_url</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=image_url"> wagtail - Model Reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=image_url#wagtail.models.Page.full_url"> [py:attribute]: wagtail.models.Page.full_<span>url</span> </a> </p> <p class="fragment"> Return the full URL (including protocol / domain) to this page, or None if it is not routable ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=image_url#wagtail.models.Site.root_url"> [py:attribute]: wagtail.models.Site.root_<span>url</span> </a> </p> <p class="fragment"> This returns the URL of the site. It is calculated from the hostname and the port fields. The scheme ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=image_url#wagtail.models.Page.get_url"> [py:method]: wagtail.models.Page.get_<span>url</span> </a> </p> <p class="fragment"> Return the ‘most appropriate’ URL for referring to this page from the pages we serve, within the Wag ... </p> <p></p> </li>`, | |
| 'base_form_class': `<li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/contributing/general_guidelines.html?highlight=base_form_class"> wagtail - General coding guidelines </a> </p><p> <a href="https://docs.wagtail.org/en/stable/contributing/general_guidelines.html?highlight=base_form_class#python-django-class-driven-content"> Python / Django class driven content </a> </p> <p class="fragment"> ... class Panel: def __init__(self, heading="", classname="", help_text="", <span>base_form_class</span>=None): self.heading ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/custom_clean.html?highlight=base_form_class"> wagtail - Adding a custom clean method to your ModelAdmin models </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/contrib/modeladmin/tips_and_tricks/custom_clean.html?highlight=base_form_class#adding-a-custom-clean-method-to-your-modeladmin-models"> Adding a custom clean method to your ModelAdmin models </a> </p> <p class="fragment"> ... self.add_error("image", "The image must be at least 1920x1080px") return cleaned_data And then set the <span>base_form_class</span> ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=base_form_class"> wagtail - Customising the editing interface </a> </p><p> <a href="https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html?highlight=base_form_class#customising-generated-forms"> Customising generated forms </a> </p> <p class="fragment"> ... A custom base form class can be configured by setting the <span>base_form_class</span> attribute on any model. ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=base_form_class"> wagtail - Using forms in admin views </a> </p><p> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=base_form_class#panels"> Panels </a> </p> <p class="fragment"> ... This proceeds as follows: Retrieve a base form class from the model’s <span>base_form_class</span> property, falling ... </p> <p> <a href="https://docs.wagtail.org/en/stable/extending/forms.html?highlight=base_form_class#register_form_field_override"> [py:function]: register_<span>form</span>_field_override </a> </p> <p class="fragment"> Specify a set of options that will override the form field’s defaults when WagtailAdminModelForm enc ... </p> <p></p> </li><li class="module-item search-result-item"> <p class="module-item-title"> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=base_form_class"> wagtail - Model Reference </a> </p><p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=base_form_class#wagtail.models.Page.base_form_class"> [py:attribute]: wagtail.models.Page.<span>base</span>_<span>form</span>_<span>class</span> </a> </p> <p class="fragment"> The form class used as a base for editing Pages of this type in the Wagtail page editor. This attrib ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=base_form_class#wagtail.models.Page.specific_class"> [py:attribute]: wagtail.models.Page.specific_<span>class</span> </a> </p> <p class="fragment"> Return the class that this page would be if instantiated in its most specific form. If the model cla ... </p> <p> <a href="https://docs.wagtail.org/en/stable/reference/pages/model_reference.html?highlight=base_form_class#wagtail.models.Task.get_form_for_action"> [py:method]: wagtail.models.Task.get_<span>form</span>_for_action </a> </p> <p class="fragment"> </p> <p></p> </li>`, | |
| } | |
| const main = document.querySelector('main'); | |
| const template = document.querySelector('#section-template'); | |
| terms.forEach(t => { | |
| const heading = document.createElement('h2'); | |
| const headingLink = document.createElement('a'); | |
| heading.id = t; | |
| heading.appendChild(headingLink); | |
| headingLink.textContent = t; | |
| headingLink.href = `#${encodeURIComponent(t)}`; | |
| main.appendChild(heading); | |
| main.appendChild(template.content.cloneNode(true)); | |
| const section = document.querySelector(`section[data-term="TEMPLATE"]`); | |
| section.dataset.term = t; | |
| section.querySelector('a').href = `https://readthedocs.org/search/?q=project%3Awagtail+${encodeURIComponent(t)}&type=file`; | |
| section.querySelector('ul').innerHTML = rtdResults[t]; | |
| docsearch({ | |
| appId: 'XSYGEO7KMJ', | |
| apiKey: 'd50a485660ed9280079aada4e09454b2', | |
| indexName: 'wagtail', | |
| inputSelector: `section[data-term="${t}"] [data-search="1"]`, | |
| algoliaOptions: { | |
| facetFilters: ['version:stable'], | |
| }, | |
| autocompleteOptions: { | |
| autoSelect: false | |
| }, | |
| debug: true, | |
| }) | |
| docsearch({ | |
| appId: 'XSYGEO7KMJ', | |
| apiKey: '9779c718cfb08178df32d1ca8380ad73', | |
| indexName: 'crawler_wagtail-code', | |
| inputSelector: `section[data-term="${t}"] [data-search="2"]`, | |
| algoliaOptions: { | |
| facetFilters: ['version:stable'], | |
| }, | |
| autocompleteOptions: { | |
| autoSelect: false | |
| }, | |
| debug: true, | |
| }) | |
| section.querySelectorAll('input').forEach(input => { | |
| input.value = t; | |
| input.dispatchEvent(new Event('input', { | |
| detail: { | |
| triggeredByAnotherField: true | |
| } | |
| })) | |
| }); | |
| }); | |
| </script> | |
| <style> | |
| .ds-dropdown-menu { | |
| position: static !important; | |
| } | |
| .module-item { | |
| margin-bottom: 0.125rem; | |
| border-bottom: 1px solid #d9d9d9; | |
| } | |
| .module-item p { | |
| margin: 0; | |
| font-size: 0.9em; | |
| } | |
| .module-item a { | |
| color: #02060c; | |
| font-weight: 700; | |
| text-decoration: none; | |
| } | |
| section > div > ul { | |
| list-style: none; | |
| padding: 0; | |
| } | |
| .fragment { | |
| color: #63676d; | |
| } | |
| .search-result-item span { | |
| box-shadow: inset 0 -2px 0 0 rgb(69 142 225 / 80%) | |
| } | |
| .search-result-item a span { | |
| background-color: #ee9; | |
| padding: 0 1px; | |
| margin: 0 1px; | |
| border-radius: 3px; | |
| box-shadow: none; | |
| } | |
| </style> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment