Skip to content

BoxScan 2.0

Latest
Compare
Choose a tag to compare
@JakesCode JakesCode released this 14 Mar 11:29
· 2 commits to master since this release

It's here!

What does it do?
BoxScan aims to make writing tedious sections of text easier to cope with.

Many people find themselves writing the same small section of text, like a phrase for a form, over and over again.

BoxScan allows you to define abbreviations and their respective meanings. BoxScan can be used in situations like these:

You fill in forms as part of a job. You find yourself repeatedly writing sections of text like "Not Cleaned" and "Consistent With Inventory".
You are writing details for a database about fault reports, and use universal keywords so people understand what you mean and can follow a guide/key.
...and many more.


How do I use it?
BoxScan works on a user-defined system of codewords and definitions.

The user writes a section of text in the top box, presses the Submit button, and the generated text (with codewords replaced by definitions) will appear in the bottom box.


Creating user-specific codewords and definitions
In the file called "main.html", there is a section near the top with two lines of "//////" marking it out.

Here is an example of one of the lines you might find there:

mapping["CWI"] = "consistent with inventory";

This section of code is all you need to define a codeword.
You follow this basic formula:

mapping["codeword"] = "definition";

E.g.

mapping["PBJ"] = "Peanut, Butter & Jelly";

The definition can include anything. In fact, you could set up a name system by which inputting a person's name gives you their favourite colour. - It's a very flexible system.

And remember, you can have as many codewords and definitions as you want, but good luck coming up with enough to fill your hard-drive.