From f1b2b1766d7c02db7379be6aa9b931e7591be24e Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sun, 16 Aug 2020 18:17:33 +0200 Subject: [PATCH] Updated documentation --- docs/source/interface.rst | 21 +++++++++++++++++++++ docs/source/projects.rst | 18 +++++++++++++++++- 2 files changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/source/interface.rst b/docs/source/interface.rst index 770b7d59..d0435abf 100644 --- a/docs/source/interface.rst +++ b/docs/source/interface.rst @@ -43,6 +43,27 @@ currently selected item. This panel also includes the latest paragraph and chara addition to the word count. +.. _a_ui_tree_dnd: + +Project Tree Drag and Drop +-------------------------- + +The project tree allows dragging and drop to a certain extent, but it does not allow bulk actions. +This is deliberate to avoid accidentally messing up your project. The project tree has no undo +function. + +Document files and their folders can be rearranged freely within their root folders. Novel files +cannot be moved out of the :guilabel:`Novel` folder, except to :guilabel:`Trash` and the +:guilabel:`Outtakes` folder. Note files can be moved freely anywhere. + +Folders cannot be moved at all outside their root tree. Neither can a folder containing files be +deleted. You must first delete the files. + +Root folders in the project tree cannot be dragged and dropped. However, if you want to reorder +them, you can move them up or down with respect to eachother from the :guilabel:`Tools` menu, or by +pressing :kbd:`Ctrl`:kbd:`Shift` and the :kbd:`Up` or :kbd:`Down` key. + + .. _a_ui_edit: Editing and Viewing Documents diff --git a/docs/source/projects.rst b/docs/source/projects.rst index cc3808ec..199ed904 100644 --- a/docs/source/projects.rst +++ b/docs/source/projects.rst @@ -87,7 +87,7 @@ Deleted Documents Deleted document files will be moved into a special :guilabel:`Trash` root folder. Files in the trash folder can then be deleted permanently, either individually, or by emptying the trash from the -menu. +menu. Files in this folder are removed from the project index and cannot be referenced. Folders and root folders can only be deleted when they are empty. Recursive deletion is not supported. @@ -96,6 +96,22 @@ A document file or a folder can be deleted from the :guilabel:`project` menu, or :kbd:`Ctrl`:kbd:`Del`. +.. _a_proj_roots_out: + +Archived Documents (Outtakes) +----------------------------- + +If you don't want to delete a file, or put it in the :guilabel:`Trash` folder where it may be +deleted, but still want it out of your main project tree, you can create an :guilabel:`Outtakes` +root folder from the :guilabel:`project` menu. This folder is similar to the :guilabel:`Trash` +folder in that it doesn't allow subfolders and creating new files. + +You can drag any file to this folder and preserve its settings. The file will always be excluded +from the :guilabel:`Build Novel Project` builds, even with the setting to ignore the excluded files +option. The file is also removed from the project index, so the tags and references defined in it +will not show up anywhere else. + + .. _a_proj_roots_orph: Orphaned Documents