ShuriZma
/
bsnes
mirror of https://github.com/bsnes-emu/bsnes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
bsnes/docs/interface/common.md

62 lines
2.0 KiB
Markdown
Raw Normal View History

Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
The Filesystem Browser
----------------------
More cleanups.
2017-08-25 08:40:20 +00:00
Sometimes higan will need you
to choose a file or folder.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
For this, it uses a special Filesystem Browser dialog.
Although many operating systems provide a native filesystem browser,
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
they do not all allow the same customisations.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
Therefore,
higan provides its own filesystem browser
that works the same way on every platform.
The filesystem browser shows the contents of some particular folder,
and allows you to select one of those items.
Across the top of the window,
a text-box displays the path of the current folder.
If you want to browse a specific path,
you may edit the contents of this box
and press Enter to switch to the new location.
More cleanups.
2017-08-25 08:40:20 +00:00
The ![two-blue-arrows](refresh.png) button is "Refresh".
Pressing this button will check
if anything has been added to or removed from the current folder
and update the list to match.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
More cleanups.
2017-08-25 08:40:20 +00:00
The ![house](home.png) button is "Home".
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
Pressing this button will switch to your home folder.
More cleanups.
2017-08-25 08:40:20 +00:00
The ![up-arrow](up.png) button is "Parent".
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
Pressing this button will
switch to the parent of the current folder.
Most of the filesystem browser lists the contents
Consistently use "folder" over "directory", except for Linux documentation. For Windows documentation, "folder" is the correct term. For generic documentation, probably either would do but I suspect people are slightly more likely to be familiar with "folder".
2017-08-23 04:59:16 +00:00
of the current folder.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
Double-clicking a folder,
or selecting it and pressing Enter,
Consistently use "folder" over "directory", except for Linux documentation. For Windows documentation, "folder" is the correct term. For generic documentation, probably either would do but I suspect people are slightly more likely to be familiar with "folder".
2017-08-23 04:59:16 +00:00
will switch to showing the contents of that folder.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
If the list has keyboard focus,
More cleanups.
2017-08-25 08:40:20 +00:00
typing any text will jump to the first item in the list
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
whose name begins with the text you typed.
If a drop-down list appears in the bottom-left,
it allows you to choose which files appear in the list,
based on file-extension.
If this filesystem browser is asking for a file,
you can choose one
by double-clicking it,
by selecting it and pressing Enter,
or by selecting it and clicking the "Select" button in the bottom-right.
Consistently use "folder" over "directory", except for Linux documentation. For Windows documentation, "folder" is the correct term. For generic documentation, probably either would do but I suspect people are slightly more likely to be familiar with "folder".
2017-08-23 04:59:16 +00:00
If this filesystem browser is asking for a folder,
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
you can choose one
by selecting it and clicking the "Select" button in the bottom-right.
Double-clicking
or selecting and pressing Enter don't work,
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
they just switch to viewing the contents of that folder.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
The "Cancel" button in the bottom-right
closes the filesystem browser without selecting anything.