github.com/rpdict/ponzu@v0.10.1-0.20190226054626-477f29d6bf5e/docs/build/Interfaces/Editor/index.html (about) 1 2 <!DOCTYPE html> 3 <html lang="en" class="no-js"> 4 <head> 5 6 <meta charset="utf-8"> 7 <meta name="viewport" content="width=device-width,initial-scale=1"> 8 9 10 11 12 <link rel="shortcut icon" href="../../assets/images/favicon.png"> 13 14 <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.6.1"> 15 16 17 18 <title>Editor Package Interfaces</title> 19 20 21 22 <script src="../../assets/javascripts/modernizr-56ade86843.js"></script> 23 24 25 <link rel="stylesheet" href="../../assets/stylesheets/application-4d0d3f2fbf.css"> 26 27 <link rel="stylesheet" href="../../assets/stylesheets/application-f78e5cb881.palette.css"> 28 29 30 31 32 33 34 35 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono"> 36 <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> 37 38 <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"> 39 40 41 42 </head> 43 44 45 46 47 <body data-md-color-primary="grey" data-md-color-accent="light-blue"> 48 49 <svg class="md-svg"> 50 <defs> 51 52 53 <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg> 54 55 </defs> 56 </svg> 57 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer"> 58 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="search"> 59 <label class="md-overlay" data-md-component="overlay" for="drawer"></label> 60 61 <header class="md-header" data-md-component="header"> 62 <nav class="md-header-nav md-grid"> 63 <div class="md-flex"> 64 <div class="md-flex__cell md-flex__cell--shrink"> 65 66 <a href="../.." title="Ponzu" class="md-logo md-header-nav__button"> 67 <img src="../../images/logo.png" width="24" height="24"> 68 </a> 69 70 </div> 71 <div class="md-flex__cell md-flex__cell--shrink"> 72 <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label> 73 </div> 74 <div class="md-flex__cell md-flex__cell--stretch"> 75 <span class="md-flex__ellipsis md-header-nav__title"> 76 77 78 79 <span class="md-header-nav__parent"> 80 Interfaces 81 </span> 82 83 84 Editor 85 86 </span> 87 </div> 88 <div class="md-flex__cell md-flex__cell--shrink"> 89 90 <label class="md-icon md-icon--search md-header-nav__button" for="search"></label> 91 92 <div class="md-search" data-md-component="search"> 93 <label class="md-search__overlay" for="search"></label> 94 <div class="md-search__inner"> 95 <form class="md-search__form" name="search"> 96 <input type="text" class="md-search__input" name="query" required placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query"> 97 <label class="md-icon md-search__icon" for="search"></label> 98 <button type="reset" class="md-icon md-search__icon" data-md-component="reset">close</button> 99 </form> 100 <div class="md-search__output"> 101 <div class="md-search__scrollwrap" data-md-scrollfix> 102 <div class="md-search-result" data-md-component="result"> 103 <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents"> 104 Type to start searching 105 </div> 106 <ol class="md-search-result__list"></ol> 107 </div> 108 </div> 109 </div> 110 </div> 111 </div> 112 113 </div> 114 <div class="md-flex__cell md-flex__cell--shrink"> 115 <div class="md-header-nav__source"> 116 117 118 119 120 121 122 123 <a href="https://github.com/rpdict/ponzu" title="Go to repository" class="md-source" data-md-source="github"> 124 125 <div class="md-source__icon"> 126 <svg viewBox="0 0 24 24" width="24" height="24"> 127 <use xlink:href="#github" width="24" height="24"></use> 128 </svg> 129 </div> 130 131 <div class="md-source__repository"> 132 ponzu-cms/ponzu 133 </div> 134 </a> 135 136 137 </div> 138 </div> 139 </div> 140 </nav> 141 </header> 142 143 <div class="md-container"> 144 145 146 <main class="md-main"> 147 <div class="md-main__inner md-grid" data-md-component="container"> 148 149 150 <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> 151 <div class="md-sidebar__scrollwrap"> 152 <div class="md-sidebar__inner"> 153 <nav class="md-nav md-nav--primary" data-md-level="0"> 154 <label class="md-nav__title md-nav__title--site" for="drawer"> 155 156 <i class="md-logo md-nav__button"> 157 <img src="../../images/logo.png"> 158 </i> 159 160 Ponzu 161 </label> 162 163 <div class="md-nav__source"> 164 165 166 167 168 169 170 <a href="https://github.com/rpdict/ponzu" title="Go to repository" class="md-source" data-md-source="github"> 171 172 <div class="md-source__icon"> 173 <svg viewBox="0 0 24 24" width="24" height="24"> 174 <use xlink:href="#github" width="24" height="24"></use> 175 </svg> 176 </div> 177 178 <div class="md-source__repository"> 179 ponzu-cms/ponzu 180 </div> 181 </a> 182 183 </div> 184 185 <ul class="md-nav__list" data-md-scrollfix> 186 187 188 189 190 191 192 <li class="md-nav__item"> 193 <a href="../.." title="Home" class="md-nav__link"> 194 Home 195 </a> 196 </li> 197 198 199 200 201 202 203 204 <li class="md-nav__item md-nav__item--nested"> 205 206 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2"> 207 208 <label class="md-nav__link" for="nav-2"> 209 CLI 210 </label> 211 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 212 <label class="md-nav__title" for="nav-2"> 213 CLI 214 </label> 215 <ul class="md-nav__list" data-md-scrollfix> 216 217 218 219 220 221 222 223 <li class="md-nav__item"> 224 <a href="../../CLI/General-Usage/" title="General Usage" class="md-nav__link"> 225 General Usage 226 </a> 227 </li> 228 229 230 231 232 233 234 235 <li class="md-nav__item"> 236 <a href="../../CLI/Generating-References/" title="Generating References" class="md-nav__link"> 237 Generating References 238 </a> 239 </li> 240 241 242 </ul> 243 </nav> 244 </li> 245 246 247 248 249 250 251 252 <li class="md-nav__item md-nav__item--nested"> 253 254 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> 255 256 <label class="md-nav__link" for="nav-3"> 257 Content 258 </label> 259 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 260 <label class="md-nav__title" for="nav-3"> 261 Content 262 </label> 263 <ul class="md-nav__list" data-md-scrollfix> 264 265 266 267 268 269 270 271 <li class="md-nav__item"> 272 <a href="../../Content/An-Overview/" title="An Overview" class="md-nav__link"> 273 An Overview 274 </a> 275 </li> 276 277 278 279 280 281 282 283 <li class="md-nav__item"> 284 <a href="../../Content/Extending-Content/" title="Extending Content" class="md-nav__link"> 285 Extending Content 286 </a> 287 </li> 288 289 290 </ul> 291 </nav> 292 </li> 293 294 295 296 297 298 299 300 <li class="md-nav__item md-nav__item--nested"> 301 302 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> 303 304 <label class="md-nav__link" for="nav-4"> 305 Form Fields 306 </label> 307 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 308 <label class="md-nav__title" for="nav-4"> 309 Form Fields 310 </label> 311 <ul class="md-nav__list" data-md-scrollfix> 312 313 314 315 316 317 318 319 <li class="md-nav__item"> 320 <a href="../../Form-Fields/HTML-Inputs/" title="HTML Inputs" class="md-nav__link"> 321 HTML Inputs 322 </a> 323 </li> 324 325 326 </ul> 327 </nav> 328 </li> 329 330 331 332 333 334 335 336 <li class="md-nav__item md-nav__item--nested"> 337 338 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> 339 340 <label class="md-nav__link" for="nav-5"> 341 HTTP APIs 342 </label> 343 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 344 <label class="md-nav__title" for="nav-5"> 345 HTTP APIs 346 </label> 347 <ul class="md-nav__list" data-md-scrollfix> 348 349 350 351 352 353 354 355 <li class="md-nav__item"> 356 <a href="../../HTTP-APIs/Content/" title="Content" class="md-nav__link"> 357 Content 358 </a> 359 </li> 360 361 362 363 364 365 366 367 <li class="md-nav__item"> 368 <a href="../../HTTP-APIs/File-Metadata/" title="File Metadata" class="md-nav__link"> 369 File Metadata 370 </a> 371 </li> 372 373 374 375 376 377 378 379 <li class="md-nav__item"> 380 <a href="../../HTTP-APIs/Search/" title="Search" class="md-nav__link"> 381 Search 382 </a> 383 </li> 384 385 386 </ul> 387 </nav> 388 </li> 389 390 391 392 393 394 395 396 397 398 <li class="md-nav__item md-nav__item--active md-nav__item--nested"> 399 400 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6" checked> 401 402 <label class="md-nav__link" for="nav-6"> 403 Interfaces 404 </label> 405 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 406 <label class="md-nav__title" for="nav-6"> 407 Interfaces 408 </label> 409 <ul class="md-nav__list" data-md-scrollfix> 410 411 412 413 414 415 416 417 <li class="md-nav__item"> 418 <a href="../API/" title="API" class="md-nav__link"> 419 API 420 </a> 421 </li> 422 423 424 425 426 427 428 429 430 431 <li class="md-nav__item md-nav__item--active"> 432 433 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="toc"> 434 435 436 <label class="md-nav__link md-nav__link--active" for="toc"> 437 Editor 438 </label> 439 440 <a href="./" title="Editor" class="md-nav__link md-nav__link--active"> 441 Editor 442 </a> 443 444 445 <nav class="md-nav md-nav--secondary"> 446 447 448 449 <label class="md-nav__title" for="toc">Table of contents</label> 450 <ul class="md-nav__list" data-md-scrollfix> 451 452 <li class="md-nav__item"> 453 <a href="#interfaces" title="Interfaces" class="md-nav__link"> 454 Interfaces 455 </a> 456 457 <nav class="md-nav"> 458 <ul class="md-nav__list"> 459 460 <li class="md-nav__item"> 461 <a href="#editoreditable" title="editor.Editable" class="md-nav__link"> 462 editor.Editable 463 </a> 464 465 <nav class="md-nav"> 466 <ul class="md-nav__list"> 467 468 <li class="md-nav__item"> 469 <a href="#method-set" title="Method Set" class="md-nav__link"> 470 Method Set 471 </a> 472 473 </li> 474 475 <li class="md-nav__item"> 476 <a href="#implementation" title="Implementation" class="md-nav__link"> 477 Implementation 478 </a> 479 480 </li> 481 482 </ul> 483 </nav> 484 485 </li> 486 487 <li class="md-nav__item"> 488 <a href="#editormergeable" title="editor.Mergeable" class="md-nav__link"> 489 editor.Mergeable 490 </a> 491 492 <nav class="md-nav"> 493 <ul class="md-nav__list"> 494 495 <li class="md-nav__item"> 496 <a href="#method-set_1" title="Method Set" class="md-nav__link"> 497 Method Set 498 </a> 499 500 </li> 501 502 <li class="md-nav__item"> 503 <a href="#example" title="Example" class="md-nav__link"> 504 Example 505 </a> 506 507 </li> 508 509 </ul> 510 </nav> 511 512 </li> 513 514 </ul> 515 </nav> 516 517 </li> 518 519 520 521 </ul> 522 523 </nav> 524 525 </li> 526 527 528 529 530 531 532 533 <li class="md-nav__item"> 534 <a href="../Format/" title="Format" class="md-nav__link"> 535 Format 536 </a> 537 </li> 538 539 540 541 542 543 544 545 <li class="md-nav__item"> 546 <a href="../Item/" title="Item" class="md-nav__link"> 547 Item 548 </a> 549 </li> 550 551 552 553 554 555 556 557 <li class="md-nav__item"> 558 <a href="../Search/" title="Search" class="md-nav__link"> 559 Search 560 </a> 561 </li> 562 563 564 </ul> 565 </nav> 566 </li> 567 568 569 570 571 572 573 574 <li class="md-nav__item md-nav__item--nested"> 575 576 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7"> 577 578 <label class="md-nav__link" for="nav-7"> 579 Ponzu Addons 580 </label> 581 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 582 <label class="md-nav__title" for="nav-7"> 583 Ponzu Addons 584 </label> 585 <ul class="md-nav__list" data-md-scrollfix> 586 587 588 589 590 591 592 593 <li class="md-nav__item"> 594 <a href="../../Ponzu-Addons/Creating-Addons/" title="Creating Addons" class="md-nav__link"> 595 Creating Addons 596 </a> 597 </li> 598 599 600 601 602 603 604 605 <li class="md-nav__item"> 606 <a href="../../Ponzu-Addons/Using-Addons/" title="Using Addons" class="md-nav__link"> 607 Using Addons 608 </a> 609 </li> 610 611 612 </ul> 613 </nav> 614 </li> 615 616 617 618 619 620 621 622 <li class="md-nav__item md-nav__item--nested"> 623 624 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8"> 625 626 <label class="md-nav__link" for="nav-8"> 627 Quickstart 628 </label> 629 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 630 <label class="md-nav__title" for="nav-8"> 631 Quickstart 632 </label> 633 <ul class="md-nav__list" data-md-scrollfix> 634 635 636 637 638 639 640 641 <li class="md-nav__item"> 642 <a href="../../Quickstart/Overview/" title="Overview" class="md-nav__link"> 643 Overview 644 </a> 645 </li> 646 647 648 </ul> 649 </nav> 650 </li> 651 652 653 654 655 656 657 658 <li class="md-nav__item md-nav__item--nested"> 659 660 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9"> 661 662 <label class="md-nav__link" for="nav-9"> 663 References 664 </label> 665 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 666 <label class="md-nav__title" for="nav-9"> 667 References 668 </label> 669 <ul class="md-nav__list" data-md-scrollfix> 670 671 672 673 674 675 676 677 <li class="md-nav__item"> 678 <a href="../../References/Overview/" title="Overview" class="md-nav__link"> 679 Overview 680 </a> 681 </li> 682 683 684 </ul> 685 </nav> 686 </li> 687 688 689 690 691 692 693 694 <li class="md-nav__item md-nav__item--nested"> 695 696 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10"> 697 698 <label class="md-nav__link" for="nav-10"> 699 Running Backups 700 </label> 701 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 702 <label class="md-nav__title" for="nav-10"> 703 Running Backups 704 </label> 705 <ul class="md-nav__list" data-md-scrollfix> 706 707 708 709 710 711 712 713 <li class="md-nav__item"> 714 <a href="../../Running-Backups/Backups/" title="Backups" class="md-nav__link"> 715 Backups 716 </a> 717 </li> 718 719 720 </ul> 721 </nav> 722 </li> 723 724 725 726 727 728 729 730 <li class="md-nav__item md-nav__item--nested"> 731 732 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11"> 733 734 <label class="md-nav__link" for="nav-11"> 735 System Configuration 736 </label> 737 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 738 <label class="md-nav__title" for="nav-11"> 739 System Configuration 740 </label> 741 <ul class="md-nav__list" data-md-scrollfix> 742 743 744 745 746 747 748 749 <li class="md-nav__item"> 750 <a href="../../System-Configuration/Settings/" title="Settings" class="md-nav__link"> 751 Settings 752 </a> 753 </li> 754 755 756 </ul> 757 </nav> 758 </li> 759 760 761 762 763 764 765 766 <li class="md-nav__item md-nav__item--nested"> 767 768 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12"> 769 770 <label class="md-nav__link" for="nav-12"> 771 System Deployment 772 </label> 773 <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> 774 <label class="md-nav__title" for="nav-12"> 775 System Deployment 776 </label> 777 <ul class="md-nav__list" data-md-scrollfix> 778 779 780 781 782 783 784 785 <li class="md-nav__item"> 786 <a href="../../System-Deployment/Docker/" title="Docker" class="md-nav__link"> 787 Docker 788 </a> 789 </li> 790 791 792 793 794 795 796 797 <li class="md-nav__item"> 798 <a href="../../System-Deployment/SysV-Style/" title="SysV Style" class="md-nav__link"> 799 SysV Style 800 </a> 801 </li> 802 803 804 </ul> 805 </nav> 806 </li> 807 808 809 </ul> 810 </nav> 811 </div> 812 </div> 813 </div> 814 815 816 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> 817 <div class="md-sidebar__scrollwrap"> 818 <div class="md-sidebar__inner"> 819 820 <nav class="md-nav md-nav--secondary"> 821 822 823 824 <label class="md-nav__title" for="toc">Table of contents</label> 825 <ul class="md-nav__list" data-md-scrollfix> 826 827 <li class="md-nav__item"> 828 <a href="#interfaces" title="Interfaces" class="md-nav__link"> 829 Interfaces 830 </a> 831 832 <nav class="md-nav"> 833 <ul class="md-nav__list"> 834 835 <li class="md-nav__item"> 836 <a href="#editoreditable" title="editor.Editable" class="md-nav__link"> 837 editor.Editable 838 </a> 839 840 <nav class="md-nav"> 841 <ul class="md-nav__list"> 842 843 <li class="md-nav__item"> 844 <a href="#method-set" title="Method Set" class="md-nav__link"> 845 Method Set 846 </a> 847 848 </li> 849 850 <li class="md-nav__item"> 851 <a href="#implementation" title="Implementation" class="md-nav__link"> 852 Implementation 853 </a> 854 855 </li> 856 857 </ul> 858 </nav> 859 860 </li> 861 862 <li class="md-nav__item"> 863 <a href="#editormergeable" title="editor.Mergeable" class="md-nav__link"> 864 editor.Mergeable 865 </a> 866 867 <nav class="md-nav"> 868 <ul class="md-nav__list"> 869 870 <li class="md-nav__item"> 871 <a href="#method-set_1" title="Method Set" class="md-nav__link"> 872 Method Set 873 </a> 874 875 </li> 876 877 <li class="md-nav__item"> 878 <a href="#example" title="Example" class="md-nav__link"> 879 Example 880 </a> 881 882 </li> 883 884 </ul> 885 </nav> 886 887 </li> 888 889 </ul> 890 </nav> 891 892 </li> 893 894 895 896 </ul> 897 898 </nav> 899 </div> 900 </div> 901 </div> 902 903 904 <div class="md-content"> 905 <article class="md-content__inner md-typeset"> 906 907 908 909 <h1>Editor</h1> 910 911 <p>Ponzu provides a set of interfaces from the <code>management/editor</code> package which 912 extend the system's functionality and determine how content editors are rendered 913 within the CMS.</p> 914 <hr /> 915 <h2 id="interfaces">Interfaces<a class="headerlink" href="#interfaces" title="Permanent link">¶</a></h2> 916 <h3 id="editoreditable"><a href="https://godoc.org/github.com/rpdict/ponzu/management/editor#Editable">editor.Editable</a><a class="headerlink" href="#editoreditable" title="Permanent link">¶</a></h3> 917 <p>Editable determines what <code>[]bytes</code> are rendered inside the editor page. Use 918 Edtiable on anything inside your CMS that you want to provide configuration, editable 919 fields, or any HTML/markup to display to an end-user.</p> 920 <div class="admonition note"> 921 <p class="admonition-title">Implementing <code>editor.Editable</code></p> 922 <p>Most of the time, Ponzu developers generate the majority of this code using 923 the Ponzu CLI <a href="../../CLI/Usage"><code>generate</code> command</a>.</p> 924 </div> 925 <h5 id="method-set">Method Set<a class="headerlink" href="#method-set" title="Permanent link">¶</a></h5> 926 <div class="codehilite"><pre><span></span><span class="kd">type</span> <span class="nx">Editable</span> <span class="kd">interface</span> <span class="p">{</span> 927 <span class="nx">MarshalEditor</span><span class="p">()</span> <span class="p">([]</span><span class="kt">byte</span><span class="p">,</span> <span class="kt">error</span><span class="p">)</span> 928 <span class="p">}</span> 929 </pre></div> 930 931 932 <h5 id="implementation">Implementation<a class="headerlink" href="#implementation" title="Permanent link">¶</a></h5> 933 <div class="codehilite"><pre><span></span><span class="kd">func</span> <span class="p">(</span><span class="nx">p</span> <span class="o">*</span><span class="nx">Post</span><span class="p">)</span> <span class="nx">MarshalEditor</span><span class="p">()</span> <span class="p">([]</span><span class="kt">byte</span><span class="p">,</span> <span class="kt">error</span><span class="p">)</span> <span class="p">{</span> 934 <span class="c1">// The editor.Form func sets up a structured UI with default styles and form</span> 935 <span class="c1">// elements based on the fields provided. Most often, Ponzu developers will</span> 936 <span class="c1">// have the `$ ponzu generate` command generate the MarshalEditor func and </span> 937 <span class="c1">// its internal form fields</span> 938 <span class="nx">view</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">editor</span><span class="p">.</span><span class="nx">Form</span><span class="p">(</span><span class="nx">p</span><span class="p">,</span> 939 <span class="nx">editor</span><span class="p">.</span><span class="nx">Field</span><span class="p">{</span> 940 <span class="nx">View</span><span class="p">:</span> <span class="nx">editor</span><span class="p">.</span><span class="nx">Input</span><span class="p">(</span><span class="s">"Name"</span><span class="p">,</span> <span class="nx">p</span><span class="p">,</span> <span class="kd">map</span><span class="p">[</span><span class="kt">string</span><span class="p">]</span><span class="kt">string</span><span class="p">{</span> 941 <span class="s">"label"</span><span class="p">:</span> <span class="s">"Name"</span><span class="p">,</span> 942 <span class="s">"type"</span><span class="p">:</span> <span class="s">"text"</span><span class="p">,</span> 943 <span class="s">"placeholder"</span><span class="p">:</span> <span class="s">"Enter the Name here"</span><span class="p">,</span> 944 <span class="p">}),</span> 945 <span class="p">},</span> 946 <span class="p">)</span> 947 <span class="p">}</span> 948 </pre></div> 949 950 951 <div class="admonition note"> 952 <p class="admonition-title">MarshalEditor() & View Rendering</p> 953 <p>Although it is common to use the <code>editor.Form</code> and <code>editor.Fields</code> to structure your content editor inside <code>MarshalEditor()</code>, the method signature defines that its return value needs only to be <code>[]byte, error</code>. Keep in mind that you can return a <code>[]byte</code> of any raw HTML or other markup to be rendered in the editor view.</p> 954 </div> 955 <hr /> 956 <h3 id="editormergeable"><a href="https://godoc.org/github.com/rpdict/ponzu/management/editor#Mergeable">editor.Mergeable</a><a class="headerlink" href="#editormergeable" title="Permanent link">¶</a></h3> 957 <p>Mergable enables a CMS end-user to merge the "Pending" content from an outside source into the "Public" section, and thus making it visible via the public content API. It also allows the end-user to reject content. "Approve" and "Reject" buttons will be visible on the edit page for content submitted.</p> 958 <h5 id="method-set_1">Method Set<a class="headerlink" href="#method-set_1" title="Permanent link">¶</a></h5> 959 <div class="codehilite"><pre><span></span><span class="kd">type</span> <span class="nx">Mergeable</span> <span class="kd">interface</span> <span class="p">{</span> 960 <span class="nx">Approve</span><span class="p">(</span><span class="nx">http</span><span class="p">.</span><span class="nx">ResponseWriter</span><span class="p">,</span> <span class="o">*</span><span class="nx">http</span><span class="p">.</span><span class="nx">Request</span><span class="p">)</span> <span class="kt">error</span> 961 <span class="p">}</span> 962 </pre></div> 963 964 965 <h5 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h5> 966 <div class="codehilite"><pre><span></span><span class="kd">func</span> <span class="p">(</span><span class="nx">p</span> <span class="o">*</span><span class="nx">Post</span><span class="p">)</span> <span class="nx">Approve</span><span class="p">(</span><span class="nx">res</span> <span class="nx">http</span><span class="p">.</span><span class="nx">ResponseWriter</span><span class="p">,</span> <span class="nx">req</span> <span class="o">*</span><span class="nx">http</span><span class="p">.</span><span class="nx">Request</span><span class="p">)</span> <span class="kt">error</span> <span class="p">{</span> 967 <span class="k">return</span> <span class="kc">nil</span> 968 <span class="p">}</span> 969 </pre></div> 970 971 972 973 974 975 976 977 </article> 978 </div> 979 </div> 980 </main> 981 982 983 <footer class="md-footer"> 984 985 <div class="md-footer-nav"> 986 <nav class="md-footer-nav__inner md-grid"> 987 988 <a href="../API/" title="API" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> 989 <div class="md-flex__cell md-flex__cell--shrink"> 990 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> 991 </div> 992 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> 993 <span class="md-flex__ellipsis"> 994 <span class="md-footer-nav__direction"> 995 Previous 996 </span> 997 API 998 </span> 999 </div> 1000 </a> 1001 1002 1003 <a href="../Format/" title="Format" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> 1004 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> 1005 <span class="md-flex__ellipsis"> 1006 <span class="md-footer-nav__direction"> 1007 Next 1008 </span> 1009 Format 1010 </span> 1011 </div> 1012 <div class="md-flex__cell md-flex__cell--shrink"> 1013 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> 1014 </div> 1015 </a> 1016 1017 </nav> 1018 </div> 1019 1020 <div class="md-footer-meta md-typeset"> 1021 <div class="md-footer-meta__inner md-grid"> 1022 <div class="md-footer-copyright"> 1023 1024 powered by 1025 <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a> 1026 and 1027 <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs"> 1028 Material for MkDocs</a> 1029 </div> 1030 1031 1032 <div class="md-footer-social"> 1033 1034 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> 1035 1036 <a href="https://github.com/rpdict" class="md-footer-social__link fa fa-github"></a> 1037 1038 <a href="https://twitter.com/ponzu_cms" class="md-footer-social__link fa fa-twitter"></a> 1039 1040 </div> 1041 1042 1043 </div> 1044 </div> 1045 </footer> 1046 1047 </div> 1048 1049 <script src="../../assets/javascripts/application-6b599127bc.js"></script> 1050 <script>app.initialize({url:{base:"../.."}})</script> 1051 1052 1053 1054 1055 <script>!function(e,t,a,n,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(a),i=t.getElementsByTagName(a)[0],c.async=1,c.src=n,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-98609560-1","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})});var query=document.forms.search.query;query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script> 1056 1057 1058 </body> 1059 </html>