-
Notifications
You must be signed in to change notification settings - Fork 140
Getting started
Getting started with MindForger.
Table of contents:
This section aims to explain basic MindForger terminology:
In short:
- The MindForger workspace is analogous the desktop of an office desk.
Let's describe basic terms in more detail.
MindForger workspace:
- ... contains notebooks
- ... stored in a directory on the filesystem
- ... has its own configuration
- ... might be empty
MindForger notebook:
- contains notes
- organizes notes in hierarchy - outline
- can be marked with tags
- is typically devoted to a specific topic such as a project plan, family gifts or lessons learned
MindForger note:
- contains text, images and links
- can link notebooks and notes (within the Workspace) and/or files and URLs
- can be marked with tags
Create new workspace as follows:
- open menu
Workspace
- choose
New
menu item - choose
Workspace
sub-menu item -
New Workspace
dialog is opened:- type in workspace name
- feel free to modify where to store the workspace on the filesystem
- click New to create the workspace
Create new notebook as follows:
- open menu
Notebook
- π‘ if
Notebook
menu is disabled, then open list of notebooks (menuView
/Notebooks
) or notebooks tree (menuView
/Notebooks Tree
)
- π‘ if
- choose
New
menu item -
New Notebook
dialog is opened:- type in notebook name
- feel free modify notebook creation options and tags
- click OK to create the notebook
Create new note as follows:
- open menu
Note
- π‘ if
Note
menu might is disabled, then open the notebook in which you want to add the note
- π‘ if
- choose
New
menu item -
New Note
dialog is opened:- type in note name
- feel free modify note creation options and tags
- click OK to create the note
When you are viewing a note, you can edit it using one of the options below:
- Double click the mouse preview.
- Use Ctrl-e keyboard shortcut (Linux/Win).
- Use Alt-n e keyboard shortcut (Linux/Win).
Once you finish editing the note you can save it and preview using one of the options below:
- Use Alt-β¬ keyboard shortcut.
- Click Save & Leave button at the bottom of the editor.
While you are editing a note, you can fix grammar of the text as follows:
- select a text withing the note editor
- open Wingman chat window using Ctrl-/ (Linux/Win)
- specify prompt:
- custom prompt: type in
Fix grammar: #TEXT
(#TEXT
is replaced by the text you selected in the note editor) - predefined prompt: choose
Fix grammar: #TEXT
from the drop down
- custom prompt: type in
- click
Run
- check LLM model answer
- if you are satisfied, then click
Replace
and the fixed text from the Wingman chat window will replace the text in the note
... Wingman can do much more:
- complete sentences, paragraphs or portions of the text
- reformulate / rewrite the text - formally, informally, in a slang, like a person (Kafka), etc.
- provide synonyms and antonyms
- explain
... and much more - for more details see Wingman.
An outliner is a feature used in word processing, note-taking, and organizational software to help users outline and structure their ideas. Outlining actions in MindForger allow users to create hierarchies or levels of information by, making it easier to organize and navigate through a Notebook:
- open a notebook
- choose and view a note in the note tree
- open menu
Note
- choose one of the outlining actions
-
Promote
- to move note one level up in hierarchy (depth)
-
Demote
- to move note one level down in hierarchy (depth)
-
Move to first
- move note to the first from the top on its level (depth)
-
Move up
- move note one position up on its level (depth)
-
Move down
- move note one position down on its level (depth)
-
Move to last
- move note to the last from the top on its level (depth)
-
Outlining is a powerful tool that allows you to organize your thoughts and make your remarks structured, comprehensible, and scalable.
You can find notebooks and notes using the following attributes:
- name
- text phrase
- tag
For instance, to find notes by text phrase:
- open menu
Find
- choose
Full-text search
menu item -
Search
dialog is opened:- type in search phrase
- click Search to search for notes containing the phrase
- preview and select a note to open in the search results
Similarly, for other search options.
Notebook can be deleted deprecated as follows:
- open the notebook you want to delete (be sure that you are not editing a note)
- open menu
Notebook
- choose
Deprecate
menu item -
Deprecate Notebook
dialog is opened - click Yes to deprecate the notebook
As you can see, notebooks in MindForger are not deleted, but deprecated - they are moved to a limbo directory. To purge or resurrect deprecated notebook:
- open menu
View
- choose
Limbo
menu item - use you file manager to manipulate the notebook
MindForger video tutorials:
- π playlist on YouTube
Created with passion for my personal pleasure.
Released on the day of my 42nd birthday to confirm answer to the Ultimate Question of life, the Universe, and Everything.
[email protected] and contributors
2018-2024
Getting started:
- Basics
- Create Workspace
- Notes Outliner
- Find Note
- Delete Notebook
-
Video tutorials
- Video: Getting started
- Video: First steps
About:
- Why MindForger?
- Presentations:
- Prezi: Thinking notebook
- History
- In the news
- Bugs and feature requests
- Community
Installation:
User documentation:
- Basics
-
Knowledge manager
- New Notebook
- Open existing Notebook
- Edit Notebook and it's description
- Deprecate Notebook and Limbo
- Wingman @ LLM
-
Markdown editor
- From Markdown to MindForger
- Markdown document
- Document ~ Notebook
- Section ~ Note
- Open Markdown file
- New Markdown file
- Open directory with Markdowns
- Example Markdown content
- Markdown
- Markdown cheat sheet and specification
-
Format
menu - Images
- Links
- Math
- Diagrams
- Interesting documents and examples
- Live preview
- Outlineing
- Spellcheck
- From Markdown to MindForger
- Markdown IDE
- Templates
- Refactoring
- Cloning
- Link completion
-
Search
- Find . by .
- Full text search (scope)
- Recent
- Thinking notebook
- Workspace
- Metadata
- Tags
- Statistics (RW)
- Deadlines
- Progress
- Types (thing)
- Auto-linking
- Think as you Browse
- Think as you Read
- Think as you Write
- Associations
-
Scopes
- Time-based scopes
- Tag-based scopes
- Knowledge graph navigator
- Limbo
- Study tools
- Coaching
- Integrations
- Mobile phone (Git)
- Machine learning: NLP
- Tooling
- Configuration
- Appearance themes
- Fonts
- Spellcheck
- AA poller
- Credits
Developer documentation:
- Contribute
- Build
- Development environment
- Linux development environment
- Windows development environment
- macOS development environment
- Automation
- Makefile and build/ directory
-
Continuous Integration (CI)
- GitHub Actions
- AppVeyor
- nightly builds: .dmg | Win installer
- Implementation
- Incremental Markdown recursive descent parser
- Magnets and rubbers: Force-directed Graph
- Model View Presenter front-end pattern
- NLP: stemmer, lexicon and bag of words
- Repository layout specification
- Outline document format specification (Markdown hosted DSL)
- Localization
- API reference (dOxygen generated documentation @ www.mindforger.com)
- Licensing
- Testing
- Library unit tests
- Frontend testing
- Packaging
- Packaging flow and build environments (CI + VMs)
- GitHub Actions (macOS Disk ImaGe, Linux tarball)
- AppVeyor (Windows installer)
- Packaging flow and build environments (CI + VMs)
- Conventions and best practices
- Branching conventions
- Code format conventions
- Security policy
Frequently Asked Questions