Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-04 02:06:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update file explorer readme (#1780)

Browse Source 
* Updated readme

* Updated readme for file explorer module and demo gif

* Updated figure description

* Fixed typo

* Moved the localizaton instruction to separate file

* Updated coding guidance readme
This commit is contained in:
udit3333
2020-04-01 08:26:19 -07:00
committed by GitHub
parent ea18fa95ad
commit 94ccabd5ce
4 changed files with 85 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
src/modules/previewpane/README.md
View File

@@ -1,28 +1,25 @@
<center>
<img width="200" src="../../../doc/images/Logo.jpg">
# PowerPreview
# File Explorer
File Explorer add-ons, right now are just limited to Preview Pane additions for File Explorer.
## Preview Pane
Preview Pane is an existing feature in the File Explorer which shows a lightweight, rich, read-only preview of the file's contents in the view's reading pane. To enable it, you just click the View tab in the ribbon and then click `Preview Pane`. Below is an example of Markdown and Svg files previews in File Explorer with PowerToys.
![PowerToys Preview Pane Demo](../../../doc/images/preview_pane/demo.gif)
> Adding Custom Preview Handlers to Windows File Explorer Preview Pane.
[**Overview**](#overview) ·
[**Developing**](#Developing) ·
[**MSIX Integration**](#Install-With-MSIX) ·
[**Contributing »**](#Contributing)
</center>
[**Installation**](#Installation) ·
## Overview
Preview handlers are called when an item is selected to show a lightweight, rich, read-only preview of the file's contents in the view's reading pane. This is done without launching the file's associated application. Figure 1 shows an example of a preview handler that preview a .md file type. Please follow this [documentation](https://docs.microsoft.com/en-us/archive/msdn-magazine/2007/january/windows-vista-and-office-writing-your-own-preview-handlers) to start developing a preview handler, when done, continue with this documentation to learn how to integrate a preview handler into PowerToys.
<center>
<figure>
<img src="../../../doc/images/preview_pane/markdown.gif" alt="Mark Down Preview Handler Demo" >
<figcaption>Figure 1 : Mark Down Preview Handler Demo</figcaption>
</figure>
</center>
Preview handlers are called when an item is selected to show a lightweight, rich, read-only preview of the file's contents in the view's reading pane. This is done without launching the file's associated application. Please follow this [documentation](https://docs.microsoft.com/en-us/archive/msdn-magazine/2007/january/windows-vista-and-office-writing-your-own-preview-handlers) to start developing a preview handler, when done, continue with this documentation to learn how to integrate a preview handler into PowerToys.
## Developing
@@ -215,44 +212,4 @@ In the general settings of the Settings UI, you should be able to disable and en
<figcaption>Figure 3 : Settings UI - General Settings Tab</figcaption>
</figure>
</center>
## Contributing
### Coding Guidance
#### Working With Strings
**YOU SHOULD NOT** have hardcoded strings in your C++ code. Instead, use the following guidelines to add strings to your code. Add the ID of your string to the resource file. XXX must be a unique int in the list (mostly the int ID of the last string id plus one):
- `resource.h`:
```cpp
#define IDS_PREVPANE_XYZ_SETTINGS_DISPLAYNAME XXX
```
- `powerpreview.rc` under strings table:
```cpp
IDS_PREVPANE_XYZ_SETTINGS_DISPLAYNAME L"XYZ Preview Handler"
```
- Use the `GET_RESOURCE_STRING(UINT resource_id)` method to consume strings in your code.
```cpp
#include <common.h>
extern "C" IMAGE_DOS_HEADER __ImageBase;
std::wstring GET_RESOURCE_STRING(IDS_PREVPANE_XYZ_SETTINGS_DISPLAYNAME)
```
#### More On Coding Guidance
Please review these brief docs below relating to our coding standards etc.
> 👉 If you find something missing from these docs, feel free to contribute to any of our documentation files anywhere in the repository (or make some new ones\!)
* [Coding Style](../../../doc/devdocs/style.md)
* [Code Organization](../../../doc/devdocs/readme.md)
</center>