Documentation fixes

bengarrett · Nov 10, 2016 · 76b816c · 76b816c
1 parent b600bab
commit 76b816c
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Turn many pieces of ANSI text art and ASCII/NFO plain text into HTML5 **text** u
 
 Available for installation from both the [Chrome store](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) and [Mozilla Add-ons](https://addons.mozilla.org/en-US/firefox/addon/retrotxt/).
 
-[**Documentation**](https://bengarrett.github.io/RetroTxt/)
+[**Documentation**](https://github.com/bengarrett/RetroTxt/blob/master/docs/index.md)
 
 ![RetroTxt showcase](/docs/assets/readme_showcase.png)
 
@@ -23,12 +23,10 @@ After install you can run RetroTxt on any text or ANSI art file viewed in the br
 <figure><small>Chrome and Firefox buttons</small></figure>
 ![RetroTxt toolbar button in Chrome](/docs/assets/retrotxt_toolbar_button_chrome.png) ![RetroTxt toolbar button in Firefox](/docs/assets/retrotxt_toolbar_button_firefox.png)
 
-You can test the RetroTxt install using a number of [test text files hosted on the GitHub repository](https://github.com/bengarrett/RetroTxt/tree/master/test/example_files/).
+You can test the RetroTxt install using one of the thousands of text files hosted at [textfiles.com](http://textfiles.com/directory.html) or [Project Gutenberg's](https://www.gutenberg.org/catalog/) _plain text_ books.
 
 Or download one of the amazing text art packs created by [Blocktronics](http://blocktronics.org/artpacks/) and use the <file:///> protocol to browse and view the text art files saved onto your hard drive.
 
-There are also thousands of text files hosted at [textfiles.com](http://textfiles.com/directory.html) or [Project Gutenberg's](https://www.gutenberg.org/catalog/) _plain text_ books that you can use RetroTxt with.
-
 ### Permissions
 
 Chrome requires **Allow access to file URLs** selected if you wish to use RetroTxt with text files stored on your local computer.

diff --git a/docs/index.md b/docs/index.md
@@ -1 +1 @@
-# RetroTxt## AboutDespite the web being built on text, the modern web is incapable of accurately displaying texts written in legacy formats that have been in common use for decades.This is where RetroTxt comes in. It converts legacy text into modern HTML for your web browser including `nfo` `txt` ASCII and ANSI art, either hosted online or stored on your computer. RetroTxt then injects an accurate retro monospace font and applies optional styling to improve the display and readability.### Available forInstallation on your browser in the [**Chrome store**](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) and [**Mozilla Add-ons**](https://addons.mozilla.org/en-US/firefox/addon/retrotxt/)## Documentation- [Readme with installation instructions](../README.md)- *[Toolbar button and context menus](menus.md)*- [Options](options.md)- [Common questions and trouble fixes](qa.md)- [Technical specifications on supported text](technical.md)- [Similar tools and projects](other_projects.md)- [Source code and how to use it](source_code.md)- [Version changes](changes.md)- [License](../LICENSE.md)
+# RetroTxt## AboutDespite the web being built on text, the modern web is incapable of accurately displaying texts written in legacy formats that have been in common use for decades.This is where RetroTxt comes in. It converts legacy text into modern HTML for your web browser including `nfo` `txt` ASCII and ANSI art, either hosted online or stored on your computer. RetroTxt then injects an accurate retro monospace font and applies optional styling to improve the display and readability.### Available forInstallation on your browser in the [**Chrome store**](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) and [**Mozilla Add-ons**](https://addons.mozilla.org/en-US/firefox/addon/retrotxt/)## Documentation- [Readme with installation instructions](../README.md)- [Toolbar button and context menus](menus.md)- [Options](options.md)- [Common questions and trouble fixes](qa.md)- [Technical specifications on supported text](technical.md)- [Similar tools and projects](other_projects.md)- [Source code and how to use it](source_code.md)- [Version changes](changes.md)- [License](https://choosealicense.com/licenses/lgpl-3.0/)

diff --git a/docs/menus.md b/docs/menus.md
@@ -3,13 +3,15 @@
 
 The context menu can be found by right-clicking on the active tab (web page) content, and also in Chrome by right-clicking the RetroTxt toolbar button.
 
-<small><figure>Active tab context menu</figure></small>
 ![Font options selection](assets/menu_base.png)
 ![Font options selection](assets/menu.png)
 
-<small><figure>Chrome toolbar context menu</figure></small>
+<small><figure>Active tab context menu</figure></small>
+
 ![Font options selection](assets/retrotxt_toolbar_menu.png)
 
+<small><figure>Chrome toolbar context menu</figure></small>
+
 ### Options
 Launches the RetroTxt [Options dialogue](options.md).
 
@@ -39,11 +41,14 @@ Character encoding is complicated and the execution not always precise. If you e
 
 ![Font options selection](assets/menu_transcode_text.png)
 
-<small><figure>A text document with the correct character encoding</figure></small>
 ![Font options selection](assets/text_transcode_ok.png)
-<small><figure>The same document with the incorrect transcoding</figure></small>
+
+<small><figure>A text document with the correct character encoding</figure></small>
+
 ![Font options selection](assets/text_transcode_x.png)
 
+<small><figure>The same document with the incorrect transcoding</figure></small>
+
 ##### Guess (default)
 
 The default behaviour, this lets RetroTxt try to determine the base character encoding of the text and when needed, apply any transcoding.

diff --git a/docs/source_code.md b/docs/source_code.md
@@ -2,7 +2,7 @@
 
 ## Source code
 
-RetroTxt is released under an [open sourced license](https://github.com/bengarrett/RetroTxt/blob/master/LICENSE.md) with the complete code available on [GitHub](https://github.com/bengarrett/RetroTxt). This page instructs on how to use the source code in both Chrome and Firefox web browsers.
+RetroTxt is released under an [open sourced license](https://choosealicense.com/licenses/lgpl-3.0/) with the complete code available on [GitHub](https://github.com/bengarrett/RetroTxt). This page instructs on how to use the source code in both Chrome and Firefox web browsers.
 
 ### Download
 

diff --git a/docs/technical.md b/docs/technical.md
@@ -13,7 +13,7 @@ Regardless of the source, JavaScript converts all the text it handles into UTF-1
 UTF-16 is based on Unicode and is compatible with UTF-8, and backwards compatible with ISO-8859-1 and US-ASCII. But otherwise, all other loaded text needs to be transcoded to accurately display all characters.
 
 | Character set | Support | About |
-| ------------ | ------- | - |
+| ------------- | ------- | ----- |
 | [US-ASCII](https://en.wikipedia.org/wiki/ISO/IEC_646) | Native | The original text encoding of the Internet, also known as ANSI X3.4 or ISO 646 |
 | [CP-437](https://en.wikipedia.org/wiki/Code_page_437) | Yes | The most common encoding for ASCII, ANSI art and MS-DOS text |
 | [CP-865](https://en.wikipedia.org/wiki/Code_page_865) | Yes | An alternative MS-DOS encoding occasionally found in ASCII and ANSI art |
@@ -28,7 +28,7 @@ UTF-16 is based on Unicode and is compatible with UTF-8, and backwards compatibl
 BBS colour codes were most frequently used in the early 1990s as an easy means of applying colour to text served by bulletin board system user interfaces.
 
 | Format | Support | Notes |
-| ------------ | ------- | - |
+| ------ | ------- | ----- |
 | Celerity pipe codes | No | |
 | [PCBoard @-codes](https://defacto2.net/file/detail/af240c4) | Yes | |
 | Renegade pipe codes | No | |
@@ -43,7 +43,7 @@ BBS colour codes were most frequently used in the early 1990s as an easy means o
 Control sequences are strings of characters that are embedded into the text to be used as cursor, display and presentation functions. ANSI art uses control sequences for both its colourisation and cursor positioning. As do remote terminals used by many Linux and Unix systems such as [_xterm_](http://invisible-island.net/xterm/).
 
 | Standard | Support | Notes |
-| - | ------- | - |
+| -------- | ------- | ----- |
 | [ANSI.SYS](https://msdn.microsoft.com/en-us/library/cc722862.aspx) | Partial | MS-DOS command prompt driver commonly used with ANSI art |
 | [ECMA-6](http://www.ecma-international.org/publications/standards/Ecma-006.htm) | Partial | Also known as US-ASCII or ANSI X3.4 C0 controls |
 | [ECMA-48](http://www.ecma-international.org/publications/standards/Ecma-048.htm) | Partial | Also known as _ANSI escape codes_, ANSI X3.64, VT-100, ISO 6429 |
@@ -77,7 +77,7 @@ RetroTxt recognises all ANSI.SYS control sequences but skips those that it doesn
 The following chart lists the limited ECMA-48 sequences that RetroTxt supports.
 
 | Control | Acronym | Value | Support | Notes |
-| - | - | - | - | - |
+| ------- | ------- | ----- | ------- | ----- |
 | Cursor Down | CUD | | Yes | |
 | Cursor Forward | CUF | | Yes | |
 | Cursor Position | CUP | | Partial | Supports forward and down only |
@@ -129,7 +129,7 @@ The following chart lists the limited ECMA-48 sequences that RetroTxt supports.
 Other common non-standard sequences agreed to by the ANSI art community
 
 | Control | Acronym | Value | Support | Notes |
-| - | - | - | - | - |
+| ------- | ------- | ----- | ------- | ----- |
 | background RGB colours | - | 0;R;G;Bt | No | [PabloDraw 2014 24-bit ANSI implementation](http://picoe.ca/2014/03/07/24-bit-ansi/) |
 | foreground RGB colours | - | 1;R;G;Bt | No | [PabloDraw 2014 24-bit ANSI implementation](http://picoe.ca/2014/03/07/24-bit-ansi/) |
 | Blink to Bright Intensity Background | - | ?33h | No | [ SyncTERM ](http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/src/conio/cterm.txt?content-type=text%2Fplain&revision=HEAD) |