Răsfoiți Sursa

docs: add 'Project Browser'

Daniele Bartolini 4 zile în urmă
părinte
comite
b4aefd2383

BIN
docs/level_editor/images/project_browser.png


Fișier diff suprimat deoarece este prea mare
+ 76 - 0
docs/level_editor/images/project_browser_icon_list_view.svg


Fișier diff suprimat deoarece este prea mare
+ 44 - 0
docs/level_editor/images/project_browser_sorting_filtering.svg


Fișier diff suprimat deoarece este prea mare
+ 77 - 0
docs/level_editor/images/project_browser_tree_view.svg


+ 1 - 0
docs/level_editor/index.rst

@@ -14,5 +14,6 @@ Console.
 	:maxdepth: 2
 	:maxdepth: 2
 
 
 	level_editor
 	level_editor
+	project_browser
 	level_viewport
 	level_viewport
 	texture_settings
 	texture_settings

+ 1 - 1
docs/level_editor/level_editor.rst

@@ -15,7 +15,7 @@ The Level Editor is split into several panels:
 ====== ======================= =============
 ====== ======================= =============
 Number Name                    What it shows
 Number Name                    What it shows
 ====== ======================= =============
 ====== ======================= =============
-1      Project Browser         The current project's contents.
+1      :ref:`Project Browser`  The current project's contents.
 2      Console                 Messages from the Level Editor, the Game and other Runtimes.
 2      Console                 Messages from the Level Editor, the Game and other Runtimes.
 3      Inspector               The properties of the currently selected object.
 3      Inspector               The properties of the currently selected object.
 4      Level Tree              A hierarchical view of all the objects in the Level.
 4      Level Tree              A hierarchical view of all the objects in the Level.

+ 72 - 0
docs/level_editor/project_browser.rst

@@ -0,0 +1,72 @@
+===============
+Project Browser
+===============
+
+The Project Browser is where you view and manage the files and resources that
+make up your project. From here you can create or import new resources, open
+them, organize folders, and pin favorites for quick access.
+
+.. image:: images/project_browser.png
+
+Overview
+========
+
+By default the Project Browser is split into two panes. The top pane shows a
+tree view of the project folders. The bottom pane, called the Folder View,
+displays the contents of the currently selected folder.
+
+If you prefer a single unified view that shows files and folders together,
+click the small tree icon at the top-right to toggle the layout mode:
+
+.. image:: images/project_browser_tree_view.svg
+
+Folder View
+===========
+
+The Folder View presents the resources inside the selected folder. You can
+switch between a icon view and a compact list view using the button at the
+top-right of the Folder View:
+
+.. image:: images/project_browser_icon_list_view.svg
+
+Resources such as units, materials, textures and other graphical content use
+thumbnails that show how they will appear at runtime. Other resource types
+use a simple icon.
+
+.. image:: images/project_browser_thumbnails.png
+
+Thumbnails generated in Crown are saved in a dedicated OS location so they can
+be used by other programs such as the file manager.
+
+Files visibility
+================
+
+To keep the Project Browser uncluttered, the UI normally hides auxiliary files
+and shows resources as a single item with trimmed extension. For example, a
+texture resource on disk consists of the original image file plus a generated
+``.texture`` resource file; the browser shows them as one combined
+``.texture`` item. Similar grouping applies to other resource types.
+
+When you need to inspect the actual files on disk use the button immediately
+to the right of the Search Bar to toggle visibility options:
+
+.. image:: images/project_browser_sorting_filtering.svg
+
+With the same popup you can also control how the items should be sorted.
+
+Searching
+=========
+
+The Project Browser offers fast project-wise searching based on keywords.
+Start typing in the Search Bar and matching results appear as you type. Press
+``Escape`` to exit search mode. The Search Bar position may move depending on
+the current view mode (icon view or tree view), but the search behavior
+remains the same.
+
+Search context
+--------------
+
+By default the search covers the project itself (i.e. the main source dir). If
+your project includes mapped source directories, those are excluded from
+search results unless you enable them explicitly by checking ``Show mapped
+dirs`` in the :ref:`visibility controls <Files Visibility>`.

Unele fișiere nu au fost afișate deoarece prea multe fișiere au fost modificate în acest diff