Skip to content

Commit b404bf0

Browse files
authored
Merge pull request #272 from boriel/doc/updates
Doc/updates
2 parents a97a74b + 4b58561 commit b404bf0

6 files changed

Lines changed: 41 additions & 6 deletions

File tree

docs/at.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ It can be used both as a [PRINT modifier](print#modifiers.md) and a [variable de
1515

1616
* [PRINT](print.md)
1717
* [DIM](dim.md) - Variable Declarations
18-
* [POS](pos.md)
19-
* [CSRLIN](csrlin.md)
18+
* [POS](library/pos.md)
19+
* [CSRLIN](library/csrlin.md)

docs/library.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Here are some alternative functions using faster integer and fixed output.
4040
* [clearBox.bas](library/clearbox.md)
4141
<br /> Sub to clear a subset of the screen - a window defined with a character box.
4242

43-
* [crslin.bas](csrlin.md)
43+
* [crslin.bas](library/csrlin.md)
4444
<br /> Function to get the current cursor vertical co-ordinate.
4545

4646
* [fastPlot.bas](library/fastplot.md)
@@ -58,7 +58,7 @@ instead of just character positions. (20% faster per character, but much larger
5858
<br /> Function to mirror the bits in a byte - the basis of printing, say a left facing sprite,
5959
if all you have are right facing graphics stored.
6060

61-
* [pos.bas](pos.md)
61+
* [pos.bas](library/pos.md)
6262
<br /> Function to get the current cursor horizontal co-ordinate.
6363

6464
* [windowPaint.bas](library/windowpaint.md)

docs/library/attr.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
##Requirements
2+
3+
ATTR is a library function to be included with the following command:
4+
5+
```
6+
#include <attr.bas>
7+
```
8+
9+
##Description
10+
`ATTR(row, col)`
11+
12+
Returns the ATTR (color attribute) of the given screen coordinate at the given row and column.
13+
14+
15+
##Sample usage
16+
17+
```
18+
#include <attr.bas>
19+
20+
PRINT AT 9, 10;PAPER 4; "A"
21+
LET s = ATTR$(9, 10)
22+
PRINT AT 0, 0; "The attribute of screen position 9, 10 is "; s
23+
```
24+
25+
##Remarks
26+
27+
* This function extends the one in Sinclair BASIC (and it's compatible with it) since it also allows rows 22 and 23.
28+
29+
30+
31+
##See also
32+
33+
* [ CSRLIN ](csrlin.md)
34+
* [ POS](pos.md)
35+
* [ AT ](../at.md)

docs/csrlin.md renamed to docs/library/csrlin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ CSRLIN is a library function to be included with the following command:
2525
##See also
2626

2727
* [ POS](pos.md)
28-
* [ AT ](at.md)
28+
* [ AT ](../at.md)

docs/pos.md renamed to docs/library/pos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ POS is a library function to be included with the following directive:
1616

1717
##See also
1818

19-
* [ AT ](at.md)
19+
* [ AT ](../at.md)
2020
* [ CSRLIN](csrlin.md)
File renamed without changes.

0 commit comments

Comments
 (0)