Skip to content

Commit 1a164f0

Browse files
michellemontygitbook-bot
authored andcommitted
GITBOOK-152: Update to core fields doc
1 parent cbe236e commit 1a164f0

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

.gitbook/assets/image (3).png

80.1 KB
Loading

frequently-asked-questions/how-do-i-create-dynamic-on-off-toggles-for-my-map.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ For more info on hiding orphans, [visit this guide](../faq/how-do-i-hide-element
6262

6363
### Toggle connections
6464

65-
**To toggle **_**all**_** connections with the simple click of a button, use this code:** 
65+
**To toggle **_**all**_** connections with the simple click of a button, use this code:** 
6666

6767
```
6868
@controls {

guides/fields.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,27 @@ Fields allow you to save additional data about the elements, connections and loo
2020

2121
Kumu comes with a set of core fields. Putting data in _all_ of these fields isn't necessary, but they get special visual treatment in [profiles](profiles.md) and have special functionality, so it's great to use them when you can!
2222

23+
<figure><img src="../.gitbook/assets/image (3).png" alt="" width="300"><figcaption></figcaption></figure>
24+
2325
#### Label
2426

25-
Use the Label field to give names to elements, connections, and loops. Your element and loop labels will appear on the map by default, and connection labels can be shown on the map as well, using the `label-visibility` [property](../overview/advanced-editor-hub/property-reference.md) in the Advanced Editor.
27+
The Label field uniquely identifies an element, connection or loop. Look at it as the name for any of these entities. The label shows up all the way at the top of any element or connection profile. Your element, connection and loop labels will appear on the map by default. An element usually requires a label ([unless you're identifying by IDs](../faq/how-do-I-avoid-duplicating-data.md#use-ids-to-separate-identical-labels)), but a connection doesn't necessarily need to have a label, unless you like to give it one. Your map shows an element, connection or loop's label by default.
2628

2729
#### Type
2830

29-
Use the type field to categorize elements and connections. Common element types include person, project, and company. Common connection types include personal, business, and family.
31+
Use the Type field to categorize elements and connections. Common element types include 'person', 'project', or 'company'. Common connection types include the nature of the relationship, e.g. 'personal', 'business', or 'family'. What's important to note here is that Type values are _mutually exclusive,_ meaning that an element or connection type can only be one single value. For example, an element cannot be a 'person' and an 'organization' at the same time. &#x20;
3032

3133
#### Connection direction
3234

33-
In a connection's profile, you'll see whether a connection is directed, undirected, or mutual. When you export your map to Excel, you'll also see this field included in the Connections tab of your sheet. To change the connection direction, please visit [this guide](../faq/how-do-I-add-arrows-to-my-connections.md).
35+
In a connection's profile, you'll see whether a connection is directed, undirected, or mutual. Direction determines where/if an arrow is placed on one or both ends of a connection, and is used in [Metrics](metrics.md) calculations to analyze the structure of a network. When you export your map to Excel, you'll also see this field included in the Connections tab of your sheet. To change the connection direction, please visit [this guide](../faq/how-do-I-add-arrows-to-my-connections.md).
3436

3537
#### Description
3638

3739
The description field is designed to hold longer-form content that describes an item. Descriptions can include multiple paragraphs, and even multimedia content. You can use [Markdown](markdown.md) to format your text and [widgets](widgets.md) to add multimedia content.
3840

3941
#### Tags
4042

41-
The tags field is designed to hold multiple values that each describe your item in a different way. This field is usually used when an element can belong to _one or more_ categories. For example, a connection between a person and a non-profit might have the following tags: "Strong relationship", "Board Member", "Donor", and "Advocate", all stored as separate values in the Tags field, adding rich detail to that person's relationship with the non-profit.
43+
The tags field is designed to hold multiple values that each describe your item in a different way. This field is ideal for when an element can belong to _one or more_ categories that do not need to be mutually exclusive. For example, a connection between a person and a non-profit might have the following tags: "Strong relationship", "Board Member", "Donor", and "Advocate", all stored as separate values in the Tags field, adding rich detail to that person's relationship with the non-profit.
4244

4345
In the profile, tags appear under the description, and hovering your cursor over a tag will [showcase](showcase.md) other items with that same tag.
4446

0 commit comments

Comments
 (0)