---
category: [Administration & Integrations, Platform and Product Extensions, Platform and Product Extensions/Integration, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions/Workday Extend]
keyword: [Extend, Presentation Components, widgets, tags, UI components]
nav: wcp_docs
parent_url: /wcp_docs/
title: guide
layout: subsection
wd_wcptag: guide
---

<a id="section_xz1_wjc_ccb"></a>
Displays a <b>?</b> widget that opens a popup window containing guidance information about a widget on an edit page.

<a id="section_klq_1bt_tgb"></a>
Use the `guide` tag as an attribute of a simple, noncomposite widget on an edit page. You can use the `guide` attribute with any of these widgets:

-   `checkBox`
-   `date`
-   `dropdown`
-   `number`
-   `readOnlyText`
-   `richText`
-   `text`
-   `textArea`
-   `time`


All guides on an edit page are hidden by default.

To always display guides, access the <b>Edit Tenant Setup - System</b> task and select the <b>Always Show Guided Tours</b> check box. It might take up to 60 minutes before your tenant updates. When you enable this option, users can't hide guides.

If you don't enable <b>Always Show Guided Tours</b> and at least 1 widget on an edit page uses the `guide` attribute, the user must click the <b>?</b> on the top right of the page banner to display guides on the widgets. Example:

![](GUID-a04ffe39-fb59-40e9-b4b6-0a2e21e1639e-enHYPHENus.png)

Each guide displays as a <b>?</b> to the right of a widget that has the `guide` attribute. To see a guide, the user must click the <b>?</b>. Example:

![](GUID-a2e63035-1114-4e89-b39c-9c4e9f1f24a4-enHYPHENus.png)

This sample `text` tag uses the `guide` attribute that provides the guidance title, text, and link:

```
{
   "type": "text",
   "label": "Report Name",
   "id": "reportName",
   "guide": {
      "type": "guide",
      "id": "guideTextTag",
      "title": "Enter a report name.",
      "text": "Ensure that the report name you enter is unique and follows our company's naming guidelines.",
      "linkText": "Report Naming Guidelines",
      "linkUrl": "https://mycompany.docs.com/reports/namingGuidelines.html"
   }
},
```

Notes:

-   The user can hide all guide widgets by clicking <b>X</b> on the top right of the page banner. Users can't hide guide widgets if <b>Always Show Guided Tours</b> is enabled on the <b>Edit Tenant Setup - System</b> task.
-   You can't use the `guide` attribute with widgets on a grid.


## <a id="section_qpw_1kc_ccb"></a>Attributes

-   <b>id</b>

    Data type: binding-String

    Unique identifier used to reference this widget from other tags.

    Notes:

    -   The `id` must start with a letter.
    -   The `id` must be unique per page.
    -   To enable other widgets to reference this widget `id`, place this widget before the other widgets on the PMD. The PMD validation returns an "Undefined variable" error if it doesn't find a previously defined `id` in the PMD.
    -   Workday recommends that you include the `id` in your tag definitions for debugging purposes.

-   <b>linkText</b>

    Data type: binding-String

    The text for the link that provides more guidance information.

-   <b>linkUrl</b>

    Data type: binding-String

    A valid URL for the link that provides more guidance information.

-   <b>render</b>

    Data type: binding-Boolean

    If false, the <b>?</b> widget doesn't display. The default is true.

-   <b>text</b>

    Data type: binding-String

    Plain text that provides brief guidance information. To provide related or more detailed guidance, use the `linkUrl` and `linkText` attributes.

-   <b>title</b>

    Data type: binding-String

    The title that displays on top of the popup window of the guide widget.



### Related Information

[Tutorial: Format Text on View and Edit Pages](https://wd5.myworkday.com/workday/learning/course/f18ca7875d521005123a3c6295230000?type=9882927d138b100019b928e75843018d)