Formatting guide

The purpose of this page is to provide resources related to creating and formatting books that can be added to this website. The only sections directly related to formatting are Requirements, Creating Tests, and Sectioning.

Requirements

Books that are imported must meet the restrictions below

  • Books are in plain text and encoded as UTF-8
  • The filetype for uploaded books is ".txt"
  • At least one section has been added
  • Extra information about the book has been removed from the text file
Creating Tests

The parser breaks the book into test groups by line in the text file. If a line is less than 1200 letters, it will act as a single test when typing it. If a line is longer than this, it will be broken into multiple tests. If a line is more than 1200 letters, our database will still preserve that a test was meant to be grouped together as consecutive sentences in a paragraph. These groups are made available to users when users download the books using the "data" tab.

After importing a book, our server will begin addding it to the database. After it is finished, it will not be made live until you confirm the information the parser found for the the book looks correct..

If there were letters inside the book that were detected as not being possible to type, you will be required to fix these errors before it can be made live. You also do not need to worry about removing extra tabs, spaces, or whitespace in the file.

Useful Applications and Websites
  • Notepad++ - A better text editor than the text editor included with Windows. It includes tools for searching the contents of large files and using regular expressions to find content within large files.
  • Sublime Text - An alternative text editor that serves the same purpose as Notepad++. Notepad++ is only available on Windows while Sublime Text is on many operating systems.
  • Calibre - An application made for managing many different types of eBook formats. It will allow you to easily convert books into the text format required for this website.
  • Regex Guide - Regex allows you to search combinations/variations of text. It provides a way to search chapter/part numbers that are not consistently created across all books. The editors above support regex. Understanding how to use regex is not required, but the time spent learning how to use it will quickly outweigh the time spent searching for sections of text yourself.
  • Our Discord - If you are confused about anything with importing books or have concerns about content on this website, our Discord server is a great resource for asking questions.
Sectioning

Using the instructions below, sections can be created for books. The parser for this website shares the same section format as AsciiDoc. However, it only uses the format for sections from it.

Each section should begin with "=" followed by the title for the section. So for example, if the chapter was titled "Chapter 3: The Crystal Room", you should add a line with

=Chapter 3: The Crystal Room

The parser also supports multiple levels in sections. If a book has multiple parts, chapters, and other types of sections, they can easily be added by using multiple "=" symbols.

=Prologue
Test #1 in prologue
Test #2 in prologue
=Part Title
==Chapter Title
===Section #1 Title
Test #1 in section
Test #2 in section
Test #3 in section
===Section #2 Title
Test #1 in Section #2
Finding letters that are not typeable
After the the book has been imported, if there were any characters that were detected as not possible to type with a keyboard, they will be displayed with the ability to change them. You do not need to worry about removing them before importing the book.
fig. 1
Converting eBooks with Calibre
By following the steps below, you can quickly and easily convert eBooks to the format needed for importing books to this website. You will still need to format this text file after converting the text file following the information on this page.
Open the book that you have downloaded with Calibre. This can be done easily by right clicking on the book after installing Calibre, and selecting to open with Calibre.
fig. 2
After Calibre opens, it should show a list a books including the new book that was just added. Find the book you want to convert in the list, right click on it, then select "convert book" followed by "convert individually."
fig. 3
A new window should appear that shows information about this book. The top right of this window should allow you to select the "output format" for conversion. Select "txt" then press "OK" at the bottom of the this window. Calibre will then begin converting this book.
fig. 4
After it completes, return back to the list of books within Calibre. Once again, right click on the book, then click "open containing folder." This should open the location on your computer for where the files for this book are stored. You should now be able to find the text file Calibre created when converting this book.
fig. 5
Find the text file at the location that Calibre opened. Once you have located this file, you are free to move it to another location on your computer. You can always generate a new copy of it by completing the process above again. If you plan on importing this book to this website, you will still need to format with the instructions on this page for the index and tests to be displayed properly.
fig. 6