Generate: Using Keywords

Overview

Your defined Keywords can be used in any editable text field or Page Builder on a Content Group or Term Group.

When generating content, Page Generator Pro will replace these keywords with actual terms specified in the keywords.  For example, if our {service} keyword comprises of Web Design and Web Development, the Plugin would generate at least two Pages:

1. Web Design in…
2. Web Development in…

Depending on the field you’re editing, and the editor experience you’re using, you can add keywords to your content in a number of ways:

Insert Keyword Dropdown

The Insert Keyword dropdown option is displayed on some fields in the Classic Editor, such as the Title and Excerpt:

If you are not using the Classic Editor Plugin (i.e. you are using Gutenberg/the block editor, or a Page Builder), refer to the below sections, which cover using Keywords for those accordingly.

Autocomplete Suggestions

For most fields, an autocomplete dropdown list of matching Keywords will be displayed when you begin typing with a left curly brace.

Continue to type until you see the keyword you want to insert, and either:

• Click the keyword,
• Use the arrow keys on the keyboard to navigate up and down the autocomplete list, highlighting the required Keyword and pressing the Enter key

For example, to add a defined Keyword called service:

• Start typing {ser,
• Click the resulting keyword in the list:
  

To hide or cancel autocompletion, either press the escape key, or click outside of the list of suggested keywords.

Gutenberg Title and Blocks

An autocomplete dropdown list of matching Keywords will be displayed when you begin typing with a left curly brace.

Continue to type until you see the keyword you want to insert, and either:

• Click the keyword,
• Use the arrow keys on the keyboard to navigate up and down the autocomplete list, highlighting the required Keyword and pressing the Enter key

For example, to add a defined Keyword called service:

• Start typing {ser,
• Click the resulting keyword in the list:
  

To hide or cancel autocompletion, either press the escape key, or click outside of the list of suggested keywords.

Classic / Visual / TinyMCE Editor

An autocomplete dropdown list of matching Keywords will be displayed when you begin typing with a left curly brace.

Continue to type until you see the keyword you want to insert, and either:

• Click the keyword,
• Use the arrow keys on the keyboard to navigate up and down the autocomplete list, highlighting the required Keyword and pressing the Enter key

For example, to add a defined Keyword called service:

• Start typing {ser,
• Click the resulting keyword in the list:
  

To hide or cancel autocompletion, either press the escape key, or click outside of the list of suggested keywords.

Transforming Keywords

Assuming you have the following example Keyword configured:

The output of keyword terms can be transformed, by using a flag after the keyword.  For example:

• {location:uppercase_all} would convert Birmingham, West Midlands to BIRMINGHAM, WEST MIDLANDS.
• {location(city):lowercase_all} would convert Birmingham to birmingham

Some Keyword Transformations also support arguments, which are defined in square brackets.  For example:

• {location(city):random[2,4]} would choose between two and four Terms at random, outputting them in a random order as a comma separated list.

Multiple Transformations

Multiple transformations can be applied to a Keyword, and are applied in the order they are written, from left to right.  For example:

The below sections detail the available Keyword Transformations.

Character Transformations

Permalink Transformations

Force Keyword Term

The output of the keyword can be forced to always output a specific term.  In the above example, this means that we could use the following keywords in our Content Group:

Output All Terms

The output of the keyword can be forced to always output all terms, in a comma separated list.  In the above example, this means that we could use the following keywords in our Content Group:

Output Same Random Term

The output of the keyword can be set to output the same term, chosen at random.  In the above example, this means that we could use the following keywords in our Content Group:

Output Same Random Terms in a List

The output of the keyword can be set to output the same list of terms, chosen at random, in a comma separated format, based on the arguments provided in square brackets.  In the above example, this means that we could use the following keywords in our Content Group:

Output Different Random Term

The output of the keyword can be set to output a different term, chosen at random for each occurrence of the Keyword.  In the above example, this means that we could use the following keywords in our Content Group:

Output Random Term Subsets in a List

Assuming you have the following example Keyword configured:

Instead of using {location(street_names)} to output the list of Street Names, we can use the Random Term Subsets transformation to output a subset of the Street Names, in a random order, based on the supplied comma separated list of arguments provided in square brackets:

In the above example, this means that we could use the following keywords in our Content Group, producing the Output based on the first term, Birmingham:

Output Nearby Terms in a List

Assuming you have the following example Keyword configured:

When using a Keyword, comprising of location names, latitudes and longitudes, the output of the Keyword can be set to list nearby locations in a comma separated list, based on the supplied comma separated list of arguments provided in square brackets:

In the above example, this means that we could use the following keywords in our Content Group, producing the Output based on the first term, Birmingham:

Number to Words Transformations

Assuming you have the following example Keyword configured:

Unless an argument is specified, output will be attempted in the WordPress Site’s Language.

Transformations can also be applied to a Keyword’s Column; in this case, the numeric column name:

Unless an argument is specified, output will be attempted in the WordPress Site’s Language.

Currency to Words Transformations

Assuming you have the following example Keyword configured:

Unless an argument is specified, output will be attempted in the WordPress Site’s Language, US Dollars.

Transformations can also be applied to a Keyword’s Column; in this case, the numeric column name:

Unless an argument is specified, output will be attempted in the WordPress Site’s Language.

Combining Column Names, Transformations and Forcing Term

Any combination of the above Using Keywords sections can be used.  For example:

Using Taxonomy Keywords in Groups

Any Taxonomy can also be used as a Keyword, by inserting the {taxonomy_name} tag into your content (where name is replaced by the name of your Taxonomy).  For example, if you have Categories defined on your WordPress web site (typically found at Posts > Categories), you’d use :

You can insert Taxonomy Keywords manually into any content-based text field, even if the Insert Keyword dropdown isn’t present.  For example:

• Title
• Permalink
• Content
• Excerpt
• Custom Fields
  • Meta Key
  • Meta Value

Common Issues

URLs stored in Keyword lose colon on Generation

Specifying a Keyword as the link source in Gutenberg will result in Gutenberg attempting to perform validation on the Keyword.  This results in:

• Gutenberg prepending this automatically when it believes the string provided isn’t a URL (i.e. a Keyword),
• The link in the generated Page will be missing a colon.

It’s therefore recommended to either:

• Remove http(s):// from links in your Keyword, or
• Use the Classic Editor block for that specific content section