Skip to content

Commit 2973280

Browse files
Update docs to: Add Project module (TFPM): .tfproj support, Project menu, Files panel and Recent Projects (#95)
1 parent 7379561 commit 2973280

File tree

2 files changed

+129
-125
lines changed

2 files changed

+129
-125
lines changed

docs/menus.md

Lines changed: 83 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ command structure. This guide has tried to explore the tips for menu options.
66
All actions support multi-caret editing, if not, action will show a popup and request caret
77
selection. You can click on a text without selection (caret) when hold `Alt` to add new caret.
88

9+
!!! Note
10+
11+
If there was something you didn't find in this list, check the [Not Available Options](#not-available-options)
12+
section; if it wasn't there either, please [report it](https://github.com/text-forge/text-forge/issues/new?template=bug_report.md).
13+
914
## File
1015
This menu includes regular actions with working with files and the editor window.
1116

@@ -17,12 +22,6 @@ file and then continue editing.
1722
Opens another window of the editor. Due to the lack of support for multi-file editing (currently),
1823
this is a good way to work with multiple files.
1924

20-
### New With Template
21-
22-
!!! Note
23-
24-
It isn't yet available.
25-
2625
### Open
2726
Creates a pop-up to select and open an existing file.
2827

@@ -41,8 +40,8 @@ It reloads the open file, similar to reopening the same file.
4140

4241
!!! Note
4342

44-
Some functions may not work properly after saving a file, in which case please report the
45-
problem and use Reload as a temporary solution.
43+
If some functions don’t work properly after saving, please report the issue and use Reload as a
44+
temporary workaround.
4645

4746
### Close
4847
It closes the open file, without closing the editor.
@@ -56,7 +55,7 @@ It displays a list of available backups by file and time, restored by clicking o
5655

5756
!!! Warning
5857

59-
This is an experimental feature.
58+
This is an experimental feature.
6059

6160
### Copy Path
6261
Copies the path of the open file to the clipboard.
@@ -74,6 +73,47 @@ Similar to New Window but closes the current window.
7473
### Exit
7574
Closes the editor.
7675

76+
## Project
77+
This menu includes commands and actions related to projects.
78+
79+
### New Project
80+
Opens the **New Project** window to create a new project.
81+
82+
!!! Tip
83+
84+
See [Setup > Create New Project](setup.md#create-new-project) for a guide to `.tfproj` fields and workflow.
85+
86+
### Open Project
87+
Opens a file dialog to select a `.tfproj` file and load it as the current project.
88+
89+
!!! Note
90+
91+
While you can open a `.tfproj` via **File > Open**, it is discouraged because it won’t initialize
92+
full project context (e.g. last opened file). Prefer **Project > Open Project** for proper
93+
`.tfproj` handling.
94+
95+
### Recent Projects
96+
Opens a list of recent projects. Click a project to open it.
97+
98+
!!! Note
99+
100+
This list is limited to 15 items. Non-existent files will be removed automatically.
101+
102+
### Close Project
103+
Closes the current project.
104+
105+
!!! Note
106+
107+
When you open a file that isn't in the project's files, the editor will run this action. To add
108+
a new file to the project, use **Project > Project Settings > Include > Add Files...**.
109+
110+
### Project Settings
111+
Opens the **Project Settings** window, where you can modify the current project's configuration. You
112+
can use the **Add Files...** and **Add Folder...** buttons in the **Include** and **Exclude** sections to
113+
manage project files.
114+
115+
For each folder in the include list, the editor adds that folder and all its subfolders and files to the project.
116+
When you exclude a subfolder, its contents are ignored as well.
77117
## Edit
78118
This menu contains commands and actions related to editing the content of the file.
79119

@@ -137,7 +177,7 @@ It converts the line into a comment or vice versa.
137177

138178
!!! Warning
139179

140-
This is an experimental feature.
180+
This is an experimental feature.
141181

142182
#### Duplicate Lines
143183
It duplicates the selected lines and selects the duplicated lines.
@@ -166,7 +206,7 @@ Will automaticly indent whole file content.
166206

167207
!!! Note
168208

169-
Some modes haven't support for auto indent, this option will be enabled just for supported modes.
209+
Some modes don’t support Auto Indent; this option is enabled only for supported modes.
170210

171211
#### Convert Indent To Spaces
172212
Converts indention of currently selected line(s) to spaces and sets indention mode to spaces.
@@ -199,48 +239,6 @@ This menu includes commands and actions related to fast navigation in file conte
199239
### Go To Line
200240
Shows a popup to go to selected line, **line numbers start from 1.**
201241

202-
### Code Regions
203-
204-
!!! Note
205-
206-
It isn't yet available.
207-
208-
### Insert Navigation Mark
209-
210-
!!! Note
211-
212-
It isn't yet available.
213-
214-
### Navigation Marks
215-
216-
!!! Note
217-
218-
It isn't yet available.
219-
220-
### Table Of Contents
221-
222-
!!! Note
223-
224-
It isn't yet available.
225-
226-
### Bookmarks
227-
228-
!!! Note
229-
230-
It isn't yet available.
231-
232-
### Toggle Bookmark
233-
234-
!!! Note
235-
236-
It isn't yet available.
237-
238-
### Remove All Bookmarks
239-
240-
!!! Note
241-
242-
It isn't yet available.
243-
244242
## Command
245243
This menu includes commands and actions related to commands that you can run.
246244

@@ -258,31 +256,19 @@ Will automaticly format whole file content.
258256

259257
!!! Note
260258

261-
Some modes haven't support for auto format, this option will be enabled just for supported modes.
259+
Some modes don’t support Auto Format; this option is enabled only for supported modes.
262260

263261
### Auto Indention
264262
When enabled, editor will try to calculate indention level when you add new line; Otherwise, will
265263
apply last line indention level for new line.
266264

267265
!!! Note
268266

269-
This is an experimental feature and can have wrong behavior.
267+
This feature is experimental and may behave unexpectedly.
270268

271269
### Remove All Indents
272270
Removes all indention and white spaces in both side of all lines.
273271

274-
### Save As Template
275-
276-
!!! Note
277-
278-
It isn't yet available.
279-
280-
### Templates
281-
282-
!!! Note
283-
284-
It isn't yet available.
285-
286272
## View
287273
This menu includes options and actions related to editor layout and visible items.
288274

@@ -309,7 +295,7 @@ When enabled, shows bookmarks in gutter.
309295

310296
!!! Note
311297

312-
Bookmarks feature isn't yet available.
298+
Bookmarks feature isn't yet available.
313299

314300
### Show Line Numbers
315301
When enabled, shows line numbers in gutter (from 1).
@@ -325,8 +311,8 @@ When enabled, shows caret as block.
325311

326312
!!! Important
327313

328-
This ins't replace edit mode (replace next character instead of insert new character before it),
329-
to switch between insert and replace editing modes, press `insert` button.
314+
This isn’t the Replace edit mode (which overwrites the next character). To switch between Insert
315+
and Replace modes, press the `Insert` key.
330316

331317
### Highlight All Occurrences
332318
When enabled, highlightes other occurrences of currently selected text.
@@ -339,7 +325,7 @@ When enabled, shows control characters.
339325

340326
!!! Tip
341327

342-
You can insert control characters from context menu.
328+
You can insert control characters from the context menu.
343329

344330
### Show Tabs
345331
When enabled, shows each tab with a transparent.
@@ -356,60 +342,6 @@ This menu includes tools, them settings, and extensions options.
356342
### Color Picker
357343
Shows a color picker window to help you work with colors.
358344

359-
### Security
360-
361-
!!! Note
362-
363-
It isn't yet available.
364-
365-
### Counter
366-
367-
!!! Note
368-
369-
It isn't yet available.
370-
371-
### Translation
372-
373-
!!! Note
374-
375-
It isn't yet available.
376-
377-
### Clipboard History
378-
379-
!!! Note
380-
381-
It isn't yet available.
382-
383-
### Function Creator.
384-
385-
!!! Note
386-
387-
It isn't yet available.
388-
389-
### Documentation
390-
391-
!!! Note
392-
393-
It isn't yet available.
394-
395-
### Auto Completion
396-
397-
!!! Note
398-
399-
It isn't yet available.
400-
401-
### Time Management.
402-
403-
!!! Note
404-
405-
It isn't yet available.
406-
407-
### Calendar
408-
409-
!!! Note
410-
411-
It isn't yet available.
412-
413345
### By Extensions
414346
Keeps options provided by extensions.
415347

@@ -451,3 +383,29 @@ Opens home page of online documentation in browser.
451383

452384
### About
453385
Opens about dialog.
386+
387+
---
388+
389+
## Not Available Options
390+
There are some options that are always disabled in menus and are not yet available, these are listed
391+
below:
392+
393+
- File > New With Template
394+
- Go To > Code Regions
395+
- Go To > Insert Navigation Mark
396+
- Go To > Navigation Marks
397+
- Go To > Table Of Contents
398+
- Go To > Bookmarks
399+
- Go To > Toggle Bookmark
400+
- Go To > Remove All Bookmarks
401+
- Format > Save As Template
402+
- Format > Templates
403+
- Tools > Security
404+
- Tools > Counter
405+
- Tools > Translation
406+
- Tools > Clipboard History
407+
- Tools > Function Creator
408+
- Tools > Documentation
409+
- Tools > Auto Completion
410+
- Tools > Time Management
411+
- Tools > Calendar

docs/setup.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,49 @@ You have a ready code editor! Let's open a file:
4545

4646
On windows, use RMB on file and click on **Open With**, then select Text Forge runnable `.exe`.
4747
After this you will be able to open files with Text Forge without open it directly.
48+
49+
## Create New Project
50+
51+
!!! Note
52+
53+
Unlike most editors, you don't need to create a project before creating a file, so this section is optional.
54+
55+
If you've used other editors, you'll notice a different **project** concept. In other editors:
56+
57+
- A project is a folder.
58+
- Project information is stored in a subfolder of that folder (e.g., `.textforge`).
59+
60+
In Text Forge:
61+
62+
- A project is a `.tfproj` file.
63+
- Project information is stored in that file.
64+
65+
But why? We have specific reasons for this design:
66+
67+
|Feature |Folder-based projects |`.tfproj` projects |
68+
|-----------------------|-------------------------------|------------------------|
69+
|File Path Flexibility |Only files inside the folder |Any file from any path |
70+
|Single-File Projects |Requires a folder |A single file is enough |
71+
|Custom Project Settings|Scattered across multiple files|Centralized in `.tfproj`|
72+
73+
Overall, this design gives you more flexibility. You can keep parts of a larger project in different
74+
folders and switch between them in the editor with a single click.
75+
76+
Let's see Text Forge projects in action. You can create a project from **Project > New Project**.
77+
This opens the **New Project** window with these fields:
78+
79+
- **Project File** — Path to your `.tfproj` file.
80+
- **Name** — Project name.
81+
- **Details** — Optional project details.
82+
- **Icon** — Optional project icon.
83+
- **Tags** — Optional comma-separated list of tags.
84+
- **Include** — Folders and files to add to the project.
85+
- **Exclude** — Folders and files to exclude from the project.
86+
87+
When you press the **Create** button, the editor creates the project, and you can use **Project > Open Project**
88+
to open it. Then, navigate between project files in the **Files** panel on the left side of the editor.
89+
To automatically save files when moving between project files, enable
90+
**Settings > Preferences... > Files > Save Files When Moving Between Project Files**.
91+
92+
!!! Tip
93+
See also: [Project menu](menus.md#project)

0 commit comments

Comments
 (0)