mirror of
https://github.com/anyproto/docs.git
synced 2025-06-08 05:47:05 +09:00
GITBOOK-314: Set up the Intro group
This commit is contained in:
parent
15a3483ccc
commit
d17c49a892
25 changed files with 36 additions and 34 deletions
13
basics/anytype-library/README.md
Normal file
13
basics/anytype-library/README.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
description: We have default and pre-built types already set up for you!
|
||||
---
|
||||
|
||||
# Anytype Library
|
||||
|
||||
{% hint style="danger" %}
|
||||
The Library widget is currently available on desktop and Android. You won't be able to find it on iOS — please use the desktop app to edit types.
|
||||
{% endhint %}
|
||||
|
||||
On the desktop or Android, navigate to the bottom of your sidebar just above the Bin:
|
||||
|
||||
.png>)
|
17
basics/anytype-library/relations.md
Normal file
17
basics/anytype-library/relations.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
# Relations
|
||||
|
||||
### Toggle to the top, center of the page, and find Relations.
|
||||
|
||||
The **Relations** library is organized the same as with **Types**, but your icons are a bit different. 
|
||||
|
||||
Clicking on a Relation here will give you the choice to install to your library. 
|
||||
|
||||
.png>)
|
||||
|
||||
Create a new Relation by clicking the bar in the middle.
|
||||
|
||||
Moving over to **My relations** is where you can see the objects in which you have attached to each Relation. 
|
||||
|
||||
.png>)
|
||||
|
||||
When you click on a specific **Relation** you are prompted with a set view of the details of the other objects which are linked.
|
19
basics/anytype-library/types.md
Normal file
19
basics/anytype-library/types.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Types
|
||||
|
||||
### When you open up your library, you have the **Anytype library** as well as **My Types**.
|
||||
|
||||
Anytype library being the types that come with Anytype by default, some which you've already been using, and some which we hope give you some inspiration. 
|
||||
|
||||
In the future, we look forward to having your contribution and creating many more use cases and types!
|
||||
|
||||
.png>)
|
||||
|
||||
The checkmarks show you which types are currently in your library (My types).
|
||||
|
||||
If you click on the type name, you will see the templates which have been created for it. 
|
||||
|
||||
###  In the My Types library you have types which you've saved and created.
|
||||
|
||||
Default types cannot be removed. 
|
||||
|
||||
You can also [create-a-new-type.md](../types/create-a-new-type.md "mention") from the middle bar in your Anytype library.
|
25
basics/collections.md
Normal file
25
basics/collections.md
Normal file
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
description: >-
|
||||
A folder-like structure where where you can visualize and batch edit objects
|
||||
of any type
|
||||
---
|
||||
|
||||
# Collections
|
||||
|
||||
### Understanding Collections
|
||||
|
||||
These are similar to Sets in their appearance and layout, however functioning differently.
|
||||
|
||||
Contrary to Sets and what was explained in the previous chapter, Collections are not filtered by Object Type but are in fact open to any Type. 
|
||||
|
||||
Collections can be used to organize a variety of different objects and store them in one place.
|
||||
|
||||
You are not restricted to viewing only one Object Type at a time, this means you can have multiple different types within one collection. 
|
||||
|
||||
### Example
|
||||
|
||||
If you are organizing your meal prep for the week, you might have a list of recipes, as well as ingredients and a shopping list. 
|
||||
|
||||
The main types you may have could be Recipes and Ingredients. 
|
||||
|
||||
In a Collection, you can organize all of this Types together seamlessly. 
|
23
basics/graph.md
Normal file
23
basics/graph.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
description: Finally a dive into your graph of objects.
|
||||
---
|
||||
|
||||
# Graph
|
||||
|
||||
### From anywhere in the app, you'll see the graph icon in the bottom navigation panel
|
||||
|
||||
<figure><img src="../.gitbook/assets/Graph Icon.png" alt="" width="375"><figcaption><p>Locate the graph icon in the middle of your navigation panel</p></figcaption></figure>
|
||||
|
||||
### Open your Graph to see all of your objects and their relations.
|
||||
|
||||
Here you can see which Objects are connected together, and the direction everything flows.
|
||||
|
||||
.png>)
|
||||
|
||||
On the top right of the screen in your Graph, you can **search** and optimize some settings. 
|
||||
|
||||
Toggle appearances for title, arrows, and icons. 
|
||||
|
||||
Optimize viewing links, relations, and orphans. **If you are missing some objects, check to show orphans.**
|
||||
|
||||
.png>)
|
19
basics/linking-objects.md
Normal file
19
basics/linking-objects.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
description: How to link your objects using relations.
|
||||
---
|
||||
|
||||
# Linking Objects
|
||||
|
||||
### Relations on the Graph
|
||||
|
||||
In your documents you may have multiple references or connections which could be attached to other work in your library. The Graph is the visualizer for this. Objects connected to other objects, connected to humans, or tasks. 
|
||||
|
||||
Learn more about [relations](relations/ "mention") & The [graph.md](graph.md "mention") here. 
|
||||
|
||||
.png>)
|
||||
|
||||
### Use the Flow
|
||||
|
||||
Another option to check which objects are linked together can be found in the tab just next to the Graph. 
|
||||
|
||||
On the top, center of your screen you will see the option to toggle to **Flow** view. This will show you which object is linked before and after the current object you are viewing.
|
23
basics/object-editor/README.md
Normal file
23
basics/object-editor/README.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
description: Let's discover what Objects are, and how to use them to optimize your work.
|
||||
---
|
||||
|
||||
# Object Editor
|
||||
|
||||
### What is an Object?
|
||||
|
||||
Forget what you already know about knowledge management tools. 
|
||||
|
||||
At Anytype we have created the concept that everything you create is an Object. Pages, Notes, Recipes, Books, Movies, Audio, Humans, _everything!_ 
|
||||
|
||||
These are all **Objects** that are organized and categorized by **Types**. 
|
||||
|
||||
You can connect different **Types** by **Relations** and see how this is visualized on the **Graph**.
|
||||
|
||||
You will see in your **Library** that you can create new Types. 
|
||||
|
||||
In short, an Object is a generalizing term for what you are creating. If it is a page, note, or other Type that you have created. 
|
||||
|
||||
The Object will be organized by the Type of object that it is.  
|
||||
|
||||
It is any node in your graph. The smallest linkable unit. Still classified with types.  
|
30
basics/object-editor/blocks.md
Normal file
30
basics/object-editor/blocks.md
Normal file
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
description: Understanding blocks, editing, and customizing to your preference.
|
||||
---
|
||||
|
||||
# Working with Blocks
|
||||
|
||||
Your object is made up of different types of blocks to organize your information. Anytype's block-based editor works very similarly to that of blogging sites or website builders.
|
||||
|
||||
All block styles originate from the command menu, which you can access by either clicking on the orange `+` symbol on the left-hand side of your editor, or typing `/`. 
|
||||
|
||||
From here, you'll see more than twenty different block-types you can add to your object. 
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2023-08-17 at 18.49.21.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Style your Blocks
|
||||
|
||||
You can select one block or several at once, and batch edit to create different headings and text styles such as checkboxes, bullets, or numbers.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2023-08-17 at 18.53.48.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Drag & Drop to Format
|
||||
|
||||
You can use the orange 'handle' to the left of each block to create parent/child blocks or new columns in your editor.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2023-08-17 at 19.02.30.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2023-08-17 at 18.57.02.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
|
||||
|
28
basics/object-editor/create-an-object.md
Normal file
28
basics/object-editor/create-an-object.md
Normal file
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
description: How do you create an object?
|
||||
---
|
||||
|
||||
# More Ways to Create Objects
|
||||
|
||||
### Forward Slash Command
|
||||
|
||||
When working in Anytype you can create a new Object by typing the "/". This will bring up the list of Objects that you have created. Simply select the Object you'd like to create and it will be linked at your current place.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (5).png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
You can also link to an existing Object here.
|
||||
|
||||
### Use a Shortcut
|
||||
|
||||
For a quick creation of a new Object, you can use this shortcut: ⌘+N
|
||||
|
||||
This will perform the same action as clicking the "+" sign.
|
||||
|
||||
### Turn Into Object
|
||||
|
||||
If you are working on something in an existing Object and would like to transform only a certain block into an Object, you can do that trough the action menu by either:
|
||||
|
||||
1. Hovering to the left side of the block that you are working on and clicking the 3 dots.
|
||||
2. Using the ⌘+/ keyboard shortcut. 
|
||||
|
||||
<figure><img src="../../.gitbook/assets/image (25).png" alt=""><figcaption><p>Action menu</p></figcaption></figure>
|
19
basics/object-editor/finding-your-objects.md
Normal file
19
basics/object-editor/finding-your-objects.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Locating your Objects
|
||||
|
||||
### Use the Graph
|
||||
|
||||
To find all of your objects and how they are connected, you can look to the Graph for your main source of truth.
|
||||
|
||||
Read more about the [graph.md](../graph.md "mention") here.
|
||||
|
||||
### Browse through EVERYTHING
|
||||
|
||||
Additionally, to all of the objects you've created in list view, by default there is a set of 'Everything' which will show you your objects and their types.
|
||||
|
||||
Look for an object titled Everything with this emoji: :globe\_with\_meridians:
|
||||
|
||||
### Use the Search
|
||||
|
||||
As a last resort, if you still can't find what you're looking for, try and search for it.
|
||||
|
||||
To navigate to the search, head to your graph page, and find the magnifier in the top right corner.
|
22
basics/object-editor/the-editor.md
Normal file
22
basics/object-editor/the-editor.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
description: Let's explore the features we have in building a page.
|
||||
---
|
||||
|
||||
# Opening the Editor
|
||||
|
||||
### Find the plus sign
|
||||
|
||||
On the bottom navigation panel you will see a white "+" button.
|
||||
|
||||
This plus sign is the central place to create a new, unlinked object from anywhere in the app.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2023-08-17 at 18.35.44.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Congratulations - you've created your first object!
|
||||
|
||||
From here, you'll see your blank editor canvas with a menu on top. 
|
||||
|
||||
The menu allows you to select between all of the types in your library, and define the type of object you are creating. For more on types, see [this article](../anytype-library/types.md).
|
||||
|
||||
Once you've selected a type, you can begin creating content for your object using the block-based editor.
|
||||
|
16
basics/relations/README.md
Normal file
16
basics/relations/README.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# Relations
|
||||
|
||||
### Understanding Relations <a href="#understanding-relations" id="understanding-relations"></a>
|
||||
|
||||
Relations are key to organizing and connecting your Objects and knowledge in Anytype. There are two functions that Relations serve in Anytype:
|
||||
|
||||
* **Defining attributes:** You can use Relations to define the characteristics of a certain Object.
|
||||
* For example, when creating a Task in Anytype, you can add Relations such as _Status_: Done/Not Done, or _Priority_: Low, Medium, or High.
|
||||
* If we were to imagine a database, Relations represent the column headers to each row (where column A is the Object).
|
||||
* Once you have set your attributes, it becomes possible to sort and filter your Objects according to the Relations you've defined in Set View.
|
||||
|
||||

|
||||
|
||||
* **Defining connections:** You can also use Relations to link one Object to another.
|
||||
* Returning to the example of a Task, you can add the Relation: _Assignee,_ and assign another Object in your Anytype to this task.
|
||||
* As above, you can view the Assignees as Relations in Set view, or in Graph view.
|
27
basics/relations/create-a-new-relation.md
Normal file
27
basics/relations/create-a-new-relation.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# Create a New Relation
|
||||
|
||||
|
||||
|
||||
#### Adding & Managing Relations <a href="#adding-and-managing-relations" id="adding-and-managing-relations"></a>
|
||||
|
||||
You can add a Relation to your Objects as you would with any other block in the editor: by using the `+` button or the in-line `/` menu.You can also manage the Relations for a given Object via its **Relations Panel:** the triangular icon that appears when hovering above the Object name. This Panel shows all relations for that Object.
|
||||
|
||||
**Featuring Relations**
|
||||
|
||||
Here you can add, feature, or modify existing Relations. Featuring Relations allows you to visually prioritize the most relevant Relations for a given Object, as Featured Relations appear directly beneath the Title. You can feature any Relation by clicking ★ next to the relation in the Relations panel.
|
||||
|
||||
{% embed url="https://vimeo.com/749076155?embedded=true&source=vimeo_logo&owner=177568036" %}
|
||||
|
||||
#### Types of Relations <a href="#types-of-relations" id="types-of-relations"></a>
|
||||
|
||||
Here are the currently available Relation-types within Anytype:
|
||||
|
||||
* **Text**: accepts text as the input.
|
||||
* **Number**: for all numbers. Different formats are coming soon.
|
||||
* **Date**: date, optional information for time.
|
||||
* **Status:** categorical relation wherein you can define a list of options to choose from, like X, Y, or Z.
|
||||
* **Tag**: 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.
|
||||
* **Media**: audio, movies, or pictures which you can view, play, or download.
|
||||
* **Object**: reference to a specific object, like a person, task, or document.
|
34
basics/sets/README.md
Normal file
34
basics/sets/README.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
description: A live search of all objects which share a common type or relation
|
||||
---
|
||||
|
||||
# Sets
|
||||
|
||||
### Understanding Sets
|
||||
|
||||
Lots of people compare Sets with databases, but there's a key difference: Sets don't _store_ objects like regular databases. 
|
||||
|
||||
Sets are a way to see a portion of your graph, and objects you've created, based on your filtered criteria, and several secondary filters which you can customize. You can think of them as a live filter or query for Objects which share certain criteria - specifically, a type or a relation.
|
||||
|
||||
#### Sets serve two primary functions:
|
||||
|
||||
1. **Organizing and Accessing Objects**\
|
||||
\
|
||||
We often get requests along the lines of: _How do I find all of the Notes I've created?_ \
|
||||
\
|
||||
One easy way is to create a Set based on Type. \
|
||||
For example; Note, which will display every Note you've created in Anytype. \
|
||||
\
|
||||
If you have specific notes you'd like to frequently access, you can filter them based on Relations you've added to these notes. \
|
||||
\
|
||||
For instance: Creation Date, Tags, or Priority. (In this sense, Relations behave like attributes).\
|
||||
\
|
||||
You can then pin your Set to your Favorites menu, where it will sit on your sidebar, acting like a folder for all Objects that meet certain criteria.\
|
||||
|
||||
2. **Batch editing Objects**\
|
||||
\
|
||||
Sets also provide a way to batch-edit Objects. \
|
||||
\
|
||||
You can use multi-select in Sets to delete multiple Objects at once or to batch update the Object Type. You can also batch-add or edit Relations for Objects from Set view, instead of entering them one-by-one. 
|
||||
|
||||
{% embed url="https://vimeo.com/717016770" %}
|
19
basics/sets/creating-sets.md
Normal file
19
basics/sets/creating-sets.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Creating Sets
|
||||
|
||||
### You can create a Set with the + in the bottom-left corner or using the / shortcut menu in the editor.
|
||||
|
||||
OR
|
||||
|
||||
You can create a set from the Object type toggle on a new document.
|
||||
|
||||
.png>)
|
||||
|
||||
### Next, you need to decide on the purpose of your Set. 
|
||||
|
||||
For example, project management may require Type: Project, for reading list — Book. From the Library, choose an Object Type, click "Create," and choose "Create a set."
|
||||
|
||||
This will then create a set of all the Objects with the Type: Books. 
|
||||
|
||||
Now you have an organized selection of all your book objects entered into Anytype.
|
||||
|
||||
.png>)
|
17
basics/sets/customizing-with-relations-sort-and-filters.md
Normal file
17
basics/sets/customizing-with-relations-sort-and-filters.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
# Customizing with Relations, Sort, & Filters
|
||||
|
||||
### Toggle & Add Relations to Objects via Sets
|
||||
|
||||
Instead of adding Relations one-by-one to Objects, you can batch-add them to your Set by clicking the filters on the right side. 
|
||||
|
||||
Here you can toggle on/off any relations that you would like to see, add another relation or new relation, and edit the view of the Set here. 
|
||||
|
||||
This sections acts as your sort & filters.
|
||||
|
||||

|
||||
|
||||
You can add any Relations to be automatically added to your **Objects**, by adding them in the creation process of your **Type**. 
|
||||
|
||||
See more about how to [create-a-new-type.md](../types/create-a-new-type.md "mention") here. Underneath the title & template section of the new Type process you'll have the Relation options. 
|
||||
|
||||
.png>)
|
30
basics/types/README.md
Normal file
30
basics/types/README.md
Normal file
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
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 neighbours 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](../../use-cases-and-tutorials/deep-dive-templates.md). 
|
||||
|
||||
You can always view and manage your types from the Types Library, found in the _Library_ widget on your sidebar.
|
||||
|
||||
|
||||
|
33
basics/types/create-a-new-type.md
Normal file
33
basics/types/create-a-new-type.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
description: How to create new types from the library and your editor
|
||||
---
|
||||
|
||||
# Create a New Type
|
||||
|
||||
The [anytype-library](../anytype-library/ "mention") is the central place to manage, search for, and create new types.
|
||||
|
||||
### Creating Types from the Library
|
||||
|
||||
Click on the search bar and input the name of the type you'd like to create. The dropdown menu will be populated with any matching terms from the Anytype library. You can select any of these, and they'll be installed newly in your types library. If you'd prefer instead to create your own type, simply choose the option `+ Create type "Type name".`
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Types Library.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
If you opt to create your own type, the Type page will open automatically. From here, you can add templates and relations to the type, which will be applied automatically any time you create an object of this type.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Type page.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
If you've decided that this Type is no relevant, you can use the three-dots menu in the corner 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.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Delete type.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Creating Types from the Object Editor
|
||||
|
||||
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/Type Creation on-the-fly.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
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/Type creation from change-type menu (1).png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Any type you create from the object editor will be available for editing in the types library using the steps above.
|
30
basics/types/templates.md
Normal file
30
basics/types/templates.md
Normal file
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
description: Building & using templated through types.
|
||||
---
|
||||
|
||||
# Templates
|
||||
|
||||
### Understanding 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 Layouts and Relations 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. 
|
||||
|
||||
{% embed url="https://vimeo.com/717028105" %}
|
||||
|
||||
### How to Create a Template
|
||||
|
||||
There are two ways to add a Template: 
|
||||
|
||||
1\) Navigate to the Types Library → Click the Type for which you'd like to create a Template → Click + to start creating a new template → Give your Template a name and start adding Relations and formatting → Your Template is Auto-saved
|
||||
|
||||
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.
|
||||
|
||||
### Using & Managing Templates
|
||||
|
||||
Once you've created your Template, each time you add a new Object you will be prompted to select the Template you'd like to use. If you would like to bypass this, you can alsways use the default Blank template.
|
||||
|
||||
You can view, edit, duplicate, or delete the Templates you've added for each Object Type in the Types Library.
|
Loading…
Add table
Add a link
Reference in a new issue