extern/boxes
1
0
Fork 0
mirror of https://github.com/ascii-boxes/boxes.git synced 2025-08-18 02:30:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

Open external links in new tab, kramdown syntax

Browse Source
This commit is contained in:
Thomas Jensen
2015-05-12 23:40:10 +02:00
parent 4b5cf7317b
commit 57af73ae98
4 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/config-complete_exp.html
View File

@@ -7,7 +7,7 @@ title: Docs - Config Examples
In order to illustrate the *boxes* configuration language described in the previous chapters, we now look at the source code of two complete box designs, one simple and one more complex.
In addition to the examples shown here, please refer to the [official boxes config file](https://github.com/{{ site.github }}/blob/master/boxes-config) for tons more.
In addition to the examples shown here, please refer to the [official boxes config file](https://github.com/{{ site.github }}/blob/master/boxes-config){:target="_blank"} for tons more.
## Simple Example

5
docs/config-syntax.html
View File

@@ -21,7 +21,7 @@ Every box design definition must have at least a `SHAPE` block, an `ELASTIC` lis
<PRE><b>SAMPLE</b>
sample_image_of_box
<b>ENDS</b></PRE>
This is the box image used for the list of available designs. The reason why an image is not simply generated is that this way, the box can be shown in an environment in which it might actually be used, e.g. with some C code around (see the [boxes config file](https://github.com/{{ site.github }}/blob/master/boxes-config) for many examples).
This is the box image used for the list of available designs. The reason why an image is not simply generated is that this way, the box can be shown in an environment in which it might actually be used, e.g. with some C code around (see the [boxes config file](https://github.com/{{ site.github }}/blob/master/boxes-config){:target="_blank"} for many examples).
The `ENDS` statement must stand on a line of its own, although it may be indented. Such a line cannot occur as part of the sample itself.
The `SAMPLE` block is a required entry in every box design definition.
@@ -152,7 +152,8 @@ Simply states who the ingenious guy/girl was who created the design. This entry
### General Entries
<PRE><b>keyword</b> &quot;<i>string_value</i>&quot;</PRE>
In addition to the author entry, there may be any number of other entries of the above form, giving any kind of information. The [boxes config file](https://github.com/{{ site.github }}/blob/master/boxes-config) includes the entries `CREATED`, `REVISION`, and `REVDATE`, to indicate the creation timestamp, revision number, and timestamp of the latest revision, respectively. These other entries are not yet used by *boxes*, though, and will simply be ignored.
In addition to the author entry, there may be any number of other entries of the above form, giving any kind of information. The [boxes config file](https://github.com/{{ site.github }}/blob/master/boxes-config){:target="_blank"} includes the entries `CREATED`, `REVISION`, and `REVDATE`, to indicate the creation timestamp, revision number, and timestamp of the latest revision, respectively. These other entries are not yet used by *boxes*, though, and will simply be ignored.
[ [up](index.html) \| [next](config-step.html) ]

2
docs/faq.html
View File

@@ -56,7 +56,7 @@ The current version includes changes to solve all compilation issues reported to
It's a known bug in flex, and has no impact on boxes. You can safely ignore this warning.
- `Bad address` on *boxes* execution after compiling on a 64bit system:
This may happen when the system you are compiling on is 64bit. Boxes is only a 32bit program, so the compiler may have to be forced to 32bit by adding the `-m32` option. (Thanks to <span class="atmention">[@stefanow](https://github.com/stefanow)</span> for [supplying](https://github.com/{{ site.github }}/issues/7) this information!)
This may happen when the system you are compiling on is 64bit. Boxes is only a 32bit program, so the compiler may have to be forced to 32bit by adding the `-m32` option. (Thanks to <span class="atmention">[@stefanow](https://github.com/stefanow)</span> for [supplying](https://github.com/{{ site.github }}/issues/7){:target="_blank"} this information!)
In order to do this, use the following command line (works with current sources):
make CFLAGS_ADDTL=-m32 LDFLAGS_ADDTL=-m32

6
docs/filters.html
View File

@@ -5,13 +5,13 @@ title: What are filters?
# What are filters?
[Filters](http://en.wikipedia.org/wiki/Filter_%28software%29) are generally programs which read some input text from standard input, perform some modifications on it, and write the modified text to standard output. While a single filter can be used individually, they are frequently strung together to form a pipeline. *Boxes* is such a filter program.
[Filters](http://en.wikipedia.org/wiki/Filter_%28software%29){:target="_blank"} are generally programs which read some input text from standard input, perform some modifications on it, and write the modified text to standard output. While a single filter can be used individually, they are frequently strung together to form a pipeline. *Boxes* is such a filter program.
Some text editors *support filters*, which is to say they offer a way to let filter programs make changes to the text being edited. By pressing a key, the user tells the editor to start the filter program (e.g. *boxes*) and feed it the lines of text selected in the editor. Those lines are subsequently replaced with the output from the filter program.
**Here's an example using *boxes*:**
Imagine your editor (in this case, it's [Vim](http://www.vim.org/)) shows the following C code (it could be any text, of course):
Imagine your editor (in this case, it's [Vim](http://www.vim.org/){:target="_blank"}) shows the following C code (it could be any text, of course):
<IMG SRC="{{ site.baseurl}}/images/filter1.gif" WIDTH="619" HEIGHT="272" ALT="text before filtering" />
@@ -25,6 +25,6 @@ Now you mark some of the lines ...
Voil&aacute;! The marked lines have been fed to *boxes* and replaced by the output of *boxes*. You've got yourself a box! Of course the same mechanism works for box removal - or anything else you can find a filter for. :smile:
Most major text editors support filters, among them [Vim](http://www.vim.org/), [Emacs](http://www.emacs.org/), and [Jed](http://www.jedsoft.org/jed/). There are certainly many, many more.
Most major text editors support filters, among them [Vim](http://www.vim.org/){:target="_blank"}, [Emacs](http://www.gnu.org/software/emacs/){:target="_blank"}, and [Jed](http://www.jedsoft.org/jed/){:target="_blank"}. There are certainly many, many more.
Please see the [installation section](install.html) in the *boxes* docs for more info on how to make your editor work with *boxes*.