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

Add 'designer' keyword to syntax documentation

Browse Source
This commit is contained in:
Thomas Jensen
2016-01-02 22:22:32 +01:00
parent eac067310e
commit af05e7d1d6
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/config-syntax.html
View File

@@ -144,9 +144,12 @@ This set may change, but *boxes* will tell you your choices if you make a mistak
### Name of Author ### Name of Author
<PRE><b>AUTHOR</b> &quot;<i>name_of_author</i>&quot;</PRE> <PRE><b>AUTHOR</b> &quot;<i>name_of_author</i>&quot;</PRE>
Simply states who the ingenious guy/girl was who created the design. This entry is used when displaying the list of designs (`boxes -l`). The name should include the email address. Ideally, the entry should be usable "as is" in a `TO:` mail header, like this: Simply states who the person was who coded the box design definition. This entry is used when displaying the list of designs (`boxes -l`). The value is free text, but it is good if some contact information is included, for example `John Doe <john@acme.com>`. These days, such openness with one's email address may not suit everyone, so feel free to give less or differently formatted author information.
author "Thomas Jensen <tj@foobar.com>" <PRE><b>DESIGNER</b> &quot;<i>name_of_designer</i>&quot;</PRE>
In contrast to `author`, which tells us who created the config file entry, the `designer` keyword tells us who created the box design itself. In other words, this is the artist who originally created the ASCII artwork.
Please try to give both fields always. Especially in those cases where existing ASCII art from the internet is adapted for use with boxes, it is important (and good manners) to give credit to the original artist.
### General Entries ### General Entries