diff --git a/docs/istorage-enum.md b/docs/istorage-enum.md deleted file mode 100644 index f9d620f082bf..000000000000 --- a/docs/istorage-enum.md +++ /dev/null @@ -1,50 +0,0 @@ -## Code examples - -```cs -using System; -using System.Collections.Generic; -using System.Threading; - -namespace SecureFolderFS.Sdk.Storage.StorageEnumeration -{ - /// - /// Enumerates storage objects of a given directory. - /// - /// This interface can be implemented to provide complex enumeration of directories as well as being a substitute for built-in enumeration. - /// - public interface IStorageEnumerator : IDisposable - { - /// - /// Gets the folder where enumeration takes place. - /// - IFolder SourceFolder { get; } - - /// - /// Enumerates the for files. - /// - /// A that cancels this action. - /// Returns an async operation represented by of type of all files discovered by the enumerator. - IAsyncEnumerable> EnumerateFilesAsync(CancellationToken cancellationToken = default); - - /// - /// Enumerates the for folders. - /// - /// A that cancels this action. - /// Returns an async operation represented by of type of all folders discovered by the enumerator. - IAsyncEnumerable> EnumerateFoldersAsync(CancellationToken cancellationToken = default); - - /// - /// Enumerates the for items. - /// - /// A that cancels this action. - /// Returns an async operation represented by of type of all items discovered by the enumerator. - IAsyncEnumerable> EnumerateStorageAsync(CancellationToken cancellationToken = default); - } -} - -class EnumerationResult where T : IStorable -{ - T Storable { get; } - IStoragePropertiesCollection? Properties { get; } -} -``` \ No newline at end of file diff --git a/docs/listeditem.md b/docs/listeditem.md deleted file mode 100644 index 1c6a20554d39..000000000000 --- a/docs/listeditem.md +++ /dev/null @@ -1,76 +0,0 @@ -# StorableViewModel - -## Code examples -```csharp - public abstract class StorableViewModel : ObservableObject - { - public IStorable Storable { get; } - - public StorageItemViewModel(IStorable storable) - { - this.storable = storable; - } - } -``` - -```csharp - public class StandardItemViewModel : StorableViewModel - { - private long _size; - - public long Size - { - get => _size; - set => SetProperty(ref _size, value); - } - - // ... DateModified, DateCreated as well - - public IStoragePropertiesCollection Properties { get; } - - public StandardItemViewModel(IStorable storable, IStoragePropertiesCollection properties) : base(storable) - { - this.Properties = properties; - } - - public void - } -``` - -Adds an `ItemPropertiesKind` enum: - -```csharp -public enum ItemPropertiesKind -{ - Standard, - Extended -} -``` - -Amends the IStoragePropertiesCollection interface to include an enum parameter on `GetStoragePropertiesAsync` method: - -```csharp -using System; -using System.Collections.Generic; -using System.Threading; -using System.Threading.Tasks; - -namespace SecureFolderFS.Sdk.Storage.StorageProperties -{ - - public interface IStoragePropertiesCollection - { - DateTime DateCreated { get; } - - - DateTime DateModified { get; } - - - ulong? Size { get; } - - - IAsyncEnumerable GetStoragePropertiesAsync(ItemPropertiesKind propertiesKind = ItemPropertiesKind.Standard, CancellationToken cancellationToken = default); - } -} -``` - diff --git a/docs/rich-commands.md b/docs/rich-commands.md deleted file mode 100644 index 35f230849088..000000000000 --- a/docs/rich-commands.md +++ /dev/null @@ -1,157 +0,0 @@ -# Concept of Rich Commands - -> [!INFO] -> Write down here - -# Commands - -This is the list of all commands defined in `CommandCodes` enum except `None`. - -| Category | Name | Label | Description | HotKey | -| ------------------ | ----------------------------------- | ----------------------------------------- | -------------------------------------------------------- | ------------------- | -| Global | OpenHelp | Help | Open online help page in browser | F1 | -| | ToggleFullScreen | FullScreen | Toggle full screen | F11 | -| | EnterCompactOverlay | Enter compact overlay | Enter compact overlay | Ctrl+Alt+Up | -| | ExitCompactOverlay | Exit compact overlay | Exit compact overlay | Ctrl+Alt+Down | -| | ToggleCompactOverlay | Toggle compact overlay | Toggle compact overlay | F12 | -| | Search | Search | Go to search box | Ctrl+F, F3 | -| | SearchUnindexedItems | Search unindexed items | Search for unindexed items | | -| | Redo | Redo | Redo the last file operation | Ctrl+Y | -| | Undo | Undo | Undo the last file operation | Ctrl+Z | -| | EditPath | Edit path | Focus path bar | Ctrl+L, Alt+D | -| Show | ToggleShowHiddenItems | Show hidden items | Toggle whether to show hidden items | Ctrl+H | -| | ToggleShowFileExtensions | Show file extensions | Toggle whether to show file extensions | | -| | TogglePreviewPane | Toggle the preview pane | Toggle whether to show preview pane | Ctrl+P | -| | ToggleSidebar | Toggle the sidebar | Toggle whether to show sidebar | Ctrl+B | -| File System | CopyItem | Copy | Copy item(s) to clipboard | Ctrl+C | -| | CopyPath | Copy path | Copy path of item to clipboard | Ctrl+Shift+C | -| | CutItem | Cut | Cut item(s) to clipboard | Ctrl+X | -| | PasteItemToSelection | Paste | Paste item(s) from clipboard to selected folder | Ctrl+Shift+V | -| | DeleteItem | Delete | Delete item(s) | Delete, Ctrl+D | -| | DeletemeItemPermanently | Delete permanently | Delete item(s) permanently | Shift+Delete | -| | CreateFolder | Folder | Create new folder | | -| | CreateFolderWithSelection | Create folder with selection | Create a folder with the currently selected item(s) | | -| | AddItem | New | Create new item | Ctrl+Shift+N | -| | CreateShortcut | Create shortcut | Create new shortcut(s) to selected item(s) | | -| | CreateShortcutFromDialog | Shortcut | Create new shortcut to any item | | -| | EmptyRecycleBin | Empty Recycle Bin | Empty recycle bin | | -| | FormatDrive | Format... | Open "Format Drive" menu for selected item | | -| | RestoreRecycleBin | Restore | Restore selected item(s) from recycle bin | | -| | RestoreAllRecycleBin | Restore All Items | Restore all items from recycle bin | | -| | OpenItem | Open | Open item(s) | Enter | -| | OpenItemWithApplicationPicker | Open with | Open item(s) with selected application | | -| | OpenParentFolder | Open parent folder | Open parent folder of searched item | | -| | OpenFileLocation | Open file location | Open the item's location | | -| | RefreshItems | Refresh | Refresh page contents | Ctrl+R, F5 | -| | Rename | Rename | Rename selected item | F2 | -| Selection | SelectAll | Select All | Select all items | Ctrl+A | -| | InvertSelection | Invert Selection | Invert item selection | | -| | ClearSelection | Clear Selection | Clear item selection | | -| | ToggleSelect | Toggle Selection | Toggle item selection | Ctrl+Space | -| Share | ShareItem | Share | Share selected file(s) with others | | -| Start | PinToStart | Pin to the Start Menu | Pin item(s) to the Start Menu | | -| | UnpinFromStart | Unpin from the Start Menu | Unpin item(s) from the Start Menu | | -| Sidebar | PinFolderToSidebar | Pin to Sidebar | Pin folder(s) to Sidebar | | -| | UnpinFolderFromSidebar | Unpin from Sidebar | Unpin folder(s) from Sidebar | | -| Backgrounds | SetAsWallpaperBackground | Set as desktop background | Set selected picture as desktop background | | -| | SetAsSlideshowBackground | Set as desktop slideshow | Set selected pictures as desktop slideshow | | -| | SetAsLockscreenBackground | Set as lockscreen background | Set selected picture as lockscreen background | | -| Install | InstallFont | Install | Install selected font(s) | | -| | InstallInfDriver | Install | Install driver(s) using selected inf file(s) | | -| | InstallCertificate | Install | Install selected certificate(s) | | -| Run | RunAsAdmin | Run as administrator | Run selected application as administrator | | -| | RunAsAnotherUser | Run as another user | Run selected application as another user | | -| | RunWithPowershell | Run with PowerShell | Run selected PowerShell script | | -| Preview Popup | LaunchPreviewPopup | Launch preview popup | Launch preview in popup window | Space | -| Archives | CompressIntoArchive | Create archive | Create archive with selected item(s) | | -| | CompressIntoSevenZip | Create _ArchiveName_.7z | Create 7z archive instantly with selected item(s) | | -| | CompressIntoZip | Create _ArchiveName_.zip | Create zip archive instantly with selected item(s) | | -| | DecompressArchive | Extract files | Extract items from selected archive(s) to any folder | Ctrl+E | -| | DecompressArchiveHere | Extract here | Extract items from selected archive(s) to current folder | | -| | DecompressArchiveToChildFolder | Extract to _NewFolderName_ | Extract items from selected archive(s) to new folder | | -| Image Manipulation | RotateLeft | Rotate left | Rotate selected image(s) to the left | | -| | RotateRight | Rotate right | Rotate selected image(s) to the right | | -| Open | OpenInVS | Visual Studio | Open the current directory in Visual Studio | | -| | OpenInVSCode | VS Code | Open the current directory in Visual Studio Code | | -| | OpenProperties | Open properties | Open properties window | Alt+Enter | -| | OpenSettings | Settings | Open settings page | Ctrl+, | -| | OpenTerminal | Open in terminal | Open folder in terminal | Ctrl+\` | -| | OpenTerminalAsAdmin | Open in terminal as administrator | Open folder in terminal as administrator | Ctrl+Shift+\` | -| | OpenCommandPalette | Command palette | Open command palette | Ctrl+Shift+P | -| Layout | LayoutDecreaseSize | Decrease size | Decrease icon size in grid view | Ctrl+- | -| | LayoutIncreaseSize | Increase size | Increase icon size in grid view | Ctrl++ | -| | LayoutDetails | Details | Switch to details view | Ctrl+Shift+1 | -| | LayoutTiles | Tiles | Switch to tiles view | Ctrl+Shift+2 | -| | LayoutGridSmall | Small Icons | Switch to grid view with small icons | Ctrl+Shift+3 | -| | LayoutGridMedium | Medium Icons | Switch to grid view with medium icons | Ctrl+Shift+4 | -| | LayoutGridLarge | Large Icons | Switch to grid view with large icons | Ctrl+Shift+5 | -| | LayoutColumns | Columns | Switch to columns view | Ctrl+Shift+6 | -| | LayoutAdaptive | Adaptive | Switch views adaptively | Ctrl+Shift+7 | -| Sort by | SortByName | Name | Sort items by name | | -| | SortByDateModified | Date modified | Sort items by date modified | | -| | SortByDateCreated | Date created | Sort items by date created | | -| | SortBySize | Size | Sort items by size | | -| | SortByType | Type | Sort items by type | | -| | SortBySyncStatus | Sync status | Sort items by sync status | | -| | SortByTag | Tags | Sort items by tags | | -| | SortByPath | Path | Sort items by path | | -| | SortByOriginalFolder | Original folder | Sort items by original folder | | -| | SortByDateDeleted | Date deleted | Sort items by date deleted | | -| | SortAscending | Ascending | Sort items in ascending order | | -| | SortDescending | Descending | Sort items in descending order | | -| | ToggleSortDirection | Toggle sort direction | Toggle item sort direction | | -| | ToggleSortDirectoriesAlongsideFiles | List and sort directories alongside files | List and sort directories alongside files | | -| Group by | GroupByNone | None | List items without grouping | | -| | GroupByName | Name | Group items by name | | -| | GroupByDateModified | Date modified | Group items by date modified | | -| | GroupByDateCreated | Date created | Group items by date created | | -| | GroupBySize | Size | Group items by size | | -| | GroupByType | Type | Group items by type | | -| | GroupBySyncStatus | Sync status | Group items by sync status | | -| | GroupByTag | Tags | Group items by tags | | -| | GroupByOriginalFolder | Original folder | Group items by original folder | | -| | GroupByDateDeleted | Date deleted | Group items by date deleted | | -| | GroupByFolderPath | Folder path | Group items by folder path | | -| | GroupByDateModifiedYear | Year | Group items by year of date modified | | -| | GroupByDateModifiedMonth | Month | Group items by month of date modified | | -| | GroupByDateModifiedDay | Day | Group items by day of date modified | | -| | GroupByDateCreatedYear | Year | Group items by year of date created | | -| | GroupByDateCreatedMonth | Month | Group items by month of date created | | -| | GroupByDateCreatedDay | Day | Group items by day of date created | | -| | GroupByDateDeletedYear | Year | Group items by year of date deleted | | -| | GroupByDateDeletedMonth | Month | Group items by month of date deleted | | -| | GroupByDateDeletedDay | Day | Group items by day of date deleted | | -| | GroupAscending | Ascending | Sort groups in ascending order | | -| | GroupDescending | Descending | Sort groups in descending order | | -| | ToggleGroupDirection | Toggle sort direction | Toggle group sort direction | | -| | GroupByYear | Year | Group items by year | | -| | GroupByMonth | Month | Group items by month | | -| | ToggleGroupByDateUnit | Toggle grouping unit | Toggle unit for grouping by date | | -| Navigation | NewTab | New tab | Open new tab | Ctrl+T | -| | NavigateBack | Back | Navigate backward in navigation history | Alt+Left, Backspace | -| | NavigateForward | Forward | Navigate forward in navigation history | Alt+Right | -| | NavigateUp | Up | Navigate up one directory | Alt+Up | -| Other | DuplicateCurrentTab | Duplicate tab | Duplicate current tab | | -| | DuplicateSelectedTab | Duplicate tab | Duplicate selected tab | Ctrl+Shift+K | -| | CloseTabsToTheLeftCurrent | Close tabs to the left | Close tabs to the left of current tab | | -| | CloseTabsToTheLeftSelected | Close tabs to the left | Close tabs to the left of selected tab | | -| | CloseTabsToTheRightCurrent | Close tabs to the right | Close tabs to the right of current tab | | -| | CloseTabsToTheRightSelected | Close tabs to the right | Close tabs to the right of selected tab | | -| | CloseOtherTabsCurrent | Close other tabs | Close tabs other than current tab | | -| | CloseOtherTabsSelected | Close other tabs | Close tabs other than selected tab | | -| | OpenDirectoryInNewPane | Open in new pane | Open directory in new pane | | -| | OpenDirectoryInNewTab | Open in new tab | Open directory in new tab | | -| | OpenInNewWindowItem | Open in new window | Open directory in new window | | -| | ReopenClosedTab | Reopen closed tab | Reopen last closed tab | Ctrl+Shift+T | -| | PreviousTab | Moves to the previous tab | Move to the previous tab | Ctrl+Shift+Tab | -| | NextTab | Moves to the next tab | Move to the next tab | Ctrl+Tab | -| | CloseSelectedTab | Closes current tab | Close current tab | Ctrl+W, Ctrl+F4 | -| | OpenNewPane | New pane | Open new pane | Alt+Shift++ | -| | ClosePane | Close pane | Close right pane | Ctrl+Shift+W | -| Play | PlayAll | Play all | Play the selected media files | | -| Git | GitFetch | Fetch | Run git fetch | | -| | GitInit | Initialize repo | Initialize a Git repository | | -| | GitPull | Pull | Run git pull | | -| | GitPush | Push | Run git push | | -| | GitSync | Sync | Run git pull and then git push | | -| Tags | OpenAllTaggedItems | Open all | Open all tagged items | | diff --git a/docs/spec-template.md b/docs/spec-template.md deleted file mode 100644 index ab9e21f9ca19..000000000000 --- a/docs/spec-template.md +++ /dev/null @@ -1,76 +0,0 @@ - - - - -# Background - - - - - - - - - - - -# Description - - - -# Examples - - - - - - - -# Remarks - - - - -# API Notes - - - - -# API Details - - -# Appendix - \ No newline at end of file diff --git a/docs/storage-layer.md b/docs/storage-layer.md deleted file mode 100644 index ac2ee59c601e..000000000000 --- a/docs/storage-layer.md +++ /dev/null @@ -1,74 +0,0 @@ -# A New Era for the Storage Layer in Files App - -## Background - - - - - - -Presently, it is common for users to browse a large folder of storage items, but only interact with a small subset of them, if any. Relatively recent expansions to the type of filesystem APIs allowed within an `AppContainer` (low-IL) context have improved the app experience for users by many orders of magnitude. Notably, telemetry data implies that app session durations are not only longer but also more inline with user expectations. Over the last three years, contributors have used this insight to justify significant investment into how Files enumerates storage items from the filesystem. - -One of the most consequential parts of this effort was the distinction between standard and extended item properties. Standard properties are those that Files can access quickly using the `FindFirstFileExFromApp()` method, and extended properties are those that Files cannot access quickly due to the required overhead of constructing an `IStorageItem` instance. Luckily, transitioning away from the bulk enumeration methods on `StorageFolder` resulted in significant performance improvements; a sizable reduction in memory usage; and the learning that users, at any given moment, are *almost never* concerned with every single storage item in the working directory-let alone every single property of each item in the viewport. - -Thus, the decision was made that extended properties like the thumbnail, display type, and others should have their value availability deferred until the respective item container is scrolled into the viewport. While not all layout modes at the time included an `ItemsControl` such as `ListView` or `GridView`, this *lazy loading* scheme was enabled by particular UI virtualization events on the controls, which fire when the user scrolls new items into the viewport. - -The Files developers are of the opinion that further improvements can be made to the storage layer. - -## Motivation -The current storage layer that includes these prior improvements is very loosely organized, but one of its major characteristics is a largely unmaintainable monolith that lacks sound architecture patterns. Many intended concerns of this so-called `ItemViewModel` are poorly defined for the demands of a flexible, consistent and extensible storage layer. - -Community ambitions to deliver a high-quality file manager experience wherever users may be also catalyze this effort, for the necessary ability to display items from multiple non-native sources requires careful planning. - -Lastly, the current *lazy loading* pattern was introduced at a time before all layout modes used `ItemsControl`s, and thus could not take advantage of virtualization at the data source level. - -## Description - - - -## Examples - - - - - - - -## Remarks - - - - -## API Notes - - - - -## API Details - - -## Appendix - \ No newline at end of file