Skip to content

Commit

Permalink
Fix / update links (#468)
Browse files Browse the repository at this point in the history
Fix / update links
- Found and fixed a bunch of links after running a link checker on the whole site.
- Couple of minor indent adjustments
  • Loading branch information
bcantoni authored Feb 10, 2022
1 parent 7fbe542 commit e2740b9
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion _includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="{{ site.baseurl }}/docs/trex_getstarted.html">Docs</a></li>
<li><a href="{{ site.baseurl }}/docs/ux_design.html "target="_blank">Design Guidelines</a></li>
<li><a href="{{ site.baseurl }}/docs/ux_design.html" target="_blank">Design Guidelines</a></li>
<li><a href="{{ site.baseurl }}/docs/index.html" target="_blank">API Reference</a></li>
<li><a href="{{ site.baseurl }}/docs/trex_examples.html">Samples</a></li>
<li><a href="{{ site.baseurl }}/community/">Community Extensions</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/Interaction_Guidelines/ux_build_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Once you're ready to go, you can start building and customizing your extension.

* [Extensions API Documentation](https://tableau.github.io/extensions-api/)<br>The Extensions API includes all the information you need to build an extension.

* [Community Forums](https://community.tableau.com/community/developers/extensions-api/overview)<br>Participate in a community of developers that are passionate about creating extensions.
* [Community Forums](https://community.tableau.com/s/topic/0TO4T000000QFALWA4/extensions-api)<br>Participate in a community of developers that are passionate about creating extensions.

* [Tableau Exchange](https://exchange.tableau.com/)<br>Explore and use some of the extensions our partners have created.

Expand All @@ -45,7 +45,7 @@ After you've completed making your extension, you may want to share your extensi
Tableau has released the [Extension Gallery](https://extensiongallery.tableau.com/), a place to explore and download some extensions that our partners have created. If you would like to share your extension to our gallery, learn more at [Sharing to the Extension Gallery]({{site.baseurl}}/docs/ux_extension_gallery.html).

##### Community Forums
Tableau also has a [Community Forum](https://community.tableau.com/community/developers/extensions-api/overview) for developers to discuss extensions and the Extensions API.
Tableau also has a [Community Forum](https://community.tableau.com/s/topic/0TO4T000000QFALWA4/extensions-api) for developers to discuss extensions and the Extensions API.

----- &nbsp;

Expand Down
6 changes: 3 additions & 3 deletions docs/Interaction_Guidelines/ux_controls_ui_patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We've provided examples of controls that are used in Tableau. Using the exact st
* [Text Fields](#text-fields)
* [Tooltips](#tooltips)

The controls described here use Tableau branding, accessible from the **[Color](Style Guidelines/6 - Color.md)** and **[Fonts](Style Guidelines/7 - Fonts.md)** 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 @@ -62,7 +62,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/6 - Color.md)**.<br><br>You may also want to utilize branding practices on buttons. Learn more at **[Branding your Extension](Style Guidelines/4 - Branding your Extension.md)**. |
| **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><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 @@ -101,7 +101,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](2 - Extension Components and Modes.md)**.
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
6 changes: 3 additions & 3 deletions docs/Interaction_Guidelines/ux_interaction.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Interaction Guidelines

### [1 – Build, Test, Share](Interaction Guidelines/1 - Build, Test, Share.md)
### [1 – Build, Test, Share](ux_build_test.md)
The developer's roadmap for how to get started developing and designing extensions.

&nbsp;

### [2 – Extension Components and Modes](Interaction Guidelines/2 - Extension Components and Modes.md)
### [2 – Extension Components and Modes](ux_components_modes.md)
The main user-facing components of an extension to create content for. Learn about modes for configuring extensions, viewing extensions, and dashboard user types.

&nbsp;

### [3 – Controls and UI Patterns](Interaction Guidelines/3 - Controls and UI Patterns.md)
### [3 – Controls and UI Patterns](ux_controls_ui_patterns.md)
Usage and design specifications for user interface controls and patterns in your extension.

###### *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
4 changes: 2 additions & 2 deletions 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/2 - Extension Components and Modes.md)**
* **[Controls and UI Patterns](Interaction Guidelines/3 - Controls and UI Patterns.md)**
* **[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 docs/Style_Guidelines/ux_color.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,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](4 - Branding your Extension.md)**.
**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 docs/Style_Guidelines/ux_fonts.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,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. <i>Learn more about Tableau font colors at **[Color](6 - Color.md)**.</i>
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 All @@ -56,7 +56,7 @@ Using some of these common fonts that are likely available on your user's machin


###### Font Size
It is important to compensate for OS and device specific DPI and font rendering. Since these are alternative fonts that aren't directly used in Tableau, you may choose to use different font sizes and weights based on your extension's design needs.
It is important to compensate for OS and device specific DPI and font rendering. Since these are alternative fonts that aren't directly used in Tableau, you may choose to use different font sizes and weights based on your extension's design needs.

&nbsp;

Expand Down
2 changes: 1 addition & 1 deletion docs/Style_Guidelines/ux_layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ 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/3 - Controls and UI Patterns.md)** and **[Branding your Extension](4 - Branding your Extension.md)**.
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:

Expand Down
2 changes: 1 addition & 1 deletion docs/trex_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The [Samples-Typescript](https://github.com/tableau/extensions-api/tree/master/S

Shows how you can use Tableau Viz to add visualizations to your dashboard extensions. This sample demonstrates the effects of different mark types and color palettes. For more information about Tableau Viz, see [Add Tableau Viz to Your Dashboard Extensions]({{site.baseurl}}/docs/trex_tableau_viz.html).

**[Formatting](https://github.com/tableau/extensions-api/tree/main/Samples/Formatting?=target="_blank")**
- **[Formatting](https://github.com/tableau/extensions-api/tree/main/Samples/Formatting?=target="_blank")**

Shows how you can access the CSS formatting in the Tableau workbook and apply it to the HTML elements in your dashboard extension. Create a consistent look and feel across the extension and the dashboard.

Expand Down
4 changes: 2 additions & 2 deletions docs/trex_release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -642,9 +642,9 @@ Error: internal-error: permission-denied: Missing required permission to run get
Errors that are returned from the Extensions API are custom Tableau Error objects that extends the standard JavaScript error object.


The Extensions API wraps the standard error object with an `errorCode` property. Any time you encounter an error when you are developing your extension, you can look at this `errorCode` to determine the cause. See [Error Codes]({{site.baseurl}}/docs/enums/errorcodes.html).
The Extensions API wraps the standard error object with an `errorCode` property. Any time you encounter an error when you are developing your extension, you can look at this `errorCode` to determine the cause. See [Error Codes]({{site.baseurl}}/docs/enums/tableau.errorcodes.html).

For an example of how to handle error conditions, see the [UINamepace](https://github.com/tableau/extensions-api/tree/master/Samples/UINamepace?=target="_blank") sample. The sample shows how you could handle the error condition that occurs if a user dismisses a modal dialog box (`DialogClosedByUser`). The following snippet illustrates this pattern:
For an example of how to handle error conditions, see the [UINamespace](https://github.com/tableau/extensions-api/tree/main/Samples/UINamespace?=target="_blank") sample. The sample shows how you could handle the error condition that occurs if a user dismisses a modal dialog box (`DialogClosedByUser`). The following snippet illustrates this pattern:

```javascript
tableau.extensions.ui.displayDialogAsync(args... ).then((args... ) => {
Expand Down
2 changes: 1 addition & 1 deletion docs/trex_sandbox_publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Be sure to follow the guidelines and requirements to [Create and Test Sandboxed
After you finish developing and testing your Sandboxed Extension, fill out the [Tableau Exchange Submission form](https://tabsoft.co/gallerysubmit){:target="_blank"}{:ref="noopener"} with your information and details about your extension.
For information about what goes in the form, see [Submitting your Extension to the Tableau Exchange]({{site.baseurl}}/docs/ux_extension_gallery.html){:target="_blank"}.

Our developers from the Developer Platform team at Tableau will let you know the next steps including legal agreements after you submit your information. If you have any questions about the gallery please send them to [[email protected]]([email protected]){:target="_blank"}{:ref="noopener"}.
Our developers from the Developer Platform team at Tableau will let you know the next steps including legal agreements after you submit your information. If you have any questions about the gallery please send them to [[email protected]](mailto:[email protected]){:target="_blank"}{:ref="noopener"}.

Once accepted, Tableau will publish your extension and your extension will be available in the [Tableau Exchange](https://extensiongallery.tableau.com/){:target="_blank"}{:ref="noopener"}.

Expand Down
2 changes: 1 addition & 1 deletion docs/trex_tableau_viz.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ For specific issues with the current release, see [Tableau Viz - Known Issues]({

`Error: internal-error: {"vizapiErrorMsg":"Invalid Palette Name"}`

Be sure that you use one of the palette names listed for the `color` key under encoding in the `inputSpec`. See [Encoding]({{site.baseurl}}/docs/viz_reference.html#encoding). Note that the palette must be supported by the version of Tableau that you are using, and that the palette colors are subject to change. In addition, there are some palette colors can only be used for continuous or discrete fields, but not for both.
Be sure that you use one of the palette names listed for the `color` key under encoding in the `inputSpec`. See [Encoding]({{site.baseurl}}/docs/trex_tableau_viz_ref.html#encoding). Note that the palette must be supported by the version of Tableau that you are using, and that the palette colors are subject to change. In addition, there are some palette colors can only be used for continuous or discrete fields, but not for both.


#### Encoding column (or row) has invalid type
Expand Down
6 changes: 3 additions & 3 deletions docs/trex_typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ The Extensions API is a JavaScript library. If you author in TypeScript, Tableau
**In this section**

- TOC
{:toc}
{:toc}

<div class="alert alert-info"><b>Note</b> If you want to examine and use TypeScript versions of several of the sample extensions in the <b>Samples</b> folder, see <a href="https://github.com/tableau/extensions-api/tree/master/Samples-Typescript" target="_blank">Samples-Typescript (GitHub)</a> and follow the instructions to <a href="https://tableau.github.io/extensions-api/docs/trex_examples.html#use-the-typescript-samples" target="_blank">Use the TypeScript Samples</a>.
<div class="alert alert-info"><b>Note</b> If you want to examine and use TypeScript versions of several of the sample extensions in the <b>Samples</b> folder, see <a href="https://github.com/tableau/extensions-api/tree/main/Samples-Typescript" target="_blank">Samples-Typescript (GitHub)</a> and follow the instructions to <a href="https://tableau.github.io/extensions-api/docs/trex_examples.html#use-the-typescript-samples" target="_blank">Use the TypeScript Samples</a>.
</div>

## Install the Tableau Extensions API TypeScript types
Expand Down Expand Up @@ -100,4 +100,4 @@ In the HTML code for the extensions, the JavaScript files are referenced. The fo

- [TypeScript in Visual Studio Code](https://code.visualstudio.com/docs/languages/typescript?=target="_blank")

- [TypeScript Sample Extensions (GitHub)](https://github.com/tableau/extensions-api/tree/master/Samples-TypeScript) and [Use the TypeScript samples]({{site.baseurl}}/docs/trex_examples.html#use-the-typescript-samples)
- [TypeScript Sample Extensions (GitHub)](https://github.com/tableau/extensions-api/tree/main/Samples-Typescript) and [Use the TypeScript samples]({{site.baseurl}}/docs/trex_examples.html#use-the-typescript-samples)

0 comments on commit e2740b9

Please sign in to comment.