Skip to content

Commit 3093535

Browse files
Merge pull request #273 from nocodb/docs/0901-cleanup
docs: field type corrections
2 parents 4c8b7be + b1e1c7e commit 3093535

File tree

10 files changed

+124
-144
lines changed

10 files changed

+124
-144
lines changed
Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,27 @@
11
---
22
title: 'Email'
3-
description: 'This article explains how to create & work with an Email field.'
3+
description: 'This article explains how to create and use an Email field.'
44
tags: ['Fields', 'Field types', 'Text based types', 'Email']
55
keywords: ['Fields', 'Field types', 'Text based types', 'Email', 'Create email field']
66
---
77

8+
The **Email** field is a text-based field designed specifically for storing email addresses. It is a specialized version of the **Single line text** field with the following enhancements:
89

9-
`Email` field is text based field custom-built for storing E-mail IDs. It is a special type of `Single line text` field with
10-
- Optional validation for Email ID
11-
- Cell display as clickable link
10+
- Optional validation to ensure values follow a valid email format
11+
- Display of values as clickable email links
1212

13-
## Create an `Email` field
14-
1. Click on `+` icon to the right of `Fields header`
15-
2. On the dropdown modal, enter the field name (Optional).
16-
3. Select the field type as `Email` from the dropdown.
17-
4. Enable validation by toggling the `Validate Email` checkbox (Optional).
18-
5. Set default value for the field (Optional).
19-
6. Click on `Save Field` button.
13+
## Create an Email field
2014

21-
![image](/img/v2/fields/types/email.png)
15+
1. Click the `+` icon next to the last field in your table.
16+
2. Enter a name for the field.
17+
3. Select **Email** as the field type.
18+
4. (Optional) Enable validation by toggling the **Validate Email** option.
19+
5. (Optional) Set a default value for the field and add a description.
20+
6. Click **Save field** to add it to your table.
2221

23-
<Callout type="note">
24-
- Specify default value without quotes.
25-
- Validation only ensures that the value entered is a valid email ID. It does not check if the email ID exists.
26-
</Callout>
22+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
2723

28-
## Similar text based fields
29-
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
30-
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
31-
- [Long text](/docs/product-docs/fields/field-types/text-based/long-text)
32-
- [URL](/docs/product-docs/fields/field-types/text-based/url)
33-
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)
24+
<Callout type="note">Validation only ensures the format is a valid email address; it does not verify whether the email address exists</Callout>
3425

26+
---
3527

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
---
22
title: 'Long text'
3-
description: 'This article explains how to create & work with a Long text field.'
3+
description: 'This article explains how to create and use a Long text field.'
44
tags: ['Fields', 'Field types', 'Text based types', 'Long text']
55
keywords: ['Fields', 'Field types', 'Text based types', 'Long text', 'Create long text field']
66
---
77

8+
The **Long text** field is a text-based field that supports multiple lines of text. It is ideal for storing extended content such as descriptions, notes, or comments.
89

9-
`Long Text` field is text based field that allows text in multiple lines. It is useful for storing lengthy text like description, notes, etc.
10+
<Callout type="warning">Limit: 100,000 characters</Callout>
1011

11-
## Create a `Long Text` field
12-
1. Click on `+` icon to the right of `Fields header`
13-
2. On the dropdown modal, enter the field name (Optional).
14-
3. Select the field type as `Long text` from the dropdown.
15-
4. Set default value for the field (Optional).
16-
5. Click on `Save Field` button.
12+
## Create a Long text field
1713

18-
![image](/img/v2/fields/types/longtext.png)
14+
1. Click the `+` icon next to the last field in your table.
15+
2. Enter a name for the field.
16+
3. Select **Long text** from the list of field types.
17+
4. (Optional) Enable **Rich text** formatting. Learn more [here](/docs/product-docs/fields/field-types/text-based/rich-text).
18+
5. (Optional) Set a default value for the field and add a description.
19+
6. Click **Save field** to add the field to your table.
1920

20-
:::note
21-
- Specify default value without quotes.
22-
- Use `Enter` key to add new line.
23-
:::
21+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
2422

25-
### Cell display
26-
`Long Text` field is displayed as a single line text field in the table view. Click on the expand icon in the cell to view the full text.
23+
<Callout type="info">Enter the default value without quotes. Use the `Enter` key to add a new line.</Callout>
2724

28-
![image](/img/v2/fields/long-text-expand.png)
29-
![image](/img/v2/fields/long-text-expand-2.png)
25+
## Cell display
3026

27+
The **Long text** field appears as a standard text cell in the table. The number of visible lines depends on the row height.
3128

32-
## Similar text based fields
33-
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
34-
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
35-
- [URL](/docs/product-docs/fields/field-types/text-based/url)
36-
- [Email](/docs/product-docs/fields/field-types/text-based/email)
37-
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)
29+
![image](/img/v2/fields/types/long-text/expand.png)
3830

31+
Double-clicking the cell, or pressing the `Enter` key while the cell is selected, expands the editor to display more lines for inline editing.
3932

33+
![image](/img/v2/fields/types/long-text/expand-3.png)
34+
35+
Alternatively, click the **Expand** icon in the cell to pop out a larger editor for easier editing. Pop-up editor can be resized by dragging its bottom-right corner & moved around by dragging its header.
36+
37+
![image](/img/v2/fields/types/long-text/expand-2.png)
38+
39+
---
Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,23 @@
11
---
22
title: 'Phone Number'
3-
description: 'This article explains how to create & work with a Phone number field.'
3+
description: 'This article explains how to create and use a Phone number field.'
44
tags: ['Fields', 'Field types', 'Text based types', 'Phone number']
55
keywords: ['Fields', 'Field types', 'Text based types', 'Phone number', 'Create phone number field']
66
---
77

8+
The **Phone number** field is a text-based field designed for storing phone numbers. It provides an option to validate values to ensure they follow a valid phone number format.
89

9-
`Phone number` field is text based field that allows you to store phone numbers. It also allows you to validate the phone number.
10+
## Create a Phone number field
1011

11-
## Create a `Phone number` field
12-
1. Click on `+` icon to the right of `Fields header`
13-
2. On the dropdown modal, enter the field name (Optional).
14-
3. Select the field type as `Phonenumber` from the dropdown.
15-
4. Enable validation by toggling the `Validate Phonenumber` checkbox (Optional).
16-
5. Set default value for the field (Optional).
17-
6. Click on `Save Field` button.
12+
1. Click the `+` icon next to the last field in your table.
13+
2. Enter a name for the field.
14+
3. Select **Phone number** as the field type.
15+
4. (Optional) Enable validation by toggling the **Validate Phone number** option.
16+
5. (Optional) Set a default value for the field and add a description.
17+
6. Click **Save field** to add it to your table.
1818

19-
![image](/img/v2/fields/types/phonenumber.png)
20-
21-
<Callout type="note">
22-
- Specify default value without quotes.
23-
- Validation only ensures that the value entered is a valid phone number. It does not check if the phone number exists.
24-
</Callout>
25-
26-
## Similar text based fields
27-
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
28-
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
29-
- [Long text](/docs/product-docs/fields/field-types/text-based/long-text)
30-
- [URL](/docs/product-docs/fields/field-types/text-based/url)
31-
- [Email](/docs/product-docs/fields/field-types/text-based/email)
19+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
3220

21+
<Callout type="note">Validation only ensures the format is a valid phone number; it does not verify whether the number exists</Callout>
3322

23+
---
Lines changed: 59 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
---
22
title: 'Rich text'
3-
description: 'This article explains how to create & work with a Rich text field.'
3+
description: 'This article explains how to create and use a Rich text field.'
44
tags: ['Fields', 'Field types', 'Text based types', 'Rich text']
55
keywords: ['Fields', 'Field types', 'Text based types', 'Rich text', 'Create rich text field']
66
---
77

8+
The **Rich text** field is an extension of the **Long text** field that supports text formatting. It allows you to style content with options such as bold, italic, underline, strikethrough, horizontal rules, ordered and unordered lists, code blocks, quotes, and more.
89

9-
`Rich Text` field is text based field & is extension of `Long text` that allows you to add formatting to the text. You can add text formatting like bold, italic, underline, strikethrough, horizontal rule, ordered list, unordered list, code, quote, etc.
10+
<Callout type="warning">Limit: 100,000 characters</Callout>
1011

11-
## Create a `Rich Text` field
12-
1. Click on `+` icon to the right of `Fields header`
13-
2. On the dropdown modal, enter the field name (Optional).
14-
3. Select the field type as `Long text` from the dropdown.
15-
4. Enable `Rich Text` toggle field.
16-
5. Set default value for the field (Optional).
17-
6. Click on `Save Field` button.
12+
## Create a Rich text field
1813

19-
![image](/img/v2/fields/types/richtext.png)
14+
1. Click the `+` icon to the right of the **Fields** header.
15+
2. Enter a field name (optional).
16+
3. Select **Long text** as the field type.
17+
4. Enable the **Rich text** toggle.
18+
5. (Optional) Set a default value for the field and add a description.
19+
6. Click **Save field** to add it to your table.
2020

21-
:::note
22-
- Specify default value without quotes.
23-
- Use `Enter` key to add new line.
24-
:::
21+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
2522

26-
### Cell display
27-
`Rich Text` field is displayed as a single line text field in the table view. Click on the expand icon in the cell to view the full text.
23+
<Callout type="info">Enter the default value without quotes. Use the `Enter` key to add a new line.</Callout>
2824

29-
![image](/img/v2/fields/long-text-expand.png)
30-
![image](/img/v2/fields/long-text-expand-2.png)
25+
## Cell display
26+
27+
28+
In the table view, the **Rich text** field appears as a single-line cell. To view or edit the full content, click the **Expand** icon.
29+
30+
![image](/img/v2/fields/types/long-text/rich-text-expand.png)
3131

3232

3333
## Formatting options
34-
NocoDB supports markdown syntax for formatting the text. Following are the supported formatting options.
34+
NocoDB supports Markdown syntax for formatting the text. Sections below explain various formatting options available in the rich text editor.
3535

3636
### Heading
3737
To create a heading, prefix `#` symbol preceding your heading text. The number of # symbols employed will dictate the heading's hierarchy level and typeface size. Three levels of headings are supported.
@@ -47,43 +47,55 @@ To create a heading, prefix `#` symbol preceding your heading text. The number o
4747
### Text formatting
4848
You can emphasise text with bold, italic, strikethrough or underline formatting options. Table below shows syntax, keyboard shortcut, example & output for each formatting option.
4949

50-
| Style | Syntax | Keyboard shortcut | Example | Output |
51-
| --- | --- | --- | --- | --- |
52-
| Bold | `**bold text**` | `Ctrl/Cmd + B` | `**This is bold text**` | **This is bold text** |
53-
| Italic | `*italicized text*` | `Ctrl/Cmd + I` | `*This is italicized text*` | *This is italicized text* |
54-
| Strikethrough | `~~strikethrough text~~` | `Ctrl/Cmd + Shift + X` | `~~This is strikethrough text~~` | ~~This is strikethrough text~~ |
55-
| Underline | | `Ctrl/Cmd + U` | `This is underlined text` | <u>This is underlined text</u> |
50+
| Style | Syntax | Keyboard shortcut | Output |
51+
|---------------|--------------------------|------------------------|--------------------------------|
52+
| Bold | `**bold text**` | `Ctrl/Cmd + B` | **bold text** |
53+
| Italic | `*italicized text*` | `Ctrl/Cmd + I` | *italicized text* |
54+
| Strikethrough | `~~strikethrough text~~` | `Ctrl/Cmd + Shift + X` | ~~strikethrough text~~ |
55+
| Underline | | `Ctrl/Cmd + U` | <u>underlined text</u> |
56+
5657

5758
### Quote block
5859
You can quote text with a `>`
5960

61+
**Usage**
6062
```
6163
normal text
6264
> quoted text
6365
```
6466

67+
**Display**
68+
6569
normal text
6670
> quoted text
6771
6872
### Code block
69-
Code block can be created by using (3 backticks) before & after the code.
73+
Code block can be created by using (3 backticks) before & after the code.
74+
75+
**Usage**
76+
7077
````
7178
```
7279
This is a code block
7380
```
7481
````
7582

83+
**Display**
84+
7685
```
7786
This is a code block
7887
```
7988

8089
### Link
81-
You can create an inline link by using `Link` menu option in the rich text toolbar
90+
Use the **Link** option in the rich text toolbar to add inline links. Alternatively, you can use markdown syntax `[link text](URL)`.
91+
8292

83-
![image](/img/v2/fields/types/richtext-links.png)
8493

8594
### Bullet List
86-
You can create unordered list by using `Bulleted list` menu option in the rich text toolbar or by preceding the text with `-` `+` or `*` symbol.
95+
You can create an unordered list using the **Bulleted list** option in the toolbar or by starting lines with `-`, `+`, or `*`.
96+
97+
**Usage**
98+
8799
```
88100
- Item 1
89101
- Item 2
@@ -95,6 +107,8 @@ You can create unordered list by using `Bulleted list` menu option in the rich t
95107
* Item 2
96108
```
97109

110+
**Display**
111+
98112
- Item 1
99113
- Item 2
100114

@@ -104,34 +118,36 @@ You can create unordered list by using `Bulleted list` menu option in the rich t
104118
* Item 1
105119
* Item 2
106120

107-
:::note
108-
You can create nested lists by using `tab` key & `shift + tab` key to indent & outdent the list items.
109-
:::
121+
<Callout type="info">You can create nested lists by using `tab` key & `shift + tab` key to indent & outdent the list items</Callout>
110122

111123
### Numbered List
112-
You can create ordered list by using `Numbered list` menu option in the rich text toolbar or by preceding the text with `1.` symbol.
124+
You can create an ordered list using the **Numbered list** option in the toolbar or by prefixing text with numbers.
125+
126+
**Usage**
127+
113128
```
114129
1. Item 1
115130
2. Item 2
116131
```
132+
133+
**Display**
134+
117135
1. Item 1
118136
2. Item 2
119137

120138
### Task list
121-
You can create task lists by using `Task list` menu option in the rich text toolbar or by preceding the text with `[ ]` symbol. You can mark the task as completed by using `[x]` symbol.
139+
You can create task lists using the **Task list** option in the toolbar or with `[ ]` and `[x]` for incomplete and completed tasks.
140+
141+
**Usage**
142+
122143
```
123144
[ ] Item 1
124145
[x] Item 2
125146
```
126-
- [ ] Item 1
127-
- [x] Item 2
128-
129147

130-
## Similar text based fields
131-
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
132-
- [Single line text](/docs/product-docs/fields/field-types/text-based/single-line-text)
133-
- [URL](/docs/product-docs/fields/field-types/text-based/url)
134-
- [Email](/docs/product-docs/fields/field-types/text-based/email)
135-
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)
148+
**Display**
136149

150+
- [ ] Item 1
151+
- [x] Item 2
137152

153+
---

content/docs/fields/field-types/text-based/single-line-text.mdx

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The **Single line text** field is used to store short, freeform text values. It
99

1010
<Callout type="warning">Limit: 100,000 characters</Callout>
1111

12-
## Create a single line text field
12+
## Create a Single line text field
1313

1414
1. Click on the `+` icon next to the last field in your table.
1515
2. Enter a name for the field.
@@ -21,12 +21,4 @@ Refer here for generic guidelines on [creating a field](/docs/product-docs/field
2121

2222
<Callout type="info">Specify default value as is, without quotes</Callout>
2323

24-
## Similar text based fields
25-
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
26-
- [Long text](/docs/product-docs/fields/field-types/text-based/long-text)
27-
- [URL](/docs/product-docs/fields/field-types/text-based/url)
28-
- [Email](/docs/product-docs/fields/field-types/text-based/email)
29-
- [Phone](/docs/product-docs/fields/field-types/text-based/phonenumber)
30-
31-
32-
24+
---

0 commit comments

Comments
 (0)