[Bf-docboard-svn] bf-manual: [8410] trunk/blender_docs/manual/editors/file_browser.rst: File Browser: Add rna references
Aaron Carlisle
noreply at blender.org
Tue Sep 21 06:46:45 CEST 2021
Revision: 8410
https://developer.blender.org/rBM8410
Author: Blendify
Date: 2021-09-21 06:46:45 +0200 (Tue, 21 Sep 2021)
Log Message:
-----------
File Browser: Add rna references
Modified Paths:
--------------
trunk/blender_docs/manual/editors/file_browser.rst
Modified: trunk/blender_docs/manual/editors/file_browser.rst
===================================================================
--- trunk/blender_docs/manual/editors/file_browser.rst 2021-09-21 04:22:26 UTC (rev 8409)
+++ trunk/blender_docs/manual/editors/file_browser.rst 2021-09-21 04:46:45 UTC (rev 8410)
@@ -46,24 +46,41 @@
File Path
=========
+.. _bpy.ops.file.previous:
+
Previous Folder :kbd:`Backspace`, :kbd:`Alt-Left`
Move to previous folder (in navigation history).
+
+.. _bpy.ops.file.next:
+
Next Folder :kbd:`Shift-Backspace`, :kbd:`Alt-Right`
Move to next folder (in navigation history).
+
+.. _bpy.ops.file.parent:
+
Parent File :kbd:`P`, :kbd:`Alt-Up`
Move up to parent directory.
+
+.. _bpy.ops.file.refresh:
+
Refresh File List :kbd:`R`, :kbd:`NumpadPeriod`
Refresh current folder.
+.. _bpy.ops.file.directory_new:
+
Create Directory :kbd:`I`
Will ask you to confirm and create a new directory inside current one,
scroll to it in the main view, and let you enter its name.
+.. _bpy.types.FileSelectParams.directory:
+
File Path
Text field for the current folder path.
:kbd:`Tab` will auto-complete an existing path.
If you type a nonexistent directory path, you will be prompted to create that new directory.
+.. _bpy.types.FileSelectParams.filter_search:
+
Search :kbd:`Ctrl-F`
Filter items by name.
The wildcard ``*`` will match anything, e.g. ``bl*er`` will match both ``blender`` and ``blogger``.
@@ -71,6 +88,8 @@
so ``blender`` will also match ``test_blender_file.blend``.
This field can also be used to filter some specific file extension (e.g. ``.png`` will list all PNG files).
+.. _bpy.types.FileSelectParams.display_type:
+
Display Mode
Controls how files are displayed.
@@ -83,9 +102,13 @@
Display Settings
----------------
+.. _bpy.types.FileSelectParams.display_size:
+
Display Size
The size of the thumbnails, or the width of the columns.
+.. _bpy.types.FileSelectParams.recursion_level:
+
Recursion
The number of directory levels to show at once in a flat way.
@@ -110,6 +133,8 @@
(typically, it will be exponential, showing three levels at once
may take three orders of magnitude more time to be fully listed).
+.. _bpy.types.FileSelectParams.sort_method:
+
Sort By
Sorts items by one of the four methods:
@@ -119,6 +144,8 @@
:Size: Sort files by size.
+.. _bpy.types.FileSelectParams.use_filter:
+
Filter Settings
---------------
@@ -128,9 +155,12 @@
File Types
Filters files by categories, like folders, blend-files, images, etc.
-Data-Block Types
+.. _bpy.types.FileSelectIDFilter:
+
+Blender IDs
When appending or linking, you can also filter by data-block categories, like scenes, animations, materials, etc.
+.. _bpy.types.FileSelectParams.show_hidden:
Show Hidden :kbd:`H`
Shows hidden files (starting with a ``.``).
@@ -139,6 +169,8 @@
File Name & Execution
=====================
+.. _bpy.types.FileSelectParams.filename:
+
File Name
Text field to edit the file name and extension.
When saving, if the background is red, a file with same name already exists in the folder.
@@ -148,9 +180,7 @@
Removes/Decreases or adds/increases a trailing number to your file name
(used e.g. to store different versions of a file).
-Confirm :kbd:`Return`
- The main button to validate the operation, which defines its name.
- Double-clicking on a non-directory item will have the same effect.
+.. _bpy.ops.file.cancel:
Cancel :kbd:`Esc`
Cancels the file selection (and the underlying operation), and closes the File Browser.
@@ -157,7 +187,13 @@
Using the *Back to Previous* button in the :doc:`Topbar </interface/window_system/topbar>`
will have the same effect.
+.. _bpy.ops.file.execute:
+Confirm :kbd:`Return`
+ The main button to validate the operation, which defines its name.
+ Double-clicking on a non-directory item will have the same effect.
+
+
Source List
===========
@@ -166,6 +202,8 @@
Clicking on one of the directories will immediately navigate to that folder.
+.. _bpy.types.SpaceFileBrowser.system_folders:
+
Volumes
-------
@@ -172,6 +210,8 @@
Contains all OS-defined available volumes, e.g. drives or network mounts.
+.. _bpy.types.SpaceFileBrowser.system_bookmarks:
+
System
------
@@ -178,6 +218,8 @@
Contains OS-defined common directories, like the main user folder...
+.. _bpy.types.SpaceFileBrowser.bookmarks:
+
Bookmarks
---------
@@ -186,10 +228,15 @@
e.g. add/remove an entry, move it up or down in the list, etc.
+.. _bpy.types.SpaceFileBrowser.recent_folders:
+
Recent
------
Contains recently accessed folders.
+
+.. _bpy.ops.file.reset_recent:
+
The ``X`` button to the right allows you to fully erase this list.
You can control how many folders appear in this list with the *Recent Files* number field
More information about the Bf-docboard-svn
mailing list