Skip to content

Commit 6034b73

Browse files
add new documentation for edit
1 parent ea4eed2 commit 6034b73

File tree

286 files changed

+670
-318
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

286 files changed

+670
-318
lines changed

docpages/images/edit.png

186 KB
Loading
Lines changed: 81 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,85 @@
11
\page edit edit program
22

3-
A WYSIWYG editor, similar to GNU `nano` or MS-DOS `edit`. The editor can edit and save text files onto the file system.
3+
# Text Editor
44

5-
![image](https://user-images.githubusercontent.com/1556794/235879934-cbcb14a2-a030-4953-97ac-846a8cdf5a09.png)
5+
The text editor provides a simple, full-screen way to create and modify text files. It behaves similarly to GNU `nano` or MS-DOS `edit`, with clear on-screen prompts and keyboard shortcuts.
66

7+
\image html edit.png
8+
9+
## Starting the editor
10+
11+
* To edit an existing file:
12+
13+
```basic
14+
edit filename.txt
15+
```
16+
17+
* To begin a new file:
18+
19+
```basic
20+
edit
21+
```
22+
23+
## Moving around
24+
25+
* Use the **arrow keys** to move the cursor up, down, left, and right.
26+
* **Home** jumps to the start of the current line.
27+
* **End** jumps to the end of the current line.
28+
* **Page Up** and **Page Down** move through the file a screen at a time.
29+
30+
## Editing text
31+
32+
* Simply type to insert characters at the cursor.
33+
* **Enter** splits the line at the cursor and moves the text to a new line.
34+
* **Backspace** deletes the character to the left of the cursor.
35+
* **Delete** removes the character under the cursor.
36+
* Lines will join together automatically if you backspace at the start of a line or delete at the end.
37+
38+
## Saving your work
39+
40+
* Press **Ctrl+S** to save.
41+
42+
* If the file already has a name, you’ll be asked whether to keep it.
43+
* If it’s a new file, you’ll be prompted to enter a name.
44+
45+
## Searching and replacing
46+
47+
* **Ctrl+W** starts a search. Type the text to look for, and the editor will highlight the first match.
48+
* **Ctrl+R** begins search and replace.
49+
50+
* Type the text to search for.
51+
* Type the replacement text.
52+
* For each match you can choose:
53+
54+
* **Y** – replace this one
55+
* **N** – skip
56+
* **A** – replace all
57+
* **Q** – quit replacing
58+
59+
## Syntax highlighting
60+
61+
* Press **Ctrl+T** to toggle syntax highlighting on or off.
62+
* When enabled, BASIC keywords are coloured for easier reading.
63+
* This affects only the display, not the saved file.
64+
65+
## Exiting the editor
66+
67+
* Press **ESC** to quit.
68+
* If you have unsaved changes, the editor will ask you to confirm before closing.
69+
70+
## Quick reference
71+
72+
| Key | Action |
73+
| -------------------- | -------------------------- |
74+
| **ESC** | Exit editor |
75+
| **Ctrl+S** | Save file |
76+
| **Ctrl+W** | Search |
77+
| **Ctrl+R** | Search and replace |
78+
| **Ctrl+T** | Toggle syntax highlighting |
79+
| **Arrows** | Move cursor |
80+
| **Home** | Move to start of line |
81+
| **End** | Move to end of line |
82+
| **PgUp** | Page up |
83+
| **PgDn** | Page down |
84+
| **Enter** | Split line |
85+
| **Backspace/Delete** | Remove characters |

docs/ABS.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
9999
<ul>
100100
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="builtin-functions.html">Built-In Functions</a></li><li class="navelem"><a class="el" href="int-funcs.html">Integer Functions</a></li>
101-
<li class="footer">Generated on Wed Sep 10 2025 14:52:44 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
101+
<li class="footer">Generated on Wed Sep 10 2025 15:46:51 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102102
</ul>
103103
</div>
104104
</body>

docs/ACS.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
100100
<ul>
101101
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="builtin-functions.html">Built-In Functions</a></li><li class="navelem"><a class="el" href="real-funcs.html">Real Functions</a></li>
102-
<li class="footer">Generated on Wed Sep 10 2025 14:52:44 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102+
<li class="footer">Generated on Wed Sep 10 2025 15:46:51 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
103103
</ul>
104104
</div>
105105
</body>

docs/ASC.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
9999
<ul>
100100
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="builtin-functions.html">Built-In Functions</a></li><li class="navelem"><a class="el" href="int-funcs.html">Integer Functions</a></li>
101-
<li class="footer">Generated on Wed Sep 10 2025 14:52:44 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
101+
<li class="footer">Generated on Wed Sep 10 2025 15:46:51 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102102
</ul>
103103
</div>
104104
</body>

docs/ASN.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
100100
<ul>
101101
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="builtin-functions.html">Built-In Functions</a></li><li class="navelem"><a class="el" href="real-funcs.html">Real Functions</a></li>
102-
<li class="footer">Generated on Wed Sep 10 2025 14:52:44 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102+
<li class="footer">Generated on Wed Sep 10 2025 15:46:51 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
103103
</ul>
104104
</div>
105105
</body>

docs/ATAN.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
100100
<ul>
101101
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="builtin-functions.html">Built-In Functions</a></li><li class="navelem"><a class="el" href="real-funcs.html">Real Functions</a></li>
102-
<li class="footer">Generated on Wed Sep 10 2025 14:52:44 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102+
<li class="footer">Generated on Wed Sep 10 2025 15:46:51 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
103103
</ul>
104104
</div>
105105
</body>

docs/ATAN2.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
100100
<ul>
101101
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="builtin-functions.html">Built-In Functions</a></li><li class="navelem"><a class="el" href="real-funcs.html">Real Functions</a></li>
102-
<li class="footer">Generated on Wed Sep 10 2025 14:52:44 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
102+
<li class="footer">Generated on Wed Sep 10 2025 15:46:51 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
103103
</ul>
104104
</div>
105105
</body>

docs/AUTOFLIP.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
103103
<ul>
104104
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="keywords.html">Keywords</a></li>
105-
<li class="footer">Generated on Wed Sep 10 2025 14:52:44 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
105+
<li class="footer">Generated on Wed Sep 10 2025 15:46:51 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
106106
</ul>
107107
</div>
108108
</body>

docs/BACKGROUND.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ <h5>Notes</h5>
155155
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
156156
<ul>
157157
<li class="navelem"><a class="el" href="index.html">index</a></li><li class="navelem"><a class="el" href="basic-ref.html">BASIC Language Reference</a></li><li class="navelem"><a class="el" href="keywords.html">Keywords</a></li>
158-
<li class="footer">Generated on Wed Sep 10 2025 14:52:44 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
158+
<li class="footer">Generated on Wed Sep 10 2025 15:46:51 for Retro Rocket OS by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
159159
</ul>
160160
</div>
161161
</body>

0 commit comments

Comments
 (0)