Add Page By Form Plugin

The Add Page By Form Plugin is for Grav CMS. It allows users to add a new page by filling in a form. A new page can also be a new blog post by setting the appropriate template.

When a textarea field is given the id: simplemde then it will activate the SimpleMDE Markdown Editor and content entered in the textarea will be saved to the new page content in markdown format.

Security

This plugin does not provide any security measures. Please take this in consideration before using this plugin.

Installation

Typically the plugin should be installed via GPM (Grav Package Manager):

$ bin/gpm install add-page-by-form

Alternatively it can be installed via the Admin Plugin.

A third option is to manualy install the plugin by downloading the plugin as a zip file. Copy the zip file to your /user/plugins directory, unzip it there and rename the folder to add-page-by-form.

Configuration Defaults

Here is the default configuration and an explanation of available options:

enabled: true

• enabled: true|false determines whether the plugin is active or not

Configuration Modifications

Before using this plugin, you should copy the user/plugins/add-page-by-form/add-page-by-form.yaml to user/config/plugins/add-page-by-form.yaml and use that file to change configuration settings.

Usage

Using is a two step proces:

1. Create a form page.
2. Create a "Thank You" page (slug: thank-you) as a child page of the form page.

For the form page two examples are given here. The first set's up a form that will create a new page. The second will create a new blog item.

---
title: 'Add New Page'
template: form
parent: '/'
pagefrontmatter:
    title: 'My New Page'
    visible: true
    course:
        title: 'CMPT363 E100'
        assignment: 'Reading Quiz #1'
    instructor:
        name: 'John Doe'
form:
    name: add-page-form
    fields:
        -
            name: title
            label: 'Page Title'
            placeholder: 'Enter your page title here'
            autocomplete: true
            type: text
            validate:
                required: false
        -
            name: content
            id: simplemde
            label: 'Page Content'
            size: long
            placeholder: 'Write the content here'
            type: textarea
            validate:
                required: true
            -
            name: honeypot
            type: honeypot
    buttons:
        -
            type: submit
            value: Submit
            classes: null
    process:
        -
            addpage: null
        -
            display: thank-you
---

You can add a new page by filling in the form below.

Please enter a title (optional) and write some content to appear on the new page.

To allow a user to add a blog post simply change the template variable to item and set some other blog related variables in the pagefrontmatter block:

---
title: 'Add Blog Post'
template: form
parent: '/blog'
pagefrontmatter:
    template: item
    title: My new Blog post
    taxonomy:
        category: blog
        tag: [journal, guest]
form:
    name: add-blog-post-form
    fields:
        -
            name: author
            label: 'Author'
            placeholder: 'Enter your name here'
            autocomplete: true
            type: text
            validate:
                required: true
        -
            name: title
            label: 'Blog Post Title'
            placeholder: 'Enter your page title here'
            autocomplete: true
            type: text
            validate:
                required: true
        -
            name: content
            id: simplemde
            label: 'Page Content'
            size: long
            placeholder: 'Write the content here'
            type: textarea
            validate:
                required: true
        -
            name: images
            type: file
            multiple: true
            destination: '@self'
            accept:
                - 'image/*'
        -
            name: honeypot
            type: honeypot
    buttons:
        -
            type: submit
            value: Submit
            classes: null
    process:
        -
            addpage: null
        -
            display: thank-you
---

You can add a new blog post by filling in the form below.

Please enter your name, a title and write something nice.

In the examples above the root level configuration options are:

• title sets the title of the page containg the form
• template: form activates the form on this page (not required when the form page is named form.md)
• parent sets the parent page for the new page. parent must be the path from the pages root, for example /user_contributions. The parent page must exist.
• template specifies the Twig template to be used by the new page. Use page for a regular page and item for a blog post item or use your own custom template.
• pagefrontmatter is a block of frontmatter that gets inserted in the new page header.
• form specifies the form.

The content of the pagefrontmatter block must be seen as default settings for the new page. These default settings can be overridden by user input if you add a form field by the same name. For example in the Add New Page example, the default title is set to My New Page. The user is prompted to enter a title for the new page in the form but does not need to do so because filling in the title field is not mandatory (required is false for that field).

The passing on of both the default settings and the form field values to the new page frontmatter makes for an extremely configurable solution. By configuring the page form settings you can to a large extent control the appearence and behaviour of the newly added page by using the frontmatter variables in your Twig templates.

Credits

• Team Grav and everyone who contributes to Grav;
• Alex Garret for Slug generator;
• Wes Cossick for SimpleMDE Markdown Editor.