Browse Source

docs: columns as fields

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
371abc9da6
  1. 2
      packages/noco-docs/docs/020.getting-started/040.keyboard-shortcuts.md
  2. 4
      packages/noco-docs/docs/050.tables/030.create-table-via-import.md
  3. 8
      packages/noco-docs/docs/050.tables/040.import-data-into-existing-table.md
  4. 2
      packages/noco-docs/docs/060.table-operations/030.filter.md
  5. 2
      packages/noco-docs/docs/070.fields/030.display-value.md
  6. 2
      packages/noco-docs/docs/070.fields/040.field-types/040.links-based/010.links.md
  7. 4
      packages/noco-docs/docs/070.fields/040.field-types/040.links-based/020.lookup.md
  8. 2
      packages/noco-docs/docs/070.fields/040.field-types/040.links-based/030.rollup.md
  9. 2
      packages/noco-docs/docs/070.fields/040.field-types/050.custom-types/040.QR-code.md
  10. 2
      packages/noco-docs/docs/070.fields/040.field-types/050.custom-types/050.barcode.md
  11. 4
      packages/noco-docs/docs/070.fields/040.field-types/050.custom-types/080.json.md
  12. 2
      packages/noco-docs/docs/070.fields/040.field-types/070.date-time-based/010.date-time.md
  13. 2
      packages/noco-docs/docs/070.fields/040.field-types/070.date-time-based/020.date.md
  14. 2
      packages/noco-docs/docs/080.records/030.expanded-record.md
  15. 4
      packages/noco-docs/docs/080.records/070.actions-on-record.md
  16. 2
      packages/noco-docs/docs/090.views/040.view-types/010.grid.md
  17. 2
      packages/noco-docs/docs/150.engineering/050.playwright.md
  18. 2
      packages/noco-docs/docs/150.engineering/070.translation.md

2
packages/noco-docs/docs/020.getting-started/040.keyboard-shortcuts.md

@ -49,7 +49,7 @@ To navigate within ⌘+K menu,
| `alt` + `r` | Inserts new record in grid view |
## Column type specific shortcuts
## Field type specific shortcuts
| Datatype | Key | Behaviour |
|:----------------------:|------------:|:-----------------------------------|
| Text & Numerical cells | `←` `→` | Move cursor to the left / right |

4
packages/noco-docs/docs/050.tables/030.create-table-via-import.md

@ -48,8 +48,8 @@ There are two ways to upload source file:
### Import configurations
1. `Table name` - defaults to the name of the file; double click to edit (Optional).
2. `Field configurations` (Optional)
- `Field name` - name of the column as identified from import file header; click to edit.
- `Field type` - inferred from the data in the column; click to edit.
- `Field name` - name of the field as identified from import file header; click to edit.
- `Field type` - inferred from the data in the field; click to edit.
- `Options` - For `Single select` and `Multi select` field types, options identified are listed here; click to edit.
3. `Remove field` - Click on delete icon to exclude a field in source file from being imported (Optional)
4. Click on `Import` button to start importing the file.

8
packages/noco-docs/docs/050.tables/040.import-data-into-existing-table.md

@ -39,12 +39,12 @@ There are two ways to upload source file:
- Defaults to the name of the file; double-click to edit.
2. **Mapping Columns** (Optional)
- Existing column names are listed under `Source column`, while new columns identified from the import file are listed under `Destination column`.
- NocoDB automatically maps destination column names based on the source column names.
- You can reconfigure the mapping by utilizing the dropdown menu that appears when you click on the destination column.
- Existing field names are listed under `Source column`, while new columns identified from the import file are listed under `Destination column`.
- NocoDB automatically maps destination field names based on the source field names.
- You can reconfigure the mapping by utilizing the dropdown menu that appears when you click on the destination field.
3. **Exclude Columns** (Optional)
- A checkbox is provided to exclude a column from being imported.
- A checkbox is provided to exclude a field from being imported.
4. **Initiate Import**
- Click on the `Import` button to commence the file import process.

2
packages/noco-docs/docs/060.table-operations/030.filter.md

@ -12,7 +12,7 @@ To add or edit a filter, simply click the `Filter` button in the toolbar and sel
![Add Filter](/img/v2/table-operations/filter-1.png)
Configure the filter by specifying the `Column,` `Operation,` and `Value` (if applicable).
Configure the filter by specifying the `Field,` `Operation,` and `Value` (if applicable).
![Filter Configuration](/img/v2/table-operations/filter-2.png)

2
packages/noco-docs/docs/070.fields/030.display-value.md

@ -7,7 +7,7 @@ keywords : ['NocoDB display value', 'display value', 'display value in nocoDB',
# Display Value
The `Display Value`, as its name suggests, serves as the primary or main value within a record of a table, and it is typically the attribute by which we identify or associate that specific record. While it is advisable for the display value to be linked to a column with unique identifiers, such as a primary key, it's important to note that this uniqueness is not always enforced at the database level.
The `Display Value`, as its name suggests, serves as the primary or main value within a record of a table, and it is typically the attribute by which we identify or associate that specific record. While it is advisable for the display value to be linked to a field with unique identifiers, such as a primary key, it's important to note that this uniqueness is not always enforced at the database level.
## Use of Display Value
- Within a spreadsheet, `Display Value` are always highlighted so that it is easier to recognise what record we are working with.

2
packages/noco-docs/docs/070.fields/040.field-types/040.links-based/010.links.md

@ -16,7 +16,7 @@ NocoDB supports following types of relations:
:::note
- Links can be created only between tables in the same database.
- Self-referencing links are supported. (Link to the same table)
- For every `Has-Many` relation defined, NocoDB augments `Belongs-to` relationship column in the adjacent table automatically
- For every `Has-Many` relation defined, NocoDB augments `Belongs-to` relationship field in the adjacent table automatically
:::
## Create a link field

4
packages/noco-docs/docs/070.fields/040.field-types/040.links-based/020.lookup.md

@ -4,7 +4,7 @@ tags: ['Fields', 'Field types', 'Links based types', 'Lookup']
---
`Lookup` fields help bring additional column information from related table into the current table. This is useful when you want to display additional information about a record in a table. For example, if you have a table of `Orders` and a table of `Customers`, you can use a `Lookup` field to display the customer's name and address in the `Orders` table.
`Lookup` fields help bring additional field information from related table into the current table. This is useful when you want to display additional information about a record in a table. For example, if you have a table of `Orders` and a table of `Customers`, you can use a `Lookup` field to display the customer's name and address in the `Orders` table.
## Create a Lookup Field
@ -12,7 +12,7 @@ tags: ['Fields', 'Field types', 'Links based types', 'Lookup']
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Lookup` from the dropdown.
4. Select the link column from the dropdown. This is the column that links the current table to the related table.
4. Select the link field from the dropdown. This is the field that links the current table to the related table.
5. Select the column for display from the dropdown. This is the column that will be displayed in the current table.
6. Click on `Save Column` button.

2
packages/noco-docs/docs/070.fields/040.field-types/040.links-based/030.rollup.md

@ -10,7 +10,7 @@ tags: ['Fields', 'Field types', 'Links based types', 'Rollup']
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Lookup` from the dropdown.
4. Select the link column from the dropdown. This is the column that links the current table to the related table.
4. Select the link field from the dropdown. This is the field that links the current table to the related table.
5. Select the column for display from the dropdown. This is the column that will be displayed in the current table.
6. Select the aggregation function from the dropdown. This is the function that will be used to aggregate the data.
7. Click on `Save Column` button.

2
packages/noco-docs/docs/070.fields/040.field-types/050.custom-types/040.QR-code.md

@ -6,7 +6,7 @@ tags: ['Fields', 'Field types', 'Custom types', 'QR code']
`QR code` is a custom field type that allows you to generate a QR code from a string value. This is useful for generating QR codes for things like URLs, phone numbers, or other data that can be represented as a string.
The following column types are supported for the reference column:
The following field types are supported for the reference field:
* Formula
* Single Line Text
* Long Text

2
packages/noco-docs/docs/070.fields/040.field-types/050.custom-types/050.barcode.md

@ -8,7 +8,7 @@ tags: ['Fields', 'Field types', 'Custom types', 'Barcode']
![image](/img/v2/fields/barcode.png)
The following column types are supported for the for reference column:
The following field types are supported for the for reference field:
* Formula
* Single Line Text
* Long Text

4
packages/noco-docs/docs/070.fields/040.field-types/050.custom-types/080.json.md

@ -4,7 +4,7 @@ tags: ['Fields', 'Field types', 'Custom types', 'JSON']
---
`JSON` is a custom field type that allows you to store JSON data in a column. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.
`JSON` is a custom field type that allows you to store JSON data in a field. Useful for storing data that can be represented as a JSON object, like API Response, or a set of key-value pairs.
## Create a JSON field
1. Click on `+` icon to the right of `Fields header`
@ -13,5 +13,5 @@ tags: ['Fields', 'Field types', 'Custom types', 'JSON']
4. Click on `Save Column` button.
### Cell display
Cell displays the JSON data stored in the column. Click on expand record icon to open the JSON data in an editor modal.
Cell displays the JSON data stored in the field. Click on expand record icon to open the JSON data in an editor modal.

2
packages/noco-docs/docs/070.fields/040.field-types/070.date-time-based/010.date-time.md

@ -4,7 +4,7 @@ tags: ['Fields', 'Field types', 'Date & Time']
---
`Date Time` field type is used to store both date and time values in a single column.
`Date Time` field type is used to store both date and time values in a single field.
## Create a date time field
1. Click on `+` icon to the right of `Fields header`

2
packages/noco-docs/docs/070.fields/040.field-types/070.date-time-based/020.date.md

@ -4,7 +4,7 @@ tags: ['Fields', 'Field types', 'Date & Time']
---
`Date` field type is used to store date values in a single column. NocoDB supports a wide range of date formats, as detailed in the table below.
`Date` field type is used to store date values. NocoDB supports a wide range of date formats, as detailed in the table below.
## Create a date field
1. Click on `+` icon to the right of `Fields header`

2
packages/noco-docs/docs/080.records/030.expanded-record.md

@ -13,7 +13,7 @@ keywords : ['NocoDB expanded form', 'expanded form', 'expanded record', 'expande
## Expanding a Record
To expand a record in a grid view, click on double arrow icon that appears on the first column on hover over a record.
To expand a record in a grid view, click on double arrow icon that appears on the first column (index column) on hover over a record.
![expand record icon](https://github.com/nocodb/nocodb/assets/86527202/7df9ceb3-b9cf-4891-9e88-ab074a07393f)

4
packages/noco-docs/docs/080.records/070.actions-on-record.md

@ -22,8 +22,8 @@ Edit state for some cells will be a picker. For example, a cell with `Single Sel
### Keyboard shortcuts for cell navigation
| Key | Behaviour |
|----------------:|:-------------------------------------------------------------------------------------|
| `⌘` `↑` | Jump to first record in this column (in same page) |
| `⌘` `↓` | Jump to last record in this column (in same page) |
| `⌘` `↑` | Jump to first record in this field (in same page) |
| `⌘` `↓` | Jump to last record in this field (in same page) |
| `⌘` `C` | Copy cell contents to clipboard |
| `⌘` `V` | Paste clipboard contents to cell |
| `Enter` | Switch cell in focus to EDIT mode; opens modal/picker if cell is associated with one |

2
packages/noco-docs/docs/090.views/040.view-types/010.grid.md

@ -27,7 +27,7 @@ Grid view is the default view type for all tables. This view type is ideal for v
6. [Search for Specific Data Within Fields](/table-operations/search)
7. [Export Data to CSV or Excel Format](/table-operations/download#download-data)
8. [Adjust Record Height on the Grid](/table-operations/row-height)
9. [Customize Column Widths for Fields on the Grid](/fields/actions-on-field)
9. [Customize Field Width](/fields/actions-on-field)
10. [Toggle Field Visibility on the Grid](/table-operations/field-operations#showhide-fields)
## Grid View Record Operations

2
packages/noco-docs/docs/150.engineering/050.playwright.md

@ -88,7 +88,7 @@ Caveats:
- UI verification. This includes verifying the state of the UI element, i.e if the element is visible, if the element has a particular text etc.
- Test should verify all user flow. A test has a default timeout of 60 seconds. If a test is taking more than 60 seconds, it is a sign that the test should be broken down into smaller tests.
- Test should also verify all the side effects the feature(i.e. On adding a new column type, should verify column deletion as well) will have, and also error cases.
- Test should also verify all the side effects the feature(i.e. On adding a new field type, should verify field deletion as well) will have, and also error cases.
- Test name should be descriptive. It should be easy to understand what the test is doing by just reading the test name.
### Playwright

2
packages/noco-docs/docs/150.engineering/070.translation.md

@ -65,7 +65,7 @@ Refer following articles to get additional details about Crowdin Portal usage
## String Categories
- **General**: simple & common tokens (save, cancel, submit, open, close, home, and such)
- **Objects**: objects from NocoDB POV (project, table, field, column, view, page, and such)
- **Objects**: objects from NocoDB POV (project, table, field, view, page, and such)
- **Title**: screen headers (compact) (menu headers, modal headers)
- **Lables**: text box/ radio/ field headers (few words) (Labels over textbox, radio buttons, and such)
- **Activity**/ actions: work items (few words) (Create Project, Delete Table, Add Record, and such)

Loading…
Cancel
Save