Permalink
Browse files

More markdownlint friendly

  • Loading branch information...
Ben Garrett
Ben Garrett committed Feb 28, 2017
1 parent 87679a8 commit 4acfcfc1d36afa0baa53753fa3b9aa292c910a47
Showing with 92 additions and 64 deletions.
  1. +6 −2 README.md
  2. +5 −4 docs/changes.md
  3. +7 −5 docs/menus.md
  4. +3 −3 docs/options.md
  5. +22 −14 docs/other_projects.md
  6. +20 −16 docs/qa.md
  7. +18 −16 docs/source_code.md
  8. +11 −4 docs/technical.md
View
@@ -1,5 +1,7 @@
# RetroTxt
![Code Climate](https://codeclimate.com/github/bengarrett/RetroTxt/badges/gpa.svg)
Turn many pieces of ANSI text art and ASCII/NFO plain text into HTML5 **text** using RetroTxt. It is the new, browser agnostic, web extension that takes retro text files and stylises them into a more pleasing, useful format to view and copy in a web browser.
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/).
@@ -8,11 +10,12 @@ Available for installation from both the [Chrome store](https://chrome.google.co
## Documentation
#### [Read](https://github.com/bengarrett/RetroTxt/blob/master/docs/index.md)
### [Read](https://github.com/bengarrett/RetroTxt/blob/master/docs/index.md)
## Install
### [Chrome](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) · [Firefox](https://addons.mozilla.org/en-US/firefox/addon/retrotxt/)
Recommendation? Overall, Firefox 51+ performs better than Chrome
#### [Or use the source code](https://github.com/bengarrett/RetroTxt/blob/master/docs/source_code.md)
@@ -25,7 +28,8 @@ Recommendation? Overall, Firefox 51+ performs better than Chrome
After install you can run RetroTxt on any text or ANSI art file viewed in the browser by clicking the toolbar button.
<figure><small>Chrome and Firefox buttons</small></figure>
Chrome and Firefox buttons
![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 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.
View
@@ -28,7 +28,7 @@
- Detects and converts many [ANSI Control Sequence Introduces](https://en.wikipedia.org/wiki/ANSI.SYS) used by MS-DOS's ANSI.SYS to display ANSI art.
- Detects and converts legacy BBS colour codes for [PCBoard and Wildcat!](http://wiki.synchro.net/custom:colors#pcboard_wildcat_format).
- **_Apply RetroTxt to any text files hosted on these websites_** will only run on a user supplied whitelist of website domains. This will stop it from conflicting with secure login sessions used by some websites.
- Options have been reworked with a refresh to its look including the use of Google's [Material Icons](https://design.google.com/icons/).
- Options have been reworked with a refresh to its look including the use of the [Google Material Icons](https://design.google.com/icons/).
- Introduced a new, charcoal coloured icon that should clash less with most browser themes.
- Context menu now allows you to control the page transcoding, currently CP-487, CP-865, ISO-8959-15, CP-1252 character sets are supported.
- The about encoding content menu has been removed and replaced by the Transcode None option, that works with UTF-8, UTF-16 and ISO-8959-1 text.
@@ -43,9 +43,10 @@
- Context menus code in `eventpages.js` has been redesigned so it is now easier to add new themes and Display options.
- The toolbar button should now be more intuitive by more accurately changing its enabled state and refreshing its tip where appropriate.
###### Firefox specific fixes
#### Firefox specific fixes
- Requires Firefox 50+.
- Options dialogue is better themed to Firefox's style guides. <small>(Unfortunately Firefox on Linux still has some strange <code>input</code> style quirks)</small>
- Options dialogue is better themed to Firefox's style guides. (Unfortunately Firefox on Linux still has some strange `input` style quirks)
- Fixed Options not supporting UK locales.
- Fixed first time run bugs that required RetroTxt to reload for it to work correctly.
- Fixed RetroTxt trying to run on about: URIs.
@@ -71,7 +72,7 @@
- **Now works in Firefox** but requires at least Firefox (Gecko) 48.
- Tested in Opera (Blink) and works great.
#### Differences between using Firefox and Chrome?
#### Differences between using Firefox and Chrome
- Chrome uses event pages while Firefox uses the less desirable persistent background pages. Event pages only load when needed so in theory they should be less resource intensive.
- Firefox and the Gecko engine renders multiple block characters better than the Blink engine used in Chrome. The Blink engine adds light but distracting vertical lines.
View
@@ -1,18 +1,20 @@
# RetroTxt
## Toolbar button and context menus
## Toolbar button and context menus
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.
![Font options selection](assets/menu_base.png)
![Font options selection](assets/menu.png)
<small><figure>Active tab context menu</figure></small>
Active tab context menu
![Font options selection](assets/retrotxt_toolbar_menu.png)
<small><figure>Chrome toolbar context menu</figure></small>
Chrome toolbar context menu
### Options
Launch the RetroTxt [Options dialogue](options.md).
#### Display
@@ -43,11 +45,11 @@ Character encoding is complicated and the execution not always precise. If you e
![Font options selection](assets/text_transcode_ok.png)
<small><figure>A text document with the correct character encoding</figure></small>
A text document with the correct character encoding
![Font options selection](assets/text_transcode_x.png)
<small><figure>The same document with the incorrect transcoding</figure></small>
The same document with the incorrect transcoding
##### Guess (default)
View
@@ -24,7 +24,7 @@ The Colour pair menu allows you to apply a colour to text and background theme t
The choices ordered into three categories. Systems are recreations of ancient computer operating systems. Dark and Light correspond to colours used on either a black (Dark) or white (Light) background.
<small>The RGB values of these colour pairs are in the source code `\css\text-colors.css`</small>
The RGB values of these colour pairs are in the source code `\css\text-colors.css`
- **MS-DOS** uses VGA grey text on black.
- **Windows** is themed on its `notepad.exe` program and uses black text on white.
@@ -33,7 +33,7 @@ The choices ordered into three categories. Systems are recreations of ancient co
- **Atari ST** based on the Atari TOS with black text on white.
- **C-64** based on the Commodore 64 boot screen with a light on a dark blue colour pair.
<div style="text-align:center">![Font options selection](assets/theme_ms-dos.png) ![Font options selection](assets/theme_windows.png) ![Font options selection](assets/theme_amiga.png) ![Font options selection](assets/theme_appleii.png) ![Font options selection](assets/theme_c64.png)</div>
![Font options selection](assets/theme_ms-dos.png) ![Font options selection](assets/theme_windows.png) ![Font options selection](assets/theme_amiga.png) ![Font options selection](assets/theme_appleii.png) ![Font options selection](assets/theme_c64.png)
### Line height
@@ -119,7 +119,7 @@ Apply a subtle scan line effect to the backdrop of the page. The effect is more
![Execution behaviour checks](assets/options_execution_behavior.png)
##### Apply RetroTxt to any text files hosted on these websites
#### Apply RetroTxt to any text files hosted on these websites
When check the web extension runs in the background and applies RetroTxt to all text files served by websites listed in the textbox. You can add additional sites to this list by including their domain name appended by a semicolon, for example
View
@@ -1,30 +1,38 @@
# RetroTxt
## Similar projects
Many great programs that offer similar functionality inspire RetroTxt.
##### ansilove
### ansilove
Is a collection of tools for various platforms to convert an extensive variety of text art into PNG images.
- [ansilove.js](http://ansilove.github.io/ansilove.js/) for JavaScript
- [ansilove](http://www.ansilove.org/) for PHP
- [AnsiLove/C](https://github.com/ansilove/ansilove) for Linux
##### ansi_up
* [ansilove.js](http://ansilove.github.io/ansilove.js/) for JavaScript
* [ansilove](http://www.ansilove.org/) for PHP
* [AnsiLove/C](https://github.com/ansilove/ansilove) for Linux
### ansi_up
Converts ANSI SGR (Select Graphic Rendition) codes into HTML.
- [ansi_up](https://github.com/drudru/ansi_up) for JavaScript
[ansi_up](https://github.com/drudru/ansi_up) for JavaScript
### escapes.js
##### escapes.js
Converts ANSI into PNG images.
- [escapes.js](https://github.com/atdt/escapes.js) for JavaScript
[escapes.js](https://github.com/atdt/escapes.js) for JavaScript
### PabloDraw
##### PabloDraw
_PabloDraw is an Ansi/Ascii text and RIPscrip vector graphic art editor/viewer with multi-user capabilities._
- [PabloDraw](http://picoe.ca/products/pablodraw/) for Windows, macOS and Linux
[PabloDraw](http://picoe.ca/products/pablodraw/) for Windows, macOS and Linux
### ACiDView
##### ACiDView
The granddaddy of ANSI art viewers that has a pedigree that goes back decades.
- [ACiDView 6](https://defacto2.net/file/detail/a83d5d) for Windows
[ACiDView 6](https://defacto2.net/file/detail/a83d5d) for Windows
### iNFekt
##### iNFekt
A modern ASCII, NFO and ANSI art viewer and terminal converter for Windows.
- [iNFekt](https://infekt.ws/) for Windows
[iNFekt](https://infekt.ws/) for Windows
View
@@ -1,5 +1,6 @@
# RetroTxt
## Q.A.
## QA
To ask a question, report a bug or request a feature please feel free to [leave a new issue](https://github.com/bengarrett/RetroTxt/issues) on the GitHub repository or get in contact with [@bens_zone](https://twitter.com/bens_zone) on Twitter.
@@ -8,29 +9,29 @@ To ask a question, report a bug or request a feature please feel free to [leave
* Some foreground/background colour combinations introduce vertical artefacts when rendering blocks ███. Only [Firefox on Windows](https://www.mozilla.org/en-US/firefox/desktop/) doesn't suffer from this problem.
* Browsers are fussy over which files they allow web extensions to autorun on, more so when displaying local texts with the `file:///` protocol.
#### Can I adjust the size of the font?
#### Can I adjust the size of the font
You can change the _zoom_ of the font by using the <kbd>Ctrl</kbd> <kbd>+</kbd> and <kbd>Ctrl</kbd> <kbd>-</kbd> keys.
#### Can I view files stored on my computer?
#### Can I view files stored on my computer
By typing a path into the address bar, many browsers are quite happy to read files and directories stored locally on your computer.
On Windows, for example, pasting `C:\Users\Ben\Downloads\myfile.txt` into Chrome and Firefox will convert it to into a browser-friendly file URI and view the document in the browser.
```
file:///C:/Users/Ben/Downloads/myfile.txt
```
`file:///C:/Users/Ben/Downloads/myfile.txt`
You can also [browse your Windows drive](file:///C:/) or [your Linux and macOS drives](file:///).
Chrome will need to [__Allow access to the file URLs__ permission](chrome://extensions/) enabled if you want the to work with local files automatically.
In Windows to make a web browser your default text file viewer.
1. Right-click on the desktop and choose __text file__ under __New__ to create the file `New Text Document.txt`
2. Right-click on the file, select __Choose another app__ (_Choose default program..._ in Windows 7) under __Open with__ item
3. Then under __Other options__ scroll down and select your browser
1. Right-click on the file, select __Choose another app__ (_Choose default program..._ in Windows 7) under __Open with__ item
1. Then under __Other options__ scroll down and select your browser
#### Are the fonts and styling historically accurate?
#### Are the fonts and styling historically accurate
* The extension uses TrueType fonts which are affected by the operating system font smoothing effects; ClearType on Windows, Quartz in macOS and FreeType on Linux.
@@ -40,10 +41,12 @@ In Windows to make a web browser your default text file viewer.
* The VGA LCD font is a bit small and had been up-sized by 1.5x. You can return these fonts to their original size by pressing <kbd>Ctrl</kbd> <kbd>-</kbd> in Chrome and reducing the font size to _67%_.
#### What text encodings are supported?
#### What text encodings are supported
Please see [Technical Specifications on supported text](technical.md)
#### Text is garbled
There could be many causes of this, but generally, it is related to the web server or browser choosing the incorrect character encoding for the file.
You can manually switch this [except in Chrome 55 or newer](https://productforums.google.com/forum/#!topic/chrome/1sC3JN0qDkg).
@@ -59,9 +62,10 @@ You could also try to manually switch the transcoding RetroTxt applies by right-
![Context menu transcode text](assets/context_menu_transcode_text.png)
#### Code page tables
- [ASCII codes](http://www.ascii-codes.com/)
- [ASCII-1967/US-ASCII](http://0x6a.org/ASCII)
- [CP-437](https://msdn.microsoft.com/en-us/goglobal/cc305156)
- [ISO 8859-1](https://msdn.microsoft.com/en-us/goglobal/cc305167)
- [Windows 1252](https://msdn.microsoft.com/en-us/goglobal/cc305145)
- [Unicode](http://unicode-table.com/)
* [ASCII codes](http://www.ascii-codes.com/)
* [ASCII-1967/US-ASCII](http://0x6a.org/ASCII)
* [CP-437](https://msdn.microsoft.com/en-us/goglobal/cc305156)
* [ISO 8859-1](https://msdn.microsoft.com/en-us/goglobal/cc305167)
* [Windows 1252](https://msdn.microsoft.com/en-us/goglobal/cc305145)
* [Unicode](http://unicode-table.com/)
View
@@ -2,6 +2,8 @@
## Source code
![Code Climate](https://codeclimate.com/github/bengarrett/RetroTxt/badges/gpa.svg)
RetroTxt employs 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 in both Chrome and Firefox web browsers.
### Download
@@ -19,46 +21,46 @@ Or run the following command in a terminal.
I suggest that you create a new user profile in Chrome and use that to load and edit this web extension.
1. Open a new tab and type in the address `chrome://extensions/`
2. In the Extensions, tab check to enable __Developer Mode__
3. Click the __Load unpacked extension...__ button
4. Navigate to the local directory containing the RetroTxt source code and select OK
1. In the Extensions, tab check to enable __Developer Mode__
1. Click the __Load unpacked extension...__ button
1. Navigate to the local directory containing the RetroTxt source code and select OK
![Font options selection](assets/sourcecode_chrome_loaded.png)
RetroTxt should load. The [Options link](options.md) allows you to configure RetroTxt styling and behaviour. You can test RetroTxt and its Options while browsing a site like [Jason Scott's Top 100 Textfiles](http://textfiles.com/100/).
### Use on Firefox
Firefox is locked down and doesn't permit the loading of extensions outside of the Mozilla Add-ons page.
Firefox is locked down and doesn't permit the loading of extensions outside of the Mozilla Add-ons page.
Instead, there are two options to use the source code. Either use Mozilla's terminal tool `web-ext` or use [Firefox Developer Edition](https://www.mozilla.org/en-US/firefox/developer/).
The web-ext tool is the preferred method and [has a dedicated web page](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext) but requires node.js. It allows you to lint, run with options or build RetroTxt in Firefox.
1. [Install node.js if needed](https://nodejs.org)
2. `npm install --global web-ext` to install web-ext
3. `cd RetroTxt` into the cloned directory
4. `web-ext run` to run RetroTxt in Firefox
5. [Read more about web-ext](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext)
1. `npm install --global web-ext` to install web-ext
1. `cd RetroTxt` into the cloned directory
1. `web-ext run` to run RetroTxt in Firefox
1. [Read more about web-ext](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext)
![web-ext run example](assets/web-ext_example.png)
Otherwise if you prefer using Firefox Developer Edition.
1. Open a new tab and type in the address `about:debugging`
2. Select __Add-ons__
3. Check the __Enable add-on debugging__ checkbox
4. Click the __Load Temporary Add-on__ button and navigate to the local directory containing the RetroTxt source code
5. Open the `manifest.json` file to finish
1. Select __Add-ons__
1. Check the __Enable add-on debugging__ checkbox
1. Click the __Load Temporary Add-on__ button and navigate to the local directory containing the RetroTxt source code
1. Open the `manifest.json` file to finish
![Font options selection](assets/sourcecode_firefox.png)
Now in the same tab.
1. Type in the address `about:addons`
2. Select __Extensions__
3. RetroTxt should be listed there with some including __Options__
4. The [Options button](options.md) allows you to configure RetroTxt styling and behaviour
5. Test RetroTxt and its Options while browsing a site like [Jason Scott's Top 100 Textfiles](http://textfiles.com/100/)
1. Select __Extensions__
1. RetroTxt should be listed there with some including __Options__
1. The [Options button](options.md) allows you to configure RetroTxt styling and behaviour
1. Test RetroTxt and its Options while browsing a site like [Jason Scott's Top 100 Textfiles](http://textfiles.com/100/)
![Font options selection](assets/sourcecode_firefox_addons.png)
Oops, something went wrong.

0 comments on commit 4acfcfc

Please sign in to comment.