cfb-editor/src/views/HelpView.md

154 lines
3.9 KiB
Markdown
Raw Normal View History

2017-10-29 02:52:12 +00:00
## CFB Editor
[(click here to go back to the main screen)](/)
The CFB Editor can edit CFB and ZIP archives in your web browser! No data is
sent to any remote server. All operations are performed locally, so your data
is safe. It is powered by web browser magic.
### Loading data
The editor can read an existing file or generate a new file:
**Reading an Existing File**
From the main screen, click "Choose File" and select a file. Alternatively,
you can click and drag a file from your device into the box.
<details open>
<summary><b>Show Animation</b></summary>
<a href="ReadFile.gif"><img src="ReadFile.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
**Creating a new file**
Click on the relevant links from the main screen.
<details>
<summary><b>Show Animation</b></summary>
<a href="NewFile.gif"><img src="NewFile.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
**Closing a file to start from scratch**
If a file is open, click on the <i class="fa fa-fw fa-close"></i> Close archive
links to close the file and go back to the initial view.
<details>
<summary><b>Show Animation</b></summary>
<a href="CloseFile.gif"><img src="CloseFile.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
### Saving data
The editor can download updated archives or individual files to your device:
**Download an updated archive**
Click on the <i class="fa fa-fw fa-floppy-o"></i> Download Archive links
<details>
<summary><b>Show Animation</b></summary>
<a href="DownloadFile.gif"><img src="DownloadFile.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
**Download a file within the archive**
When a file is loaded, click on the name of the file in the sidebar to show the
file view. Click on the <i class="fa fa-fw fa-download"></i> Export Entry
link to download the viewed file.
<details>
<summary><b>Show Animation</b></summary>
<a href="DownloadEntry.gif"><img src="DownloadEntry.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
### Modifying files in the archive
The editor can add, delete, and rename files:
**Rename the archive**
Click on the <i class="fa fa-fw fa-i-cursor"></i> Rename archive link in the
sidebar or the archive view.
<details>
<summary><b>Show Animation</b></summary>
<a href="RenameFile.gif"><img src="RenameFile.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
**Rename a file within the archive**
When a file is loaded, click on the name of the file in the sidebar to show the
file view. Click on the <i class="fa fa-fw fa-i-cursor"></i> Rename link in
the file view to rename.
<details>
<summary><b>Show Animation</b></summary>
<a href="RenameEntry.gif"><img src="RenameEntry.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
**Delete a file from the archive**
When a file is loaded, click on the name of the file in the sidebar to show the
file view. Click on the <i class="fa fa-fw fa-chain-broken"></i> Rename link
in the file view to rename.
<details>
<summary><b>Show Animation</b></summary>
<a href="DeleteFile.gif"><img src="DeleteFile.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
**Updating data for a file**
When a file is loaded, click on the name of the file in the sidebar to show the
file view. Click on the "Choose file" button to upload a new file that will
replace the existing data.
<details>
<summary><b>Show Animation</b></summary>
<a href="UpdateFile.gif"><img src="UpdateFile.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
**Add a file to the archive**
Click on the <i class="fa fa-fw fa-plus"></i> Add file link in the sidebar or
the archive view. By default, the file will have a generated name and dummy
content. Follow the instructions to rename the file and update the content.
<details>
<summary><b>Show Animation</b></summary>
<a href="DragFile.gif"><img src="DragFile.gif" style="max-width:100%" /></a>
</details>
<br />
<br />
[(C) 2017-present SheetJS LLC](http://sheetjs.com)