mirror of
https://github.com/anyproto/docs.git
synced 2025-06-08 13:57:11 +09:00
GITBOOK-583: 0.46.0 + Getting Started
This commit is contained in:
parent
2934fe73b6
commit
abd61b0074
446 changed files with 1580 additions and 1588 deletions
59
getting-started/types/README.md
Normal file
59
getting-started/types/README.md
Normal file
|
@ -0,0 +1,59 @@
|
|||
---
|
||||
description: Types are the classification system we use to categorize Objects
|
||||
---
|
||||
|
||||
# Types
|
||||
|
||||
Just as in the physical world, Types are useful for defining Objects which are categorically different from one another.
|
||||
|
||||
A banana is something inherently different from a sofa. Its functions, properties, and relationships to other objects is more similar to those of apples and oranges, rather than sofas. For this reason, we might categorize apples, oranges, and bananas as _fruit_, whereas sofas would fall into a different category: that of _furniture._
|
||||
|
||||
By the same principle, in Anytype there are two important concepts to keep in mind:
|
||||
|
||||
1\) Every object has a Type, which is defined at the time of Object creation (and can be changed later)
|
||||
|
||||
2\) Different Types are used to define Objects which are categorically different from each other
|
||||
|
||||
Colleagues, friends, and neighbors might all be considered type: _Human_ in your Anytype graph. Here are other examples of Types you might have in your graph:
|
||||
|
||||
* Task
|
||||
* Note
|
||||
* Book
|
||||
* Movie
|
||||
* Idea
|
||||
|
||||
It's up to you how narrow or broad you'd like your Types to be, but generally we recommend using general Types for categorizing your Objects, and further refining the use of your Types through [Templates](broken-reference).
|
||||
|
||||
You can always view and manage your Types in your Space settings under the Content model section [#object-types](../../advanced/settings/space-settings.md#object-types "mention")
|
||||
|
||||
Additionally, each Type has an in-built Query which can be accessed by opening the Type from anywhere in the app.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (53).png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Create a New Type
|
||||
|
||||
#### Creating Types from the Sidebar
|
||||
|
||||
In case you think of a new object type just as you're creating an object, you can create a new type on-the-fly. In this case, use the type selection menu in the same way as the search bar in the Types library. The type will be automatically added to your Types library, while you can proceed with editing the object of your new type.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (28).png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
#### Creating Types from Space Settings
|
||||
|
||||
Open your [space.md](../install-and-setup/space.md "mention") settings, and navigate to `Content Model > Object Types`. Afterwards, simply click on `New` button to create a new Type.
|
||||
|
||||
From here, you can choose a name, layout, and add templates and properties to the newly created Type.
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (23).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (24).png" alt=""><figcaption></figcaption></figure></div>
|
||||
|
||||
If you've decided that this Type is no longer relevant, you can use the context menu (mouse right-click) to delete the Type from your space. Please proceed with caution; any objects of this type will show an alert if the Type has been removed from your library.
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (26).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (27).png" alt=""><figcaption></figcaption></figure></div>
|
||||
|
||||
#### Creating Types from the Object Editor
|
||||
|
||||
If you decide later on that you want to convert your object to a new object type _after it's created_, again - you can do so by selecting the object type, choosing 'Change type', and entering the name of the type which you would like to create.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (29).png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
Any Type you create from the object editor will be available for editing in your space settings using the steps above.
|
70
getting-started/types/relations.md
Normal file
70
getting-started/types/relations.md
Normal file
|
@ -0,0 +1,70 @@
|
|||
# Properties
|
||||
|
||||
Properties are key to organizing and connecting your Objects and knowledge in Anytype. There are two functions that Properties serve in Anytype:
|
||||
|
||||
* **Defining attributes:** You can use Properties to define the characteristics of a certain Object.
|
||||
* For example, when creating a Task in Anytype, you can add Properties such as _Status_: Done/Not Done, or _Priority_: Low, Medium, or High.
|
||||
* If we were to imagine a database, Properties represent the column headers to each row (where column A represents the Object name, and where each row represents an Object).
|
||||
* Once you have set your attributes, it becomes possible to sort and filter your Objects according to the Properties you've defined in your [List](broken-reference) View.
|
||||
* **Defining connections:** You can also use Properties to link one Object to another.
|
||||
* Returning to the example of a Task, you can add the Property: _Linked Projects,_ and connect another Object in your Anytype to this task.
|
||||
* As above, you can view the Linked Projects as Properties in [List](broken-reference) view, or in Graph view.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (198).png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Create a New Property
|
||||
|
||||
#### Creating Properties from the Type Edit Menu
|
||||
|
||||
While editing any [Type in your Space settings](./#creating-types-from-space-settings), you can use the `+` button in the top right corner of the Properties section to either add an existing property to the current Type or to create a new one. 
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (123).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (124).png" alt=""><figcaption></figcaption></figure></div>
|
||||
|
||||
#### Creating Properties from Space Settings
|
||||
|
||||
Open your [space.md](../install-and-setup/space.md "mention") settings, and navigate to `Content Model > Properties`. Afterwards, simply click on `New` button to create a new Property.
|
||||
|
||||
From here, you can choose a name and a type for your new Property.
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (187).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (188).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (189).png" alt=""><figcaption></figcaption></figure></div>
|
||||
|
||||
If you've decided that this Property is no longer relevant, you can use the context menu (mouse right-click) to delete the Property from your space.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (190).png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
#### Creating Properties from the Object Editor
|
||||
|
||||
You can add a Property to your Objects as you would with any other block in the editor: by using the `+` button or the in-line `/` menu.
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (191).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (192).png" alt=""><figcaption></figcaption></figure></div>
|
||||
|
||||
Any Property you create from the object editor will be available for editing in your space settings using the steps above.
|
||||
|
||||
#### Types of Properties <a href="#types-of-relations" id="types-of-relations"></a>
|
||||
|
||||
Here are the currently available Property types within Anytype:
|
||||
|
||||
* **Text**: accepts text as the input.
|
||||
* **Number**: for all numbers. Different formats are coming soon.
|
||||
* **Date**: date, optional information for time.
|
||||
* **Select:** categorical property wherein you can define a list of options to choose from, like X, Y, or Z.
|
||||
* **Multi-select**: another variety of the string with no limits, only one string.
|
||||
* **Email/phone/URL**: special formats for URL, email, and phone number.
|
||||
* **Checkbox**: an object with a boolean, string, or link to an object.
|
||||
* **File & Media**: audio, movies, or pictures which you can view, play, or download.
|
||||
* **Object**: reference to a specific object, like a person, task, or document.
|
||||
|
||||
### Managing Properties
|
||||
|
||||
You can also manage the Properties for a given Object via its **Properties Panel:** the bullet list icon that appears in the top right corner of the screen. This Panel shows all Properties for that Object.
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (125).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (126).png" alt=""><figcaption></figcaption></figure></div>
|
||||
|
||||
The Properties icon lets you view the properties of a specific object, while the Set up menu allows you to manage the properties of its Type – you can add, remove and organize them into different sections:
|
||||
|
||||
* Header properties appear in the header part of every object of that Type
|
||||
* Panel properties are those that will be shown by pressing Properties icon
|
||||
* Hidden properties live under the "Hidden" toggle
|
||||
* Local properties are those that are not associated with the Object's Type
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (127).png" alt="" width="563"><figcaption></figcaption></figure>
|
39
getting-started/types/templates.md
Normal file
39
getting-started/types/templates.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
description: Building & using templates through types.
|
||||
---
|
||||
|
||||
# Templates
|
||||
|
||||
Templates are one of our most-beloved ways to work at Anytype, designed to help you scale and personalize your Object creation flows. With Templates, you can:
|
||||
|
||||
* Customize the cover or icon you want to use to for certain object Types
|
||||
* Automatically re-use the same structure each time you add a new Object
|
||||
|
||||
Templates are saved on the Type level, and each Type can support multiple Templates. For example, you can have different Templates for different kinds of Books, like academic, fiction, or non-fiction.
|
||||
|
||||
### How to Create a Template
|
||||
|
||||
There are three ways to add a Template:
|
||||
|
||||
1\) Navigate to `Space > Content Model > Object Types` → Click the Type for which you'd like to create a Template → Click on Templates in the top right corner → Click + to start creating a new template → Give your Template a name and start adding Properties and formatting → Your Template is auto-saved
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (164).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (166).png" alt=""><figcaption></figcaption></figure></div>
|
||||
|
||||
2\) If you're working within an Object and would like to save your work as a Template, you can: Navigate to `···` in the top-right corner → Click + Use as a Template, and your content will automatically be saved as a new Template for this Object Type.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (185).png" alt="" width="563"><figcaption></figcaption></figure>
|
||||
|
||||
3\) If you are working in a List and you would like to create / edit your templates, you can:\
|
||||
Navigate to `New|▾` in the top-right corner of the List view -> Click on the `▾` button to open up the template modal. Then either create a new template by using the `+` button, or modify an existing one by clicking on `···` in the top right corner of the template button, and choosing either `Edit template`, `Duplicate` or `Delete`.
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (170).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (171).png" alt=""><figcaption></figcaption></figure></div>
|
||||
|
||||
### Using & Managing Templates
|
||||
|
||||
Depending on the way you've created your new object, either the default template will be applied automatically, or you will be asked to choose a template yourself.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/5_Template Picker Screenshot.png" alt="" width="375"><figcaption><p>Choose a template</p></figcaption></figure>
|
||||
|
||||
You can also choose the default template for each type by opening the Type object, or you can choose the default template for each List view.
|
||||
|
||||
<div><figure><img src="../../.gitbook/assets/image (162).png" alt=""><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/image (163).png" alt=""><figcaption></figcaption></figure></div>
|
Loading…
Add table
Add a link
Reference in a new issue