Skip to content

Latest commit

 

History

History
142 lines (97 loc) · 15.5 KB

session.md

File metadata and controls

142 lines (97 loc) · 15.5 KB
Raw
title linktitle weight
Sessions, Workspaces, and Projects
sessions
40

Sessions, Workspaces, and Projects

There are three built-in "multiple file management" systems available natively in Notepad++.

  • Sessions = a set of files that can be opened with one action.
  • Folder as Workspace = a tree-based interface to easily access the files in a given Windows directory.
  • Project Panels = a tree-based interface to access related files that aren't necessarily grouped in the same Windows directory structure.

There are also various plugins available that might help manage sessions or workspaces, or serve similar purposes but with a different feature set compared to these built-in features.

Sessions

Sessions are a set of files to be opened in Notepad++. Using sessions, you can open a set of files with one action. They do not have to be in the same directory or even on the same drive.

The session file stores the paths of the open files, the active file (and which view, see the section about Multi-View), the current selection and position in the file, the current bookmarks (see Bookmarks) and the current language (see the section about Languages). When you load the session, all of that information is loaded back into Notepad++.

  • File > Load Session... can be used to load an existing session.
  • File > Save Session... can be used to save the currently-open files as a session.

Session files are XML, and are identical in format to the session.xml config file. The MISC preferences include an option to set a file extension that will automatically be opened equivalently to Load Session, even if you use File > Open to access that session; that extension will also be the default when you Save Session¹.

You can also load a session file using the -openSession command line argument.

When you load a session: If you are set to "Default (Mono-instance)" in the Multi-instance settings, then the files from that session are added to the current instance of Notepad++ (files already open will remain open, even if they aren't in the session you loaded); if you are set to either "Open session in new instance" or "Always in multi-instance mode", then the files from the session you are loading are opened in a new Notepad++ instance.

Note: As of Notepad++ v8.2, the loaded session is saved automatically on exit of Notepad++, if the Multi-instance settings is not set to "Default (Mono-instance)".

Caveat: Unlike the default session.xml, which follows the Settings > Preferences > Backup > ☐ Enable session snapshot and periodic backup option and will keep new unnamed/unsaved documents in the main session when enabled, manual sessions do not follow that setting: if you have one or more new unsaved/unnamed documents, and use File > Save Session..., those documents will not be included in the saved session. If you want a document to be included when you File > Save Session..., you need to have previously saved that document to a file on your filesystem.

Inaccessible Files

Sometimes, when you load a session, you might temporarily not be able to access a certain file -- for example, if your network drive is temporarily inaccessbile, or your internet connection is down so a cloud-based folder is out-of-date. Starting in Notepad++ v8.6, there is a Settings > Preferences > Backup option to ☐ Remember inaccessible files from past session when you load a session (either through the menu or the default session). With this checkmarked, if Notepad++ cannot find the files mentioned, it will ask if you want to create "placeholders": if you do, then there will be empty read-only tabs in Notepad++, and the next time you load the session, if the files are accessible again, Notepad++ will load those files again; if you choose to not create the placeholders, then those files will be removed from the session file, and loading that session in the future will not attempt to load those inaccessible files anymore. If you choose to let Notepad++ create a placeholder file but later close it, Notepad++ will also modify your session file when it exits, and it will no longer attempt to load those inaccessible files, because they are not in your session any more. If you want Notepad++ to load the inaccessible files the next time you load the session, you must choose to create the placeholders and must not close the placeholder tabs in Notepad++. Also, for the placeholder files, if the inaccessible file becomes available again while Notepad++ is still open, it will prompt you to reload the file (just like Notepad++ does when it notices a file has been changed by an external program) -- you will want to say Yes to this prompt for Notepad++ to again show the contents of the previously-inaccessible file.

Folder as Workspace

This feature allows you to use a tree-based interface to easily access the files in one or more filesystem directory. When you drag a folder from Windows Explorer onto Notepad++, this feature will be activated (unless overridden by the "... folder dropping" option).

You can also load a Folder as Workspace using the -openFoldersAsWorkspace command line argument.

The toolbar for the panel has three buttons:

  • Unfold All: Shows the entire hierarchy of all the directories shown.
  • Fold All: Collapses all the directory hierarchies so it just shows the top-level folders.
  • Locate Current File: If the file being actively edited in Notepad++'s active editor view is in one of the folders shown in the panel, the panel will unfold and scroll to that file in the file list, and will highlight that file.

For folders/directories in the panel:

  • If it has the ﹀ down-arrow chevron, clicking that will "fold" that level so that the files and directories under it are not visible.
  • If it has the 〉 right-arrow chevron, clicking that will "unfold" that level, so that it will show the files and directories under that directory.
  • Right-clicking on a directory's entry will bring up a context menu:
    • Remove: Will remove that directory hierarchy from the Folder as Workspace panel (only available on the top level Folder as Workspace directories, not on subdirectories).
    • Copy Path: Puts the full path of the directory into the Windows clipboard, so you can paste it in Notepad++ or elsewhere in Windows.
    • Find in Files: Opens the Search > Find in Files dialog with that directory chosen as the directory to be searched.
    • Explorer Here: Opens the Windows Explorer on that directory.
    • CMD Here: Opens a Windows cmd.exe window in that directory.

For files in that panel:

  • Double-clicking on a file's entry will open that file in Notepad++'s active view, or will activate that file's tab if the file is already open in the current Notepad++ instance.
  • Right-clicking on a file's entry will bring up a context menu:
    • Open: Will open that file in Notepad++'s active view, or will activate that file's tab if the file is already open in the current Notepad++ instance.
    • Copy Path: Puts the full path of the file into the Windows clipboard, so you can paste it in Notepad++ or elsewhere in Windows.
    • Copy File Name: Puts the filename into the Windows clipboard.
    • Run by System: This will launch the file with Windows default application for that file type.
    • Explorer Here: Opens the Windows Explorer in the directory where the file is located.
    • CMD Here: Opens a Windows cmd.exe window in the directory where the file is located.

If you right click in the empty space in the Folder as Workspace panel (either in the empty portion of the toolbar to the left of the icons, or in the empty space below the final directory listing in the panel), you will get a context menu with Add and Remove All.

  • Add: Will let you open another folder into the panel.
  • Remove All: Will remove all directories from the Folder as Workspace panel.

If there isn't any "empty space" to right-click on, you can either widen the panel (giving more empty space on the panel's toolbar) or you can collapse one or all of the folder listings (using the ﹀ by the folder name or the Fold All button on the toolbar) to show empty space at the bottom where you can right click.

Project Panels

The Project Panels are similar to the Folder as Workspace panel, but allow you to organize the tree view to your liking, rather than being forced to follow the Windows filesystem hiearchy.

Double-clicking on a file from the tree-view will open it as a new tab in the Notepad++ editor (or will activate that tab if it's already open). Closing the tab for a file from the Project will not remove it from the Project panel, so it's easy to re-open that file.

There are three Project Panels available from the View > Project Panels sub-menu. The three Project Panels can be individually docked or floated.

In each panel, you can open one Workspace file. Using the Workspace button on the Project Panel, or right clicking on the Workspace's name in the tree view, you can perform a variety of actions, enumerated below. The MISC preferences include an option to set a file extension that will automatically be opened equivalently to the Open Workspace command, even if you use File > Open to access that Workspace file; that extension will also be the default when you Save Workspace¹.

Each Workspace can house one or more Projects. Clicking the Edit button on the Project Panel, or right clicking on the Project name, will give you administrative options for the selected Project, enumerated below. In each Project, you can select individual files or the contents of whole Windows Directories to be added to the Project, and you can reorder the files. If you add a Folder to the Project, you are not creating a Windows directory anywhere: you are creating a container inside the Notepad++ Project item; the files listed in a folder have not moved. To reiterate: Project Folders are independent of the filesystem, and are just hierarchical containers for this feature of Notepad++.

You can move a file from one place in the Project panel into a different Folder or Project by dragging the file within the Project Panel and dropping it on the name of the Project or Folder you want the file to move into. Other than that, there aren't other drag-and-drop features in the Project Panel.

Project Workspace files always contain file paths relative to the location of the workspace file itself. Thus, if a workspace file is stored in a filesystem folder which is part of a project, it is very easy to move that folder to another location on the hard disk. If the workspace file is loaded from its new location it will still work to load the local copy of the project. (Because these files contain relative paths, when you open an existing workspace file or save a new workspace file, Notepad++ will default to being in the same directory as the file you are actively editing. If you prefer a centralized directory to store all your workspace files, you will have to manually change to that directory to open or save there.)

Project Panel Specifics

For any entry in the Project Panel tree view, right clicking will give you the available actions on that specific entry.

  • On a Workspace:
    • New Workspace: Close the existing Workspace (if one is open for this Project Panel) and create an empty Workspace for this Project Panel.
    • Open Workspace: Close the existing Workspace (if one is open for this Project Panel) and open the selected Workspace file.
    • Reload Workspace: Re-read the XML file for the active Workspace (it may have been edited externally).
    • Save: Save any changes in the Projects, files, and Folders of the active Workspace configuration.
    • Save As: Save the active Workspace in a new Windows filesystem location and use that new Workspace, while still leaving the old Workspace file under the old name. (Example: if your active Workspace is one.wkspc and you Save As two.wkspc, then one.wkspc will still exist, but the active Workspace will be two.wkspc.)
    • Save a Copy As: Save the active Workspace in a new Windows filesystem location, while still keeping the old Workspace file as the active Workspace. (Example: if your active Workspace is one.wkspc and you Save a Copy As two.wkspc, then one.wkspc will still exist and be active, but there will also be a two.wkspc saved but not open.)
    • Add New Project: Add a new Project container to the active Workspace.
  • On a Project entry:
    • Move Up / Move Down: Reorder the selected Project relative to other Projects in the Workspace.
    • Rename: Change the name of the Project.
    • Add Folder: Create a new container to go in this Project.
    • Add Files: Use a Windows Open dialog to select one or more files to add to the Project's tree.
    • Add Files from Directory: Add all the files from that Windows directory into the Project.
      • Please note: This does not create a new Folder entry in your Project.
  • On a Folder entry:
    • Has all the same actions as on the Project entry, but everything is relative to this Folder instead of relative to the Project.
  • On a File entry:
    • Move Up / Move Down: Reorder the selected file relative to other files or Folders in the containing Project or Folder.
    • Rename: Changes the name of the file in the list.
      • This action does not change the underlying file.
      • If the new name does not exist as a file, it will show a little error symbol on the file icon in the tree.
      • If the new name does exist as a file, the old file will still exist but will no longer be a part of this Project.
    • Remove: Removes the file from the Project.
      • This action does not change the underlying file.
    • Modify File Path: Similar to rename, changes the file in the list, but also allows you to change what Windows directory is being referenced.
      • This action does not change the underlying file.
      • If the new name does not exist as a file, it will show a little error symbol on the file icon in the tree.
      • If the new name does exist as a file, the old file will still exist but will no longer be a part of this Project.

Differences Between Projects and Folder as Workspace

In contrast to the Folder as Workspace feature, Projects are not bound to the content of a certain folder on the hard disk. Instead, it is possible to put together files and folders from various locations on the hard disk into one Project. It is even possible to create Folders in a project which actually don’t exist on the hard disk and add files from various locations to them. With projects, it is possible to combine files and folders into a totally virtual structure. This can speed up accessing files which are logically related to each other but are widely spread over the hard disk.

Footnotes

¹: if you set the Session or Workspace extensions, you will find it difficult to edit the XML for the given Session or Workspace file inside Notepad++. To do that, you can temporarily clear that preference setting, edit the file, then set the extension preference again.