mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-07-27 18:12:29 +08:00
feat(docs): document file note type
This commit is contained in:
Elian Doran
parent
78fba191e1
commit
e50c1b36f6
@ -2099,6 +2099,13 @@
|
|||||||
"value": "bx bx-paperclip",
|
"value": "bx bx-paperclip",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 40
|
"position": 40
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "W8vYD3Q1zjCR",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 50
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"format": "markdown",
|
"format": "markdown",
|
||||||
@ -2494,6 +2501,26 @@
|
|||||||
"dataFileName": "Read-Only Notes_image.png"
|
"dataFileName": "Read-Only Notes_image.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "0ESUbbAxVnoK",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"gh7bpGYxajRS",
|
||||||
|
"BFs8mudNFgCS",
|
||||||
|
"0ESUbbAxVnoK"
|
||||||
|
],
|
||||||
|
"title": "Note List",
|
||||||
|
"notePosition": 140,
|
||||||
|
"prefix": null,
|
||||||
|
"isExpanded": false,
|
||||||
|
"type": "text",
|
||||||
|
"mime": "text/html",
|
||||||
|
"attributes": [],
|
||||||
|
"format": "markdown",
|
||||||
|
"dataFileName": "Note List.md",
|
||||||
|
"attachments": []
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@ -5722,6 +5749,176 @@
|
|||||||
"dataFileName": "18_Geo Map_image.png"
|
"dataFileName": "18_Geo Map_image.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "W8vYD3Q1zjCR",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"KSZ04uQ2D1St",
|
||||||
|
"W8vYD3Q1zjCR"
|
||||||
|
],
|
||||||
|
"title": "File",
|
||||||
|
"notePosition": 210,
|
||||||
|
"prefix": null,
|
||||||
|
"isExpanded": false,
|
||||||
|
"type": "text",
|
||||||
|
"mime": "text/html",
|
||||||
|
"attributes": [
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "8YBEPzcpUgxw",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "BlN9DFI679QC",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 20
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "iPIMuisry3hd",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 30
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "0vhv7lsOLy82",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 50
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "mHbBMPDPkVV5",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 60
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "6f9hih2hXXZk",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 70
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "wX4HbRucYSDD",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 80
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "ODY7qQn5m2FT",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 90
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "0Ofbk1aSuVRu",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 100
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "oPVyFC7WL2Lp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 110
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "0ESUbbAxVnoK",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 120
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "markdown",
|
||||||
|
"dataFileName": "File.md",
|
||||||
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "82as0jgkDvVH",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "FoEnowwOhzLT",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "1_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "fZ7VMfQJWuLQ",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "2_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "hddkgf7kr9g4",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "3_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "hIg9g5pgsjS3",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "4_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "IC0j8LFCOKka",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "5_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "QuS3PW5vuXmf",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "6_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "uEFfm1fmx9G7",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "7_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "wNHX24feZRAl",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "8_File_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
@ -6,3 +6,7 @@ This can be especially useful to include dependencies for your [scripts](../../N
|
|||||||
Each note exclusively owns its attachments, meaning attachments cannot be shared or linked from one note to another. If an attachment link is copied to a different note, the attachment itself is duplicated, and the copies are managed independently thereafter.
|
Each note exclusively owns its attachments, meaning attachments cannot be shared or linked from one note to another. If an attachment link is copied to a different note, the attachment itself is duplicated, and the copies are managed independently thereafter.
|
||||||
|
|
||||||
Attachments, especially image files, are the recommended method for embedding visuals in notes. It is important to link image attachments within the text of the owning note; otherwise, they will be automatically deleted after a configurable timeout period if not referenced.
|
Attachments, especially image files, are the recommended method for embedding visuals in notes. It is important to link image attachments within the text of the owning note; otherwise, they will be automatically deleted after a configurable timeout period if not referenced.
|
||||||
|
|
||||||
|
## Attachment previews
|
||||||
|
|
||||||
|
Attachments share the same content preview for images, videos, PDFs, etc. as the [File](../../Note%20Types/File.md) note type.
|
||||||
BIN
docs/User Guide/User Guide/Note Types/1_File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/1_File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 752 KiB |
BIN
docs/User Guide/User Guide/Note Types/2_File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/2_File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
docs/User Guide/User Guide/Note Types/3_File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/3_File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
docs/User Guide/User Guide/Note Types/4_File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/4_File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 704 KiB |
BIN
docs/User Guide/User Guide/Note Types/5_File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/5_File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
docs/User Guide/User Guide/Note Types/6_File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/6_File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 165 KiB |
BIN
docs/User Guide/User Guide/Note Types/7_File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/7_File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 165 KiB |
BIN
docs/User Guide/User Guide/Note Types/8_File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/8_File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
89
docs/User Guide/User Guide/Note Types/File.md
Normal file
89
docs/User Guide/User Guide/Note Types/File.md
Normal file
@ -0,0 +1,89 @@
|
|||||||
|
# File
|
||||||
|
The _File_ note type can be used to attach various external files such as images, videos or PDF documents.
|
||||||
|
|
||||||
|
## Uploading a file
|
||||||
|
|
||||||
|
Since these files come from an external source, it is not possible to create a _File_ note type directly:
|
||||||
|
|
||||||
|
* Drag a file into the [Note Tree](../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md).
|
||||||
|
* Right click a note and select _Import into note_ and point it to one of the supported files.
|
||||||
|
|
||||||
|
## Supported file types
|
||||||
|
|
||||||
|
### PDFs
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
PDFs can be browsed directly from Trilium.
|
||||||
|
|
||||||
|
Interaction:
|
||||||
|
|
||||||
|
* Press the menu icon at the top-left to see a preview (thumbnail) of all the pages, as well as a table of contents (if the PDF has this information).
|
||||||
|
* See or edit the page number at the top.
|
||||||
|
* Adjust the zoom using the buttons at the top or manually editing the value.
|
||||||
|
* Rotate the document if it's in the wrong orientation.
|
||||||
|
* In the contextual menu:
|
||||||
|
* View two pages at once (great for books).
|
||||||
|
* Toggle annotations (if present in the document).
|
||||||
|
* View document properties.
|
||||||
|
|
||||||
|
### Images
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Interaction:
|
||||||
|
|
||||||
|
* _Copy reference to clipboard_, for embedding the image within [Text](Text.md) notes. See [Image references](Text/Images/Image%20references.md) for more information.
|
||||||
|
|
||||||
|
### Videos
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Video files can be added in as well. The file is streamed directly, so when accessing the note from a server it doesn't have to download the entire video to start playing it.
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> Although Trilium offers support for videos, it is generally not meant to be used with very large files. Uploading large videos will cause the [Database](../Advanced%20Usage/Database.md) to balloon as well as the any [Backup](../Installation%20%26%20Setup/Backup.md) of it. In addition to that, there might be slowdowns when first uploading the files. Otherwise, a large database should not impact the general performance of Trilium significantly.
|
||||||
|
|
||||||
|
### Audio
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Adding a supported audio file will reveal a basic audio player that can be used to play it.
|
||||||
|
|
||||||
|
Interactions:
|
||||||
|
|
||||||
|
* The audio can be played/paused using the dedicated button.
|
||||||
|
* Dragging the mouse across, or clicking the progress bar will seek through the song.
|
||||||
|
* The volume can be set.
|
||||||
|
* The playback speed can be adjusted via the contextual menu next to the volume.
|
||||||
|
|
||||||
|
### Text files
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Files that are identified as containing text will show a preview of their content. One common use case for this type of file is to embed text files whose content is not necessarily of interest to the user, such as third-party libraries or generated content, that can then be downloaded if needed.
|
||||||
|
|
||||||
|
Note that generally text files will be [imported](../Basic%20Concepts%20and%20Features/Import%20%26%20Export) as either [Text](Text.md) or [Code](Code.md) notes. To bypass this behavior and create a _File_ note type, use the _Import into note_ feature and uncheck _Import HTML, Markdown and TXT as text notes_, as well as _Import recognized code files as code notes_.
|
||||||
|
|
||||||
|
Since one of the use cases for having files instead of notes is to display large files, the content preview is limited to a relatively small amount of characters. To view the full file, consider opening it in an external application.
|
||||||
|
|
||||||
|
### Unknown file types
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
If the file could not be identified as any of the supported file types from above, it will be treated as an unknown file. In this case, all the default interactions will be available such as downloading or opening the file externally, but there will be no preview of the content.
|
||||||
|
|
||||||
|
## Interaction
|
||||||
|
|
||||||
|
* Regardless of the file type, a series of buttons will be displayed in the _Image_ or _File_ tab in the [Ribbon](../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md).
|
||||||
|
* _Download_, which will download the file for local use.
|
||||||
|
* _Open_, will will open the file with the system-default application.
|
||||||
|
* Upload new revision to replace the file with a new one.
|
||||||
|
* It is **not** possible to change the note type of a _File_ note.
|
||||||
|
* Convert into an [attachment](../Basic%20Concepts%20and%20Features/Notes/Attachments.md) from the [note menu](../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.md).
|
||||||
|
|
||||||
|
## Note list
|
||||||
|
|
||||||
|
Files are also displayed in the [Note List](../Basic%20Concepts%20and%20Features/Notes/Note%20List.md) based on their type:
|
||||||
|
|
||||||
|
|
||||||
BIN
docs/User Guide/User Guide/Note Types/File_image.png
Normal file
BIN
docs/User Guide/User Guide/Note Types/File_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 156 KiB |
197
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
197
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
@ -2099,6 +2099,13 @@
|
|||||||
"value": "bx bx-paperclip",
|
"value": "bx bx-paperclip",
|
||||||
"isInheritable": false,
|
"isInheritable": false,
|
||||||
"position": 40
|
"position": 40
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "W8vYD3Q1zjCR",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 50
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"format": "html",
|
"format": "html",
|
||||||
@ -2494,6 +2501,26 @@
|
|||||||
"dataFileName": "Read-Only Notes_image.png"
|
"dataFileName": "Read-Only Notes_image.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "0ESUbbAxVnoK",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"gh7bpGYxajRS",
|
||||||
|
"BFs8mudNFgCS",
|
||||||
|
"0ESUbbAxVnoK"
|
||||||
|
],
|
||||||
|
"title": "Note List",
|
||||||
|
"notePosition": 140,
|
||||||
|
"prefix": null,
|
||||||
|
"isExpanded": false,
|
||||||
|
"type": "text",
|
||||||
|
"mime": "text/html",
|
||||||
|
"attributes": [],
|
||||||
|
"format": "html",
|
||||||
|
"dataFileName": "Note List.html",
|
||||||
|
"attachments": []
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@ -5722,6 +5749,176 @@
|
|||||||
"dataFileName": "18_Geo Map_image.png"
|
"dataFileName": "18_Geo Map_image.png"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"isClone": false,
|
||||||
|
"noteId": "W8vYD3Q1zjCR",
|
||||||
|
"notePath": [
|
||||||
|
"pOsGYCXsbNQG",
|
||||||
|
"KSZ04uQ2D1St",
|
||||||
|
"W8vYD3Q1zjCR"
|
||||||
|
],
|
||||||
|
"title": "File",
|
||||||
|
"notePosition": 210,
|
||||||
|
"prefix": null,
|
||||||
|
"isExpanded": false,
|
||||||
|
"type": "text",
|
||||||
|
"mime": "text/html",
|
||||||
|
"attributes": [
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "8YBEPzcpUgxw",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 10
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "BlN9DFI679QC",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 20
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "iPIMuisry3hd",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 30
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "0vhv7lsOLy82",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 50
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "mHbBMPDPkVV5",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 60
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "6f9hih2hXXZk",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 70
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "wX4HbRucYSDD",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 80
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "ODY7qQn5m2FT",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 90
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "0Ofbk1aSuVRu",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 100
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "oPVyFC7WL2Lp",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 110
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "relation",
|
||||||
|
"name": "internalLink",
|
||||||
|
"value": "0ESUbbAxVnoK",
|
||||||
|
"isInheritable": false,
|
||||||
|
"position": 120
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"format": "html",
|
||||||
|
"dataFileName": "File.html",
|
||||||
|
"attachments": [
|
||||||
|
{
|
||||||
|
"attachmentId": "82as0jgkDvVH",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "FoEnowwOhzLT",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "1_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "fZ7VMfQJWuLQ",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "2_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "hddkgf7kr9g4",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "3_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "hIg9g5pgsjS3",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "4_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "IC0j8LFCOKka",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "5_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "QuS3PW5vuXmf",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "6_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "uEFfm1fmx9G7",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "7_File_image.png"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"attachmentId": "wNHX24feZRAl",
|
||||||
|
"title": "image.png",
|
||||||
|
"role": "image",
|
||||||
|
"mime": "image/png",
|
||||||
|
"position": 10,
|
||||||
|
"dataFileName": "8_File_image.png"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
@ -28,6 +28,10 @@
|
|||||||
visuals in notes. It is important to link image attachments within the
|
visuals in notes. It is important to link image attachments within the
|
||||||
text of the owning note; otherwise, they will be automatically deleted
|
text of the owning note; otherwise, they will be automatically deleted
|
||||||
after a configurable timeout period if not referenced.</p>
|
after a configurable timeout period if not referenced.</p>
|
||||||
|
<h2>Attachment previews</h2>
|
||||||
|
<p>Attachments share the same content preview for images, videos, PDFs, etc.
|
||||||
|
as the <a class="reference-link" href="../../Note%20Types/File.html">File</a> note
|
||||||
|
type.</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
19
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List.html
generated
Normal file
19
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Note List.html
generated
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="../../../style.css">
|
||||||
|
<base target="_parent">
|
||||||
|
<title data-trilium-title>Note List</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Note List</h1>
|
||||||
|
|
||||||
|
<div class="ck-content"></div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 752 KiB |
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/2_File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/2_File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/3_File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/3_File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/4_File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/4_File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 704 KiB |
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/5_File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/5_File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/6_File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/6_File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 165 KiB |
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/7_File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/7_File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 165 KiB |
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/8_File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/8_File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
142
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/File.html
generated
Normal file
142
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/File.html
generated
Normal file
@ -0,0 +1,142 @@
|
|||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="../../style.css">
|
||||||
|
<base target="_parent">
|
||||||
|
<title data-trilium-title>File</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>File</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<p>The <em>File</em> note type can be used to attach various external files
|
||||||
|
such as images, videos or PDF documents.</p>
|
||||||
|
<h2>Uploading a file</h2>
|
||||||
|
<p>Since these files come from an external source, it is not possible to
|
||||||
|
create a <em>File</em> note type directly:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Drag a file into the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.html">Note Tree</a>.</li>
|
||||||
|
<li>Right click a note and select <em>Import into note</em> and point it to
|
||||||
|
one of the supported files.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Supported file types</h2>
|
||||||
|
<h3>PDFs</h3>
|
||||||
|
<p>
|
||||||
|
<img src="File_image.png" width="933" height="666">
|
||||||
|
</p>
|
||||||
|
<p>PDFs can be browsed directly from Trilium.</p>
|
||||||
|
<p>Interaction:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Press the menu icon at the top-left to see a preview (thumbnail) of all
|
||||||
|
the pages, as well as a table of contents (if the PDF has this information).</li>
|
||||||
|
<li>See or edit the page number at the top.</li>
|
||||||
|
<li>Adjust the zoom using the buttons at the top or manually editing the value.</li>
|
||||||
|
<li>Rotate the document if it's in the wrong orientation.</li>
|
||||||
|
<li>In the contextual menu:
|
||||||
|
<ul>
|
||||||
|
<li>View two pages at once (great for books).</li>
|
||||||
|
<li>Toggle annotations (if present in the document).</li>
|
||||||
|
<li>View document properties.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h3>Images</h3>
|
||||||
|
<p>
|
||||||
|
<img src="4_File_image.png" width="879" height="766">
|
||||||
|
</p>
|
||||||
|
<p>Interaction:</p>
|
||||||
|
<ul>
|
||||||
|
<li><em>Copy reference to clipboard</em>, for embedding the image within
|
||||||
|
<a
|
||||||
|
class="reference-link" href="Text.html">Text</a> notes. See <a class="reference-link" href="Text/Images/Image%20references.html">Image references</a> for
|
||||||
|
more information.</li>
|
||||||
|
</ul>
|
||||||
|
<h3>Videos</h3>
|
||||||
|
<p>
|
||||||
|
<img src="1_File_image.png" width="854" height="700">
|
||||||
|
</p>
|
||||||
|
<p>Video files can be added in as well. The file is streamed directly, so
|
||||||
|
when accessing the note from a server it doesn't have to download the entire
|
||||||
|
video to start playing it.</p>
|
||||||
|
<aside class="admonition caution">
|
||||||
|
<p>Although Trilium offers support for videos, it is generally not meant
|
||||||
|
to be used with very large files. Uploading large videos will cause the
|
||||||
|
<a
|
||||||
|
class="reference-link" href="../Advanced%20Usage/Database.html">Database</a> to balloon as well as the any <a class="reference-link"
|
||||||
|
href="../Installation%20%26%20Setup/Backup.html">Backup</a> of it.
|
||||||
|
In addition to that, there might be slowdowns when first uploading the
|
||||||
|
files. Otherwise, a large database should not impact the general performance
|
||||||
|
of Trilium significantly.</p>
|
||||||
|
</aside>
|
||||||
|
<h3>Audio</h3>
|
||||||
|
<p>
|
||||||
|
<img src="3_File_image.png" width="850" height="243">
|
||||||
|
</p>
|
||||||
|
<p>Adding a supported audio file will reveal a basic audio player that can
|
||||||
|
be used to play it.</p>
|
||||||
|
<p>Interactions:</p>
|
||||||
|
<ul>
|
||||||
|
<li>The audio can be played/paused using the dedicated button.</li>
|
||||||
|
<li>Dragging the mouse across, or clicking the progress bar will seek through
|
||||||
|
the song.</li>
|
||||||
|
<li>The volume can be set.</li>
|
||||||
|
<li>The playback speed can be adjusted via the contextual menu next to the
|
||||||
|
volume.</li>
|
||||||
|
</ul>
|
||||||
|
<h3>Text files</h3>
|
||||||
|
<p>
|
||||||
|
<img src="2_File_image.png" width="926" height="347">
|
||||||
|
</p>
|
||||||
|
<p>Files that are identified as containing text will show a preview of their
|
||||||
|
content. One common use case for this type of file is to embed text files
|
||||||
|
whose content is not necessarily of interest to the user, such as third-party
|
||||||
|
libraries or generated content, that can then be downloaded if needed.</p>
|
||||||
|
<p>Note that generally text files will be <a href="../Basic%20Concepts%20and%20Features/Import%20%26%20Export">imported</a> as
|
||||||
|
either <a class="reference-link" href="Text.html">Text</a> or
|
||||||
|
<a
|
||||||
|
class="reference-link" href="Code.html">Code</a> notes. To bypass this behavior and create a <em>File</em> note
|
||||||
|
type, use the <em>Import into note</em> feature and uncheck <em>Import HTML, Markdown and TXT as text notes</em>,
|
||||||
|
as well as <em>Import recognized code files as code notes</em>. </p>
|
||||||
|
<p>Since one of the use cases for having files instead of notes is to display
|
||||||
|
large files, the content preview is limited to a relatively small amount
|
||||||
|
of characters. To view the full file, consider opening it in an external
|
||||||
|
application.</p>
|
||||||
|
<h3>Unknown file types</h3>
|
||||||
|
<p>
|
||||||
|
<img src="5_File_image.png" width="532" height="240">
|
||||||
|
</p>
|
||||||
|
<p>If the file could not be identified as any of the supported file types
|
||||||
|
from above, it will be treated as an unknown file. In this case, all the
|
||||||
|
default interactions will be available such as downloading or opening the
|
||||||
|
file externally, but there will be no preview of the content.</p>
|
||||||
|
<h2>Interaction</h2>
|
||||||
|
<ul>
|
||||||
|
<li>Regardless of the file type, a series of buttons will be displayed in
|
||||||
|
the <em>Image</em> or <em>File</em> tab in the <a class="reference-link"
|
||||||
|
href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.html">Ribbon</a>.
|
||||||
|
<ul>
|
||||||
|
<li><em>Download</em>, which will download the file for local use.</li>
|
||||||
|
<li><em>Open</em>, will will open the file with the system-default application.</li>
|
||||||
|
<li>Upload new revision to replace the file with a new one.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>It is <strong>not</strong> possible to change the note type of a <em>File</em> note.</li>
|
||||||
|
<li>Convert into an <a href="../Basic%20Concepts%20and%20Features/Notes/Attachments.html">attachment</a> from
|
||||||
|
the <a href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.html">note menu</a>.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Note list</h2>
|
||||||
|
<p>Files are also displayed in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.html">Note List</a> based
|
||||||
|
on their type:</p>
|
||||||
|
<p>
|
||||||
|
<img src="8_File_image.png" width="853" height="315">
|
||||||
|
</p>
|
||||||
|
<p> </p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/File_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/File_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 156 KiB |
@ -140,6 +140,9 @@
|
|||||||
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.html"
|
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.html"
|
||||||
target="detail">Read-Only Notes</a>
|
target="detail">Read-Only Notes</a>
|
||||||
</li>
|
</li>
|
||||||
|
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20List.html"
|
||||||
|
target="detail">Note List</a>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>Navigation
|
<li>Navigation
|
||||||
@ -283,6 +286,8 @@
|
|||||||
</li>
|
</li>
|
||||||
<li><a href="User%20Guide/Note%20Types/Geo%20Map.html" target="detail">Geo Map</a>
|
<li><a href="User%20Guide/Note%20Types/Geo%20Map.html" target="detail">Geo Map</a>
|
||||||
</li>
|
</li>
|
||||||
|
<li><a href="User%20Guide/Note%20Types/File.html" target="detail">File</a>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="User%20Guide/Troubleshooting.html" target="detail">Troubleshooting</a>
|
<li><a href="User%20Guide/Troubleshooting.html" target="detail">Troubleshooting</a>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user