Skip to content

Commit

Permalink
Merge pull request #248 from gristlabs/Column-&-Widget-Descriptions
Browse files Browse the repository at this point in the history
Column & Widget Descriptions
  • Loading branch information
nataliemisasi committed Jul 18, 2023
2 parents 557c5cd + 4ad159b commit add265b
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 11 deletions.
32 changes: 24 additions & 8 deletions help/col-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,34 @@ reorder them. You can also hide columns here.
## Renaming columns

You can rename columns in several ways. One way is to
click on the column header when the column is already selected.
Another is to hover on the column
header, click on the drop-down, then select "Rename Column".
Another is by selecting "Column Options" in the same drop-down, and editing the "Field"
name shown at the top. A bonus with this method is that you can also control
double click a column header. Then, you can rename the column or add a column description.

*![rename columns](images/columns/columns-rename-header.png)*
{: .screenshot-half }

You can also hover on the column header, click on the drop-down, then select "Rename Column". This opens the same
pop up seen above.

*![rename columns](images/columns/columns-rename-renamecolumn.png)*
{: .screenshot-half }

Selecting "Column Options" in the same drop-down opens the Creator Panel. From here, you can edit the
Column Label, shown at the top or add a description.

*![rename columns](images/columns/columns-rename-creatorpanel.png)*
{: .screenshot-half }

A bonus with this method is that you can also control
the identifier given to the column
in formulas. By default this is based on the field name, with any
characters Python doesn't like replaced with "\_", and a number added if needed
to keep the name unique within your table. If you don't like this identifier, you
can change it, though it will still need to be Python-friendly. To change
the name, deselect "Use Name as ID" if it is selected, and edit the "ID" entry now
shown.
can change it, though it will still need to be Python-friendly. Click the link icon to make the
ID field editable, then enter the new Column ID.

*![rename columns](images/columns/columns-rename-col-id.png)*
{: .screenshot-half }


## Specifying a type

Expand Down
Binary file modified help/images/change_widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added help/images/columns/columns-rename-col-id.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added help/images/columns/columns-rename-header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added help/images/widgets-renaming-creator-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified help/images/widgets-renaming.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added help/images/widgets-widget-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 8 additions & 3 deletions help/page-widgets.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,16 @@ right-side panel. Click on "Change Widget".
*![change_widget](images/change_widget.png)*
{: .screenshot-half }

You can then use the widget picker to change the widget or the data it displays. You may also edit the widget's title.
You can then use the widget picker to change the widget or the data it displays. You may also edit the widget's title or add a description.

You can also edit the widget's title, or the underlying data table's name by clicking on the widget title above a widget. By default, the widget title is the data table's name. Learn more about data tables in the [raw data page](raw-data.md).
## Renaming widgets

![Renaming Widgets](images/widgets-renaming.png)
You can rename widgets in several ways. We saw in the section above that you can edit a widget's title or add a description from the Widget tab of the Creator Panel.

Another way is to click on the widget title above a widget. From here, you can edit the widget's title, the underlying data table's name or add a description. By default, the widget title is the data table's name. To override this, enter a new title under 'Widget Title'. Learn more about data tables in the [raw data page](raw-data.md).

*![Renaming Widgets](images/widgets-renaming.png)*
{: .screenshot-half }

## Configuring field lists

Expand Down

0 comments on commit add265b

Please sign in to comment.