mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
Update topics/file documentation (closes #1481)
This commit is contained in:
parent
5f86a69fdf
commit
b8f9dd91d9
BIN
docs/en/topics/_images/assets.png
Normal file
BIN
docs/en/topics/_images/assets.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 88 KiB |
BIN
docs/en/topics/_images/assets_editform.png
Normal file
BIN
docs/en/topics/_images/assets_editform.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 140 KiB |
BIN
docs/en/topics/_images/assets_sync.png
Normal file
BIN
docs/en/topics/_images/assets_sync.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 33 KiB |
BIN
docs/en/topics/_images/assets_up.png
Normal file
BIN
docs/en/topics/_images/assets_up.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 109 KiB |
@ -1,19 +1,38 @@
|
||||
# Files and Images
|
||||
# Files, Images and Folders
|
||||
|
||||
## Files as database records
|
||||
## Files, Images and Folders as database records
|
||||
|
||||
TODO Explain relationship of files to database
|
||||
All files, images and folders in the 'assets' directory are stored in the database. Each record has the following database fields:
|
||||
|
||||
## Management through "Files & Images"
|
||||
| Field name | Description |
|
||||
| ---------- | ----------- |
|
||||
| `ClassName` | The class name of the file (e.g. File, Image or Folder). |
|
||||
| `Name` | The 'basename' of the file, or the folder name. For example 'my-image.jpg', or 'images' for a folder. |
|
||||
| `Title` | The optional, human-readable title of the file for display only (doesn't apply to folders). |
|
||||
| `Filename` | The path to the file/folder, relative to the webroot. For example 'assets/images/my-image.jpg', or 'assets/images/' for a folder. |
|
||||
| `Content` | Typically unused, but handy for a textual representation of files. For example for fulltext indexing of PDF documents. |
|
||||
| `ShowInSearch` | Whether the file should be shown in search results, defaults to '1'. See ["Tutorial 4 - Site Search"](/tutorials/4-site-search) for enabling search. |
|
||||
| `ParentID` | The ID of the parent Folder that this File/Folder is in. A ParentID of '0' indicates that the File/Folder is in the 'assets' directory. |
|
||||
| `OwnerID` | The ID of the Member that 'owns' the File/Folder (not related to filesystem permissions). |
|
||||
|
||||
TODO Screenshot of admin interface
|
||||
## Management through the "Files" section of the CMS
|
||||
|
||||
If you have the CMS module installed, you can manage files, folders and images in the "Files" section of the CMS. Inside this section, you will see a list of files and folders like below:
|
||||
|
||||
![](_images/assets.png)
|
||||
|
||||
You can click on any file to edit it, or click on any folder to open it. To delete a file or a folder, simply click the red 'X' symbol next to it. If you click to open a folder, you can go back up one level by clicking the 'up' arrow above the folder name (highlighted below):
|
||||
|
||||
![](_images/assets_up.png)
|
||||
|
||||
Once you click to edit a file, you will see a form similar to the one below, in which you can edit the file's title, filename, owner, or even change which folder the file is located in:
|
||||
|
||||
![](_images/assets_editform.png)
|
||||
|
||||
You may also notice the 'Sync files' button (highlighted below). This button allows CMS users to 'synchronise' the database (remember, all files/folders are stored as database records) with the filesystem. This is particularly useful if someone has uploaded or removed files/folders via FTP, for example.
|
||||
|
||||
![](_images/assets_sync.png)
|
||||
|
||||
## Upload
|
||||
|
||||
TODO Link to UploadField and FileField classes
|
||||
|
||||
## Image Resizing
|
||||
|
||||
If you've changed the resize functions of your image uploaders you can run this again - and all the images will be
|
||||
resampled to the new arguments for the GD functions. This also, in some cases, repairs broken image links that can
|
||||
happen from time to time.
|
||||
Files can be managed through a `FileField` or an `UploadField`. The `[api:FileField]` class provides a simple HTML input with a type of "file", whereas an `[api:UploadField]` provides a much more feature-rich field (including AJAX-based uploads, previews, relationship management and file data management). See [`Reference - UploadField`](/reference/uploadfield) for more information about how to use the `UploadField` class.
|
Loading…
Reference in New Issue
Block a user