Skip to content

Commit

Permalink
Fixing links to use file path instead of url path; trailingSlash - fa…
Browse files Browse the repository at this point in the history
…lse#
  • Loading branch information
d45 committed Oct 22, 2024
1 parent 1708160 commit f502935
Show file tree
Hide file tree
Showing 36 changed files with 138 additions and 145 deletions.
4 changes: 2 additions & 2 deletions website/docs/Interaction_Guidelines/ux_build_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The Extensions API includes all the information you need to build an extension.

Ensure that your extension works properly for different test cases. Try it on your own dashboards, test it with others, and uncover possible edge cases.

Consider that dashboard extensions can be both **configured** and **viewed** in Tableau. These terms refer to two usage modes we recommend for extensions. To read about these modes and their audiences, learn more at **[Extension Components and Modes](ux_components_modes)**.
Consider that dashboard extensions can be both **configured** and **viewed** in Tableau. These terms refer to two usage modes we recommend for extensions. To read about these modes and their audiences, learn more at **[Extension Components and Modes](./ux_components_modes.md)**.


 
Expand All @@ -47,7 +47,7 @@ After you've completed making your extension, you may want to share your extensi

#### Tableau Exchange

Tableau has created the [Tableau Exchange](https://exchange.tableau.com/), a place to explore and download some extensions that our partners have created. If you would like to share your extension on the Tableau Exchange, see [Submitting your Extension to the Tableau Exchange](../ux_extension_gallery).
Tableau has created the [Tableau Exchange](https://exchange.tableau.com/), a place to explore and download some extensions that our partners have created. If you would like to share your extension on the Tableau Exchange, see [Submitting your Extension to the Tableau Exchange](../ux_extension_gallery.md).

#### Community Forums

Expand Down
10 changes: 5 additions & 5 deletions website/docs/Interaction_Guidelines/ux_components_modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ This is where authors can access the dropdown menu for more options, such as con

![extension container](./imgs/2-chrome_menu.png)

*Learn more about branding your extension container at [Branding your Extension](../Style_Guidelines/ux_branding#extension-container).*
*Learn more about branding your extension container at [Branding your Extension](../Style_Guidelines/ux_branding.md#extension-container).*

 

Expand All @@ -73,7 +73,7 @@ This dialog is only available to dashboard authors, It is primarily accessible t

![configuration dialog](./imgs/2-config_dialog.png)

*Learn more about branding your configuration dialog at [Branding your Extension](../Style_Guidelines/ux_branding#configuration-dialog).*
*Learn more about branding your configuration dialog at [Branding your Extension](../Style_Guidelines/ux_branding.md#configuration-dialog).*

 

Expand Down Expand Up @@ -122,7 +122,7 @@ The configuration dialog allows dashboard authors to customize extensions in the
| **Tagline** | The tagline is one sentence in the help tag that explains what the extension does. The maximum character limit is 96 characters.|
| **Confirmation** | Make sure there is a clear way for users to apply changes made while configuring the extension. |

Learn more about [Controls and UI Patterns](ux_controls_ui_patterns) to use in your configuration dialog.
Learn more about [Controls and UI Patterns](./ux_controls_ui_patterns.md) to use in your configuration dialog.

 

Expand All @@ -134,7 +134,7 @@ Many extensions require an author to configure the extension before using it in

While this is optional, **we strongly recommend using this popup pattern** because when an author is configuring the extension for the first time, there often isn't any content present in the extension container until the extension has been configured. Using this popup pattern will allow authors to start configuring the extension right away.

*Learn more about how to implement this popup at [Add a Configuration Popup Dialog (Extensions API Documentation)](../core/trex_configure).*
*Learn more about how to implement this popup at [Add a Configuration Popup Dialog (Extensions API Documentation)](../core/trex_configure.md).*

 

Expand All @@ -144,7 +144,7 @@ The About Extension Dialog is automatically created using the content from your

![about extension dialog](./imgs/2-about_dialog_annotated.png)

*Learn more about the dashboard extension manifest file at [Tableau Extension Manifest File (Extensions API Documentation)](../dashext/trex_manifest)*.
*Learn more about the dashboard extension manifest file at [Tableau Extension Manifest File (Extensions API Documentation)](../dashext/trex_manifest.md)*.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ We've provided examples of controls that are used in Tableau. Using the exact st
* [Tooltips](#tooltips)


The controls described here use Tableau branding, accessible from the **[Color](../Style_Guidelines/ux_color)** and **[Fonts](../Style_Guidelines/ux_fonts)** sections of these design guidelines.
The controls described here use Tableau branding, accessible from the **[Color](../Style_Guidelines/ux_color.md)** and **[Fonts](../Style_Guidelines/ux_fonts.md)** sections of these design guidelines.

*At this time, we are only able to provide surface-level usage and design specifications for controls. We are working to make code for Tableau controls accessible to developers in the future.*

Expand Down Expand Up @@ -63,7 +63,7 @@ A button communicates what happens when a user touches it. Button labels can con

| Button | How to use |
|----|:-----|
| **Call-to-Action &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;** | These buttons are primarily used in dialogues to indicate an action. Use colors to communicate function–for example, green is commonly used for confirmation buttons. Learn more about color usage at **[Colors](../Style_Guidelines/ux_color)**.<br/>You may also want to utilize branding practices on buttons. Learn more at **[Branding your Extension](../Style_Guidelines/ux_branding)**. |
| **Call-to-Action &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;** | These buttons are primarily used in dialogues to indicate an action. Use colors to communicate function–for example, green is commonly used for confirmation buttons. Learn more about color usage at **[Colors](../Style_Guidelines/ux_color.md)**.<br/>You may also want to utilize branding practices on buttons. Learn more at **[Branding your Extension](../Style_Guidelines/ux_branding.md)**. |
| **Greyscale** | Greyscale buttons are used either to indicate a secondary action, or a button that has been disabled and a particular action needs to be taken before proceeding. |
| **Text Button &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;** | This is a low-attention button, and should only be used to provide a secondary option in the case that the user wants to perform an action that isn’t the primary action. |
| **Icon** | Buttons can have icons to add a helpful visual. If you use icons, include a text label or a help tag that is activated on hover. |
Expand Down Expand Up @@ -102,7 +102,7 @@ Primary buttons apply only to Call-to-Action buttons.

## Dialogs

A dialog is a “conversation” between the system and the user, which often requests information or action from the user. For info about the extension configuration dialog, learn more at **[Extension Components and Modes](ux_components_modes)**.
A dialog is a “conversation” between the system and the user, which often requests information or action from the user. For info about the extension configuration dialog, learn more at **[Extension Components and Modes](ux_components_modes.md)**.

### Standard Dialog
These dialogs are non-modal, meaning they can be used when the requested information is not essential to continue. The dialog can be left open while the user interacts with other components in the extension.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/Style_Guidelines/ux_branding.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Your extension can be branded through two components: the **configuration dialog

<i>Links to review component usage and controls specifications</i>:

* **[Extension Components and Modes](../Interaction_Guidelines/ux_components_modes)**
* **[Controls and UI Patterns](../Interaction_Guidelines/ux_controls_ui_patterns)**
* **[Extension Components and Modes](../Interaction_Guidelines/ux_components_modes.md)**
* **[Controls and UI Patterns](../Interaction_Guidelines/ux_controls_ui_patterns.md)**

&nbsp;

Expand Down
2 changes: 1 addition & 1 deletion website/docs/Style_Guidelines/ux_color.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use of color is essential for communication. Color is one of the first visual el

## Color Principles

**Use colors with purpose and clarity.** Your color choices should highlight your extension's content, while also communicating its function. You should be able to justify the colors used on your extension: why did you choose that specific color, and what does it communicate to your user? Color is also an opportunity to showcase your brand. Learn more at **[Branding your Extension](ux_branding)**.
**Use colors with purpose and clarity.** Your color choices should highlight your extension's content, while also communicating its function. You should be able to justify the colors used on your extension: why did you choose that specific color, and what does it communicate to your user? Color is also an opportunity to showcase your brand. Learn more at **[Branding your Extension](ux_branding.md)**.

**Less is more.** Refrain from using too many colors, which could blur the focus. Try to avoid using color applied to text, which can make words difficult to distinguish and decrease legibility.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/Style_Guidelines/ux_fonts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ layout: guide

Fonts and typography are essential to how we communicate with our users. When text is used effectively, it grabs attention, evokes emotion, and emphasizes tone and voice.

> **Note:** Starting with the Dashboard Extensions API v1.7 library, and supported with Tableau 2021.4 or later, you can apply workbook formatting on the HTML elements in your extension. For more information, see [Add Tableau Workbook Formatting](../core/trex_format).
> **Note:** Starting with the Dashboard Extensions API v1.7 library, and supported with Tableau 2021.4 or later, you can apply workbook formatting on the HTML elements in your extension. For more information, see [Add Tableau Workbook Formatting](../core/trex_format.md).
&nbsp;

Expand All @@ -30,7 +30,7 @@ We recommend that you use a **sans serif font family** in your extension. Here,
&nbsp;

#### Benton Sans
Benton Sans Book is the default font for the Tableau UI elements. To learn more about Tableau font colors, see [Color](ux_color).
Benton Sans Book is the default font for the Tableau UI elements. To learn more about Tableau font colors, see [Color](./ux_color.md).

Other weight variations of Benton Sans should be used infrequently. For example, Benton Sans Medium is typically used for section titles in dialogs. Benton Sans Light and Book Italic are used in more specific cases like lightweight captions and should not be overused.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/Style_Guidelines/ux_layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ It is common for extensions to take up a smaller size due to most of the functio

## Spacing

Specifications about spacing have been detailed in **[Controls and UI Patterns](../Interaction_Guidelines/ux_controls_ui_patterns)** and **[Branding your Extension](ux_branding)**.
Specifications about spacing have been detailed in **[Controls and UI Patterns](../Interaction_Guidelines/ux_controls_ui_patterns.md)** and **[Branding your Extension](ux_branding.md)**.

Here are some links to specific parts of your extension that you may need spacing guidance on:

* [**Dialogs** (Controls and UI Patterns)](../Interaction_Guidelines/ux_controls_ui_patterns#dialogs)
* [**Configuration Dialog** (Branding your Extension)](../Style_Guidelines/ux_branding#configuration-dialog)
* [**Extension Container** (Branding your Extension)](../Style_Guidelines/ux_branding#extension-container)
* [**Dialogs** (Controls and UI Patterns)](../Interaction_Guidelines/ux_controls_ui_patterns.md#dialogs)
* [**Configuration Dialog** (Branding your Extension)](../Style_Guidelines/ux_branding.md#configuration-dialog)
* [**Extension Container** (Branding your Extension)](../Style_Guidelines/ux_branding.md#extension-container)
2 changes: 1 addition & 1 deletion website/docs/core/trex_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ dashboard.addEventListener(tableau.TableauEventType.WorkbookFormattingChanged, (

```

For more information about using event listeners, see [Events and Event Handling](./trex_events).
For more information about using event listeners, see [Events and Event Handling](./trex_events.md).

## What's Next

Expand Down
8 changes: 4 additions & 4 deletions website/docs/core/trex_getdata.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Getting Data from the Workbook
description: How to access data in the workbook
---

The Tableau Extensions API provides methods that you can use to access the data in a workbook. The data you can access includes the summary or aggregated data, and also the underlying data (or full data). If your extension needs to access the full data, there are security implications and your extension needs to declare its intent, so that users of your extension can choose to allow or deny the extension access. See [Accessing Underlying Data](../security/trex_data_access) for more information.
The Tableau Extensions API provides methods that you can use to access the data in a workbook. The data you can access includes the summary or aggregated data, and also the underlying data (or full data). If your extension needs to access the full data, there are security implications and your extension needs to declare its intent, so that users of your extension can choose to allow or deny the extension access. See [Accessing Underlying Data](../security/trex_data_access.md) for more information.

::::note

Expand Down Expand Up @@ -65,7 +65,7 @@ The first step for accessing data of any kind is to get the worksheet object (or

```

After you have a worksheet object, you can call one of the methods to access the data for that worksheet. For summary data, or the data from the selected or highlighted marks, the steps are straight forward. If you want access the underlying data (or full data), there are additional steps and considerations. See [Accessing Underlying Data](../security/trex_data_access).
After you have a worksheet object, you can call one of the methods to access the data for that worksheet. For summary data, or the data from the selected or highlighted marks, the steps are straight forward. If you want access the underlying data (or full data), there are additional steps and considerations. See [Accessing Underlying Data](../security/trex_data_access.md).

## Get summary data from a worksheet

Expand Down Expand Up @@ -121,7 +121,7 @@ Prior to Tableau 2022.4 and the Dashboard Extensions API library v1.10, you woul

## Get full data from a worksheet

If your extension uses one of the functions that can access full data, you need to add an element to the manifest file (`.trex`) that declares that the extension requires `full data` permission. If the manifest file does not have this element, the extension can run, but the method to access full data will fail. See [Add permissions to access full data to manifest file](../security/trex_data_access#add-permissions-to-access-full-data-to-manifest-file).
If your extension uses one of the functions that can access full data, you need to add an element to the manifest file (`.trex`) that declares that the extension requires `full data` permission. If the manifest file does not have this element, the extension can run, but the method to access full data will fail. See [Add permissions to access full data to manifest file](../security/trex_data_access.md#add-permissions-to-access-full-data-to-manifest-file).

Note whoever uses your extension must have the appropriate download permissions (Download Full Data) so that extension can run.

Expand Down Expand Up @@ -250,7 +250,7 @@ tableau.extensions.dashboardContent.dashboard.worksheets.find(w => w.name === "S

You can also get the underlying data from the data sources for the worksheet. To do that, you must acquire the data sources for the worksheet with a call to the `getDataSourcesAsync()` method, which returns an array of the primary and all the secondary data sources of a worksheet. Once you have the data source object, you can access the underlying data and access information about the data source, such as the names of tables and fields and information about the connection.

Just like worksheet methods that access full data, the following methods for the data source also require that your extension specifies `full data` permissions in the `trex` file. See [Add permissions to access full data to manifest file](../security/trex_data_access#add-permissions-to-access-full-data-to-manifest-file).
Just like worksheet methods that access full data, the following methods for the data source also require that your extension specifies `full data` permissions in the `trex` file. See [Add permissions to access full data to manifest file](../security/trex_data_access.md#add-permissions-to-access-full-data-to-manifest-file).


| Method | Tableau Version | Extensions API Library | Status |
Expand Down
10 changes: 5 additions & 5 deletions website/docs/core/trex_tableau_viz.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ For Tableau Viz version 2, an `inputSpec` supports combination charts, multiple

```

For more information about the `inputSpec` for version 1 and version 2, see [Tableau Viz Reference](../trex_tableau_viz_ref).
For more information about the `inputSpec` for version 1 and version 2, see [Tableau Viz Reference](../trex_tableau_viz_ref.md).

---

Expand Down Expand Up @@ -194,7 +194,7 @@ The following shows what a version 2 `inputSpec` looks like when rendered by the
Now that you have seen the basic steps for adding a Tableau Viz to a dashboard extension, you can try adding Tableau Viz to your own dashboard extensions, or to one of the samples.
* For information about the Tableau Viz version 1 and version 2 `inputSpec` and all the options for specifying the visualization, see [Tableau Viz Reference](../trex_tableau_viz_ref).
* For information about the Tableau Viz version 1 and version 2 `inputSpec` and all the options for specifying the visualization, see [Tableau Viz Reference](../trex_tableau_viz_ref.md).
* Review the [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/extensions#createvizimageasync) method for information about the API.
Expand All @@ -204,14 +204,14 @@ Now that you have seen the basic steps for adding a Tableau Viz to a dashboard e
## Troubleshoot Tableau Viz images in dashboard extensions
You can use the same tools that you use to debug dashboard extensions to debug problems that occur when you use Tableau Viz to create images. For information about debugging your extension, see [Debug Extensions in Tableau Desktop](../debug/trex_debugging) and [Debug Extensions in Tableau Server and Tableau Cloud](../debug/trex_debug_server).
You can use the same tools that you use to debug dashboard extensions to debug problems that occur when you use Tableau Viz to create images. For information about debugging your extension, see [Debug Extensions in Tableau Desktop](../debug/trex_debugging.md) and [Debug Extensions in Tableau Server and Tableau Cloud](../debug/trex_debug_server.md).
### Tableau Viz Error Messages
The following is a list of common error messages that you might encounter and includes steps for fixing those errors. The error messages appear in the Console window when you use the Chrome or Chromium debugging tools.
For specific issues with the current release, see [Tableau Viz - Known Issues](../trex_known_issues#tableau-viz---known-issues).
For specific issues with the current release, see [Tableau Viz - Known Issues](../trex_known_issues.md#tableau-viz---known-issues).
#### Invalid Palette Name
Expand All @@ -229,4 +229,4 @@ When you encode the fields in the `inputSpec`, you need to make sure that the di
#### Invalid JSON
The `inputSpec` is a JavaScript object that Tableau converts to JSON for processing. The `inputSpec` needs to be in the correct format and must include all required elements. You must encode columns and fields. For the list of required elements, see [Tableau Viz Reference](../trex_tableau_viz_ref).
The `inputSpec` is a JavaScript object that Tableau converts to JSON for processing. The `inputSpec` needs to be in the correct format and must include all required elements. You must encode columns and fields. For the list of required elements, see [Tableau Viz Reference](../trex_tableau_viz_ref.md).
Loading

0 comments on commit f502935

Please sign in to comment.