# Placeholder Forms

**URL:** <https://meta.discourse.org/t/placeholder-forms/113533>\
**Category:** Theme component\
**Tags:** official, placeholder-forms\
**Created:** [April 5, 2019, 11:18am UTC](https://meta.discourse.org/t/placeholder-forms/113533 "2019-04-05T11:18:48Z")\
**Posts on this page:** 1\
**Showing post:** 1

<div class="post-metadata">

**Author:** ![Discourse](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/discourse/32/148734_2.png) [@Discourse](https://meta.discourse.org/u/Discourse)\
**Post date:** [April 5, 2019, 11:18am UTC](https://meta.discourse.org/t/placeholder-forms/113533/1 "2019-04-05T11:18:48Z")

</div>

| | | |
| --- | --- | --- |
| :discourse2: | **Summary** | **Placeholder Forms** will let you build dynamic documentation, by creating a form that replaces any occurrence of a =PATTERN= in your post with the value from a text or selectable input field. |
| 👓 | **Preview** | [Preview on Discourse Theme Creator](https://discourse.theme-creator.io/theme/Discourse/placeholder-forms) |
| 🛠 | **Repository Link** | [https://github.com/discourse/discourse-placeholder-theme-component](https://github.com/discourse/discourse-placeholder-theme-component) |
| 📖 | **New to Discourse Themes?** | [Beginner’s guide to using Discourse Themes](https://meta.discourse.org/t/beginners-guide-to-using-discourse-themes/91966) |

Install this theme component

> [@](#):
>
> :discourse2: As this is an #official theme component maintained by the Discourse team, #Support, #Contribute > Bug, #Contribute > UX, and #Contribute > Feature requests can be made in the respective categories here on Meta, and tagged with the appropriate theme component tag. Click on a link below to get one started. 👍
> 
> [❓&nbsp; **Support**](https://meta.discourse.org/new-topic?category_id=6&tags=placeholder-forms "Ask for support on configuring and using Placeholder Forms") [🐛&nbsp; **Bug**](https://meta.discourse.org/new-topic?category_id=1&tags=placeholder-forms "A bug report means something is broken, preventing normal/typical use of the theme component") [👀&nbsp; **UX**](https://meta.discourse.org/new-topic?category_id=9&tags=placeholder-forms "Discussion about the user interface of Placeholder Forms, and how features are presented (including language and UI elements)") [💡&nbsp; **Feature**](https://meta.discourse.org/new-topic?category_id=2&tags=placeholder-forms "Discussion about how existing Placeholder Forms features can be improved or enhanced, and how proposed new features could work")

### Features

Add placeholders to posts in this format:

```plaintext
[wrap=placeholder key=NAME description="Your name"][/wrap]
[wrap=placeholder key=COUNTRY default=US defaults=FR,DE,US,CN,AU,CA][/wrap]

Your email: =NAME=-=COUNTRY=@example.com

```

And this will result in:

 ![14](https://global.discourse-cdn.com/meta/original/3X/b/f/bf9c97efbf63da8a462d1023a684e61bfb524354.png)

This is used in mailing list

Your email: =ZNAME=-=ZCOUNTRY=@example.com

As seen above, text inside the wrapper will be used as a long description.

```plaintext
[wrap=placeholder key=NAME description="Your name"]
This is used in mailing list
[/wrap]

```

## Available keys

- key: The key that should be replaced in your post
- default/defaults: default value(s)
- description: a placeholder text for the input

## Examples

```plaintext
# create a new plugin
rails g plugin =PLUGIN_NAME=
cd plugins/=PLUGIN_NAME=

```

> [@Set up file and image uploads to S3](https://meta.discourse.org/t/setting-up-file-and-image-uploads-to-s3/7229):
>
> So, you want to use S3 to handle image uploads? Here’s the definitive guide, but also see [Configure an S3 compatible object storage provider for uploads](https://meta.discourse.org/t/configure-an-s3-compatible-object-storage-provider-for-uploads/148916) to see how to configure your app.yml. S3 registration Head over to [https://aws.amazon.com/free/](https://aws.amazon.com/free/) and click on [Create a Free Account] During the create account process, make sure you provide payment information, otherwise you won’t be able to use S3. There’s no registration fee, you will only be charged for [what you use](https://aws.amazon.com/s3/pricing/), if you exceed the [AWS …](https://aws.amazon.com/free/)

* * *

We use it to create runbooks, howtos and reusable templates (it will work in code blocks). Please share your use cases!

### Settings

| Translation | Default |
| --- | --- |
| toolbar.builder | Add Placeholder |
| builder.errors.no\_key | A key is required. |
| builder.title | Add Placeholder |
| builder.insert | Insert |
| builder.key.label | Key |
| builder.key.description | The =Key= to be replaced in the post. |
| builder.description.label | Description |
| builder.description.description | Description displayed on input with no value set. |
| builder.values.label | Default value(s) |
| builder.values.description | Optional value(s) for your placeholder, if multiple values are defined, a select will be used. |

  

> :discourse2: **Hosted by us?** Theme components are available to use on our Standard, Business, and Enterprise plans.

> Last edited by @JammyDodger 2024-06-13T22:28:45Z
> 
> > **Check document**
> >
> > Perform check on document:

---

_[View the full topic](https://meta.discourse.org/t/placeholder-forms/113533)._