Permalink
Browse files

Document fixes

New screenshots, added https links and grammar fixes.
  • Loading branch information...
Ben Garrett
Ben Garrett committed Nov 26, 2017
1 parent 0f97526 commit fbd0f15435b0243cf7f6913d932392fd49debabf
View
@@ -8,13 +8,13 @@ Available for installation from both the [Chrome store](https://chrome.google.co
- View ANSI, ASCII, NFO, PCBoard, Wildcat text art as HTML
- RGB 16.7 million, xterm 256 and IBM VGA 16 colour support
- Swappable ANSI palettes, xterm, VGA, cyan/magenta CGA, monochrome and toggable iCE Colors
- Swappable ANSI palettes, xterm, VGA, cyan/magenta CGA, monochrome and switchable iCE Colors
- Swappable ASCII & NFO colour themes, DOS, Windows, Amiga, C-64, Apple II, Atari ST
- SAUCE metadata parsing
- Multiple text encodings support including CP437, ISO-8959-1, Windows-1252
- Text rendering toggles, smeared, shadow and normal
- Multiple IBM PC font support such as VGA, EGA, CGA, MDA plus variants and more
- Multiple Amiga fonts plus Commodore PETSCII, Atari ATASCII, ST and Apple II
- Multiple IBM PC font support such as VGA, PS/2, EGA, CGA, MDA plus variants and more
- Various Amiga fonts plus Commodore PETSCII, Atari ATASCII, ST and Apple II
![RetroTxt showcase](/docs/assets/zii-rtxt-ad.png)
@@ -30,19 +30,21 @@ Available for installation from both the [Chrome store](https://chrome.google.co
### Requirements
**Chrome 55** or **Firefox 55**, newer or compatible browsers.
**Chrome 55** or **Firefox 55** or newer browsers.
## Run RetroTxt
After install you can run RetroTxt on any text or ANSI art file viewed in the browser by clicking the toolbar button.
Chrome and Firefox buttons
Selected toolbar button
![RetroTxt toolbar button in Chrome](/docs/assets/retrotxt_toolbar_button_chrome.png) ![RetroTxt toolbar button in Firefox](/docs/assets/retrotxt_toolbar_button_firefox.png)
![RetroTxt toolbar button in Chrome](/docs/assets/retrotxt_toolbar_button_chrome.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.
You can test the RetroTxt install by clicking on one of the 10 Sample artworks found on the `welcome.html` tab that launches after installation.
Or download one of the amazing text art packs created by [Blocktronics](http://blocktronics.org/artpacks/) or found at [textmod.es](http://pc.textmod.es/) and use the `file:///` protocol to browse and view the text art files saved onto your hard drive.
![RetroTxt samples](/docs/assets/rtxt-samples.png)
Elsewhere there are thousands of text files hosted at [textfiles.com](https://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/) or found at [textmod.es](https://pc.textmod.es/) and use the `file:///` protocol to browse and view the text art files saved onto your hard drive.
### Permissions
@@ -54,19 +56,19 @@ Chrome requires **Allow access to file URLs** selected if you wish to use RetroT
#### An important note about the license
While RetroTxt uses a [GNU Lesser General Public License v3.0](http://choosealicense.com/licenses/lgpl-3.0/), the included fonts **are not**. You should read each font license that is in the `fonts/` subdirectory before redistribution, as some of the added collections do not permit the sale or modification of their fonts and packages.
While RetroTxt uses a [GNU Lesser General Public License v3.0](https://choosealicense.com/licenses/lgpl-3.0/), the included fonts **are not**. You should read each font license that is in the `fonts/` subdirectory before redistribution, as some of the added collections do not permit the sale or modification of their fonts and packages.
## Credits
RetroTxt by [Ben Garrett](http://bens.zone/) who can be reached at [Twitter @bens_zone](https://twitter.com/bens_zone) or [GitHub](https://github.com/bengarrett/)
RetroTxt by [Ben Garrett](https://bens.zone/) on [Twitter @bens_zone](https://twitter.com/bens_zone) and [GitHub](https://github.com/bengarrett/)
RetroTxt ANSI logo Zeus II [Twitter @Zeus_II](https://twitter.com/Zeus_II)
- PC fonts [_The Ultimate Oldschool PC Font Pack_](http://int10h.org/oldschool-pc-fonts/) by Viler
- Commodore Amiga fonts [_Multi Platform Fonts In Amiga Aspect v1.0_](http://www.trueschool.se/) by TrueSchool Ascii
- PC fonts [_The Ultimate Oldschool PC Font Pack_](https://int10h.org/oldschool-pc-fonts/) by Viler
- Commodore Amiga fonts [_Multi Platform Fonts In Amiga Aspect v1.0_](https://www.trueschool.se/) by TrueSchool Ascii
- Apple II font [_Print Char 21_](http://www.kreativekorp.com/software/fonts/apple2.shtml) by Kreative Korp
- Atari ATASCI font [_Atari Classic TrueType Fonts_](http://members.bitstream.net/marksim/atarimac/fonts.html) by Mark L. Simonson
- Atari ST font [_8x16 system font_](http://www.dafont.com/atari-st-8x16-system-font.font) by divVerent
- Atari ST font [_8x16 system font_](https://www.dafont.com/atari-st-8x16-system-font.font) by divVerent
- Commodore 64 font [_C64 Pro Mono TrueType v1.2_](http://style64.org/c64-truetype) from Style
Options icons by [Google Material Design](https://material.google.com/)
View
Binary file not shown.
View
Binary file not shown.
View
Binary file not shown.
View
@@ -10,10 +10,10 @@
- Redesigned some of the context menus.
- Added a ▲ hide ▼ show toggle for the header.
- Added 1x and 2x font size adjust toggle in the header.
- Welcome page displays an RetroTxt updated banner that can also be turned off.
- Welcome page displays a RetroTxt updated banner that can also be turned off.
- Requires Firefox 55.
- Links in the header are not selectedable to stop accidental selection when clicked.
- Replaced columns/lines statistics in header with total pixel width/length.
- Links in the header are not selectable to stop accidental selection when clicked.
- Replaced columns/lines statistics in the header with total pixel width/length.
- Fixed Blink engine handling of ANSI when it mistakenly sees it as ISO-8859-5 instead of Windows-1252.
- Fixed broken preview images in `welcome.html`.
- Fixed SAUCE font issue where it requests Amiga _Plus_ fonts but uses standard.
@@ -25,20 +25,20 @@
- - Dropped the generation of elements using `dom.innerHTML` = text (except in `text_ecma48.js`).
- - Removed all remaining `var` usage.
- - Replaced many `let` variables with `const` objects.
- - Renamed some variables so they are clearer in their purpose.
- - Renamed some variables, so they are clearer in their purpose.
- - Removed some unused functions and objects.
## 2.3
### August 2017
- Added 24-bit RGB colour support for ANSI/ECMA-48 text. That gives a choice of over 16 million colours to play with.
- New fonts, a complete set for Amiga and ATASCII (Atari 8-bit).
- New fonts, a complete set of Amiga and ATASCII (Atari 8-bit).
- Complete SAUCE FontName support.
- Added 2-bit IBM CGA magenta palette.
- Added Option checkbox, 'ANSI iCE colors'.
- Fixed a number of CP437 characters not displaying as intended.
- Fixed issue where 'DOS control glyphs' changes required 2 tab refreshes to apply.
- Fixed some CP437 characters not displaying as intended.
- Fixed issue where 'DOS control glyphs' changes required two tab refreshes to apply.
- Any discovered SAUCE configurations are sent to the browser console.
- Browser tab titles running RetroTxt are marked with `[··]`.
@@ -64,7 +64,7 @@
### March 2017
- Performance optimizations to reduce the memory footprint and improve rendering speed.
- Performance optimisations to reduce the memory footprint and improve rendering speed.
- ECMA48/ANSI iCE colors support.
- Automatic parsing and execution of [SAUCE ANSiFlags](http://www.acid.org/info/sauce/sauce.htm#ANSiFlags).
- Added Atari ST TOS font and theme.
View
@@ -2,7 +2,7 @@
## About
Despite the web built on text, the modern web is incapable of accurately displaying text written in legacy formats that have been in common use for decades.
Despite the web built on text, the modern web is incapable of accurately displaying text written in legacy formats that have been in everyday use for decades.
Here 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.
View
@@ -31,11 +31,11 @@ Positions the text document from the left-top margin to the centre the of the di
##### Scan lines
Apply a subtle scan line effect to the background of the page. The effect is more pronounced on light backgrounds but is not applied to the text.
Apply a subtle scan line effect to the background of the page. The result is more pronounced on light backgrounds and is not applied to the text.
#### Transcode text
Character encoding is complicated and the execution not always precise. If you encounter text that is not displaying as expected, you can transcode the text to display a different set of characters. Transcode text selections only apply to the active browser tab.
Character encoding is complicated and the execution not always precise. If you encounter text that is not displaying as expected, you can transcode the text to show a different set of characters. Transcode text selections only apply to the active browser tab.
![Font options selection](assets/menu_transcode_text.png)
@@ -57,7 +57,7 @@ Force the active tab to parse the source text using [**CP-1252**](https://en.wik
##### ↻ CP-1252
Force the active tab to display the text using **CP-1252**, the common legacy Microsoft Windows encoding instead of the default MS-DOS [*CP-437*](https://en.wikipedia.org/wiki/Code_page_437).
Force the active tab to display the text using **CP-1252**, a familiar legacy Microsoft Windows encoding instead of the default MS-DOS [*CP-437*](https://en.wikipedia.org/wiki/Code_page_437).
##### ↺ ISO 8859-5
View
@@ -29,7 +29,7 @@ location /ansi {
}
```
Broken down the `location` block applies the configuration only to files using the path http://example.com/ansi/. While the `types` block filters that further to only use the configuration with files using an `asc` `ans` or `txt` file extension.
Broken down the `location` block applies the configuration only to files using the path http://example.com/ansi/. While the `types` block filters that further to just use the setting with files utilising an `asc` `ans` or `txt` file extension.
`charset "ISO-8859-1"` directive combined with the `types { text/plain }` block will add a **`Content-Type:text/plain; charset=ISO-8859-1`** response header. It tells the browser to treat the file as plain text encoded as [ISO-8859-1](https://en.wikipedia.org/wiki/ISO/IEC_8859-1), which is a legacy character set RetroTxt can understand. You cannot use [CP-437](https://en.wikipedia.org/wiki/Code_page_437) or other DOS code pages as they are not [valid browser encodings](https://encoding.spec.whatwg.org/#legacy-single-byte-encodings).
View
@@ -2,23 +2,26 @@
## Options
The Options dialogue lets you select a wide variety of font, colour and size combinations.
That RetroTxt will use when theming text in the browser, as well as a number behaviour configurations to automate the execution of RetroTxt when it encounters text files.
The Options dialogue lets you select a wide variety of font, colour and size combinations that RetroTxt will use when theming text in the browser. As well as a number behaviour configurations, to automate the execution of RetroTxt when it encounters text files.
In Chrome, you can launch the Options dialogue by right-clicking the RetroTxt toolbar button and selecting __Options__.
In Chrome, you launch the Options dialogue by right-clicking the RetroTxt toolbar button and selecting __Options__.
![Line height selection](assets/retrotxt_toolbar_button_chrome.png)
In Firefox the Options dialogue can be accessed from the Extensions tab.
With Firefox the Options dialogue is accessed from the Extensions tab.
To do this, in a new tab enter the address `about:addons` and select **Extensions**.
Then click the Options button under the RetroTxt listing.
### Fonts
![Font options selection](assets/options_fonts.png)
RetroTxt has 25 different monospaced font choices to apply to text. Some fonts have wide and tall variants.
Those listed in the left pane are IBM PC, PS/2 and MS-DOS clone system fonts while the ones on the right belong to other home computer systems.
RetroTxt has 25 different monospaced font choices to apply to text. Some fonts have `⇆` wide and `⇅` tall variants.
Those listed in the left pane are IBM PC, IBM PS/2 and Microsoft DOS system fonts while the ones on the right belong to other home computer systems.
The _Browser_ __Monospace__ _fixed-width_ selection uses a monospace font configured by the browser. This font selection is selectable within the browser under the _font_ settings.
![Chrome browser fixed-width font selection](assets/chrome_fixed-width_font.png)
### Display
@@ -28,16 +31,16 @@ Those listed in the left pane are IBM PC, PS/2 and MS-DOS clone system fonts whi
![Colour pair](assets/options_colour_pair.png)
The Colour pair menu allows you to apply a colour to text and background theme to all text handled by RetroTxt.
These pairs are also base colours for colourize ANSI text.
The Colour pair menu allows you to apply colour to text and a background theme to all characters handled by RetroTxt.
These pairs are also base colours for colourising ANSI text.
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.
The ordered choices are in 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.
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.
- **Windows** is themed on the `notepad.exe` program and uses black text on white.
- **Apple II** based on the Apple home computer.
- **Amiga** based on the Commodore Amiga Workbench with white text on grey.
- **Atari ST** based on the Atari TOS with black text on white.
@@ -49,7 +52,7 @@ The RGB values of these colour pairs are in the source code `\css\text-colors.cs
![Line height selection](assets/options_line_height.png)
Line height lets you add padding between each line of text. The amount of padding used is dependent on the size of the font.
Line height lets you add padding to each line of text. The amount of padding used is dependent on the size of the font.
A **25%** line height would introduce padding 1/4 of the height of the font.
A **1x** (100%) value would pad the same height as the font in use.
@@ -100,7 +103,7 @@ Is the font name used.
`ANSI`
Any special controls or functions embedded into the text. ANSI art, for example, uses ANSI control sequences while ASCII art doesn't use any special controls.
Unique controls or functions embedded into the text. ANSI art, for example, uses ANSI control sequences while ASCII art doesn't use any extra controls.
- **ANSI** ECMA-48/ANSI X3.64 presentation control and cursor functions
- **PCBoard** PCBoard BBS text colourisation
@@ -110,7 +113,7 @@ Any special controls or functions embedded into the text. ANSI art, for example,
Highlights any errors or warnings encountered when parsing ANSI encoded text.
[SAUCE metadata](http://www.acid.org/info/sauce/sauce.htm) may also be inserted into the header.
[SAUCE metadata](http://www.acid.org/info/sauce/sauce.htm) may also be in the header.
_Standard Architecture for Universal Comment Extensions_ is often found in ANSI art but can be attached to any document and allows the author to include titles, dates, comments and affiliations.
### Centre align text
@@ -119,7 +122,7 @@ Positions the text document from the left-top margin to the centre the of the di
### DOS control glyphs
The PC/MS-DOS _Code Page 437_ is not completely standards compliant as it uses C0 characters normally reserved for common formatting controls to display character glyphs.
The PC/MS-DOS _Code Page 437_ is not entirely standards compliant as it uses C0 characters usually reserved for common formatting controls to display character glyphs.
As such these characters are never displayed but enabling this option will reveal these glyphs in the text document.
◘ <small>_= backspace_</small>
@@ -130,19 +133,19 @@ As such these characters are never displayed but enabling this option will revea
### Background scanlines
Apply a subtle scan line effect to the backdrop of the page. The effect is more pronounced on light backgrounds but is not applied to the text.
Apply a subtle scan line effect to the backdrop of the page. The result is more pronounced on light backgrounds and ignores the text.
### Text render
#### Normal
Does nothing but the host operating system or browser will most likely apply some font smoothing to the text characters.
Lets the host operating system or browser handle the font smoothing.
![Normal text render](assets/text_render_normal.png)
##### Smeared
Most browsers (other than FireFox on Windows) display vertical line artefacts when showing block characters. This option implements a `text-shadow` property in an attempt to correct this. It unfortunately also blurs alphanumeric characters that make them less readable.
Due to font smoothing, many browsers display vertical line artefacts when showing block characters together. This option implements a `text-shadow` property in an attempt to correct this but it also blurs alphanumeric characters to make them less readable.
![Smeared text render](assets/text_render_smeared.png)
@@ -158,8 +161,8 @@ Apply a subtle shadow effect to each character.
### 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
If 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.
- [Defacto2](https://defacto2.net) `defacto2.net;`
- [Gutenberg.org](https://www.gutenberg.org) `gutenberg.org;`
View
@@ -2,11 +2,11 @@
## Similar projects
Many great programs that offer similar functionality inspire RetroTxt.
Many excellent programs that offer similar functionality inspire RetroTxt.
### ansilove
Is a collection of tools for various platforms to convert an extensive variety of text art into PNG images.
Is a collection of tools on various platforms, to convert an extensive variety of text art into PNG images.
* [ansilove.js](https://ansilove.github.io/ansilove.js) for JavaScript
* [ansilove](https://www.ansilove.org) for PHP
@@ -24,7 +24,7 @@ Converts ANSI into PNG images.
### PabloDraw
_PabloDraw is an Ansi/Ascii text and RIPscrip vector graphic art editor/viewer with multi-user capabilities._
_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
### ACiDView
@@ -34,5 +34,5 @@ The granddaddy of ANSI art viewers that has a pedigree that goes back decades.
### iNFekt
A modern ASCII, NFO and ANSI art viewer and terminal converter for Windows.
An ASCII, NFO and ANSI art viewer and terminal converter for Windows.
[iNFekt](https://infekt.ws/) for Windows
Oops, something went wrong.

0 comments on commit fbd0f15

Please sign in to comment.