From dc243dd41309838d173f9be7522559f81fd59e61 Mon Sep 17 00:00:00 2001 From: Ofossum Date: Tue, 12 Apr 2022 23:30:05 +0200 Subject: [PATCH 1/6] rearranged contribute.md with newline per sentence --- contribute.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/contribute.md b/contribute.md index 071025c..44a63a3 100644 --- a/contribute.md +++ b/contribute.md @@ -2,16 +2,25 @@ ----- -We are hosting the wiki files at a GitHub repo, but their site does not allow easy styling of the format, full text search of the wiki, or a sidebar to navigate. Thus, we are using Docsify to provide these features. +We are hosting the wiki files at a GitHub repo, but their site does not allow easy styling of the format, full text search of the wiki, or a sidebar to navigate. +Thus, we are using Docsify to provide these features. -We need someone to help style this wiki using Docsify. Quickfold does not have the technical skills and Dimitry is too busy programming Freeplane. If you can help, please contact us. +We need someone to help style this wiki using Docsify. +Quickfold does not have the technical skills and Dimitry is too busy programming Freeplane. +If you can help, please contact us. -Documentation will be uploaded as it is completed which means that there will be lots of gaps. Any section headings without documentation are placeholders. Some sections will have incomplete text, these may contain the phrase "(to be added)" to make clear that we need more content in this section. +Documentation will be uploaded as it is completed which means that there will be lots of gaps. +Any section headings without documentation are placeholders. +Some sections will have incomplete text, these may contain the phrase "(to be added)" to make clear that we need more content in this section. -I've listed some ways to contribute below, from lowest to greatest effort. Any help or other suggestions are appreciated! +I've listed some ways to contribute below, from lowest to greatest effort. +Any help or other suggestions are appreciated! * Add a question to the FAQ * Paste a link to a relevant resource (e.g., a discussion on the Freeplane forum, an online video, a web page) under the correct topic heading in this wiki * Take screenshots of Freeplane to illustrate relevant topics, put the image files in the `/images` folder in this repo (and even better if you can put links to the images in the correct section of this wiki) -* Write any amount of text documenting one of the topics—a how-to, an explanation, a tutorial, or providing reference/technical information about Freeplane. Note: do not worry about grammar. Quickfold will fix writing problems. Feel free to write in your native language and paste the English results from Google Translate or DeepL.com +* Write any amount of text documenting one of the topics—a how-to, an explanation, a tutorial, or providing reference/technical information about Freeplane. + Note: do not worry about grammar. + Quickfold will fix writing problems. + Feel free to write in your native language and paste the English results from Google Translate or DeepL.com * Contact Quickfold or Dimitry to help with the planning, writing, or presentation of the documentation From 089d55a2691455bc715c5de25e792e2b6f8910c9 Mon Sep 17 00:00:00 2001 From: Ofossum Date: Tue, 12 Apr 2022 23:32:31 +0200 Subject: [PATCH 2/6] rearranged css-for-html-or-markdown.md with newline per sentence --- css-for-html-or-markdown.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/css-for-html-or-markdown.md b/css-for-html-or-markdown.md index 4f3a079..27c1004 100644 --- a/css-for-html-or-markdown.md +++ b/css-for-html-or-markdown.md @@ -103,7 +103,8 @@ CSS can be added to **Details** and to **Note**, making it possible to specify d CSS added to **Details** will affect node-details HTML/Markdown of all nodes in the map.
Similarly, CSS added to **Note** will affect note HTML/Markdown of all nodes in the map. -Note that when CSS is added to **Default**, it is also applied to **Details** and **Note**. To make **Details** or **Note** ignore CSS added to **Default** and use only its formatting properties, add "empty" CSS (e.g. a space) to **Details** or **Note** respectively. +Note that when CSS is added to **Default**, it is also applied to **Details** and **Note**. +To make **Details** or **Note** ignore CSS added to **Default** and use only its formatting properties, add "empty" CSS (e.g. a space) to **Details** or **Note** respectively. This is because when CSS is added to a Style (here to **Details** or to **Note**), CSS added to **Default** is ignored for that Style. ## Example Of Markdown With CSS @@ -112,7 +113,8 @@ Given the following Markdown document: ~~~markdown # Heading 1 -Regular text. **Bold text.** *Italic text.* ***Both: bold and italic.*** +Regular text. +**Bold text.** *Italic text.* ***Both: bold and italic.*** A line (horizontal ruler) using underscores: ___ From 07b1b249483c873e5197599fb11231c21074cd9c Mon Sep 17 00:00:00 2001 From: Ofossum Date: Tue, 12 Apr 2022 23:34:32 +0200 Subject: [PATCH 3/6] rearranged templates.md with newline per sentence --- templates.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/templates.md b/templates.md index 5777755..68d9b2b 100644 --- a/templates.md +++ b/templates.md @@ -8,7 +8,8 @@ Depending on your OS, you can find template-folders in different directories. However, on every OS, there is a subfolder in the Freeplane installation-folder, where you can store user-definded template-files. **Attention:**\ -You can also change the default directory containing the user configuration. This means, the file-path for templates might differ (see [The user directory](customizing-freeplane.md#the-user-directory)). +You can also change the default directory containing the user configuration. +This means, the file-path for templates might differ (see [The user directory](customizing-freeplane.md#the-user-directory)). **Windows** From 709cd14bdfc5e993ba6e374da2538ebba6461b8c Mon Sep 17 00:00:00 2001 From: Ofossum Date: Tue, 12 Apr 2022 23:37:01 +0200 Subject: [PATCH 4/6] rearranged understanding-interface.md with newline per sentence --- understanding-interface.md | 65 ++++++++++++++++++++++++++++++-------- 1 file changed, 52 insertions(+), 13 deletions(-) diff --git a/understanding-interface.md b/understanding-interface.md index fd7d314..31fa83a 100644 --- a/understanding-interface.md +++ b/understanding-interface.md @@ -2,51 +2,72 @@ ## Overview -The main workspace in Freeplane is the map window in the center. You can have several maps open at the same time, each one marked by a tab at the top of the map window. +The main workspace in Freeplane is the map window in the center. +You can have several maps open at the same time, each one marked by a tab at the top of the map window. -Above the map window are the Menu bar and several toolbars. At the top is the Menu bar, which lets users take actions such as opening and editing maps. Below that is the toolbar (lets you perform Menu actions by clicking icons), then the filter bar (for searching and filtering nodes), and then the F-bar (for quickly performing actions using Function keys as hotkeys). +Above the map window are the Menu bar and several toolbars. +At the top is the Menu bar, which lets users take actions such as opening and editing maps. +Below that is the toolbar (lets you perform Menu actions by clicking icons), then the filter bar (for searching and filtering nodes), and then the F-bar (for quickly performing actions using Function keys as hotkeys). -On the left is the Icon Panel, used to easily add icons to nodes, and on the right is the Tool panel, which has four tabs used for various functions. The Icon Panel and Tool Panel can be toggled open and closed by clicking on the black triangle/arrow on the skinny sidebars on either side of the map window. +On the left is the Icon Panel, used to easily add icons to nodes, and on the right is the Tool panel, which has four tabs used for various functions. +The Icon Panel and Tool Panel can be toggled open and closed by clicking on the black triangle/arrow on the skinny sidebars on either side of the map window. When made visible, the Notes Panel is below the map window, and at the bottom of the Freeplane interface is the status bar, which shows information about the selected node. ## The Freeplane interface -Here we describe the default Freeplane interface in more detail. Almost all of these elements can be customized or hidden. +Here we describe the default Freeplane interface in more detail. +Almost all of these elements can be customized or hidden. ### Map window + ### Menu bar + ### Tool bar + ### Filter bar + ### F-bar + ### Icon panel + ### Tool panel Docked on the right side of Freeplane is the Tool panel, which can be toggled open/closed with `Alt+P` or by clicking the arrow in the right skinny sidebar. -The Tool panel has four tabs, also called "panels": the Format Panel, the Attributes Panel, the Calendar Panel, and the Presentations panel. Of these four, most users will only use the Format Panel. +The Tool panel has four tabs, also called "panels": the Format Panel, the Attributes Panel, the Calendar Panel, and the Presentations panel. +Of these four, most users will only use the Format Panel. (to be added) #### Format panel + #### Attributes panel + #### Calendar panel + #### Presentations panel + ### Note panel + ### Status bar + ## Undocked control windows -Some of Freeplane's functions are controlled by windows that appear upon certain user actions. These pop-up windows include the following: +Some of Freeplane's functions are controlled by windows that appear upon certain user actions. +These pop-up windows include the following: ### Style Editor -The Style Editor is the main interface for editing node styles. See [Styles](styles.md) for more information. +The Style Editor is the main interface for editing node styles. +See [Styles](styles.md) for more information. (to be added) ### Filter Composer -The Filter Composer works together with the Filter Toolbar to help you find and display a subset of your map nodes, which can be useful for a wide variety of tasks. See [Filtering nodes](filtering-nodes.md) for more information. +The Filter Composer works together with the Filter Toolbar to help you find and display a subset of your map nodes, which can be useful for a wide variety of tasks. +See [Filtering nodes](filtering-nodes.md) for more information. (to be added) @@ -54,7 +75,8 @@ The Filter Composer works together with the Filter Toolbar to help you find and ### Find Panel -The Find Panel provides a pop-up version of the Find Toolbar that can be left open to better manage searches. See [Searching Nodes](searching-nodes.md) for more information. +The Find Panel provides a pop-up version of the Find Toolbar that can be left open to better manage searches. +See [Searching Nodes](searching-nodes.md) for more information. (to be added) @@ -62,31 +84,48 @@ The Find Panel provides a pop-up version of the Find Toolbar that can be left op ### In-Dialog Node Editor -Freeplane nodes and node elements can be edited "in-line" or "in dialog". Editing nodes in-line means to edit them directly in the map. This is the most common way to edit nodes. To edit nodes or node elements in dialog means to edit them in a pop-up window that offers more editing options and controls. +Freeplane nodes and node elements can be edited "in-line" or "in dialog". +Editing nodes in-line means to edit them directly in the map. +This is the most common way to edit nodes. +To edit nodes or node elements in dialog means to edit them in a pop-up window that offers more editing options and controls. -Freeplane uses an editor called [SimplyHTML](https://sourceforge.net/projects/simplyhtml/). It is a basic editor with some drawbacks (such as limited support for keyboard controls), but the team does not currently have the capacity to update it or integrate a different editor with Freeplane. Offers to help on this front are welcomed. +Freeplane uses an editor called [SimplyHTML](https://sourceforge.net/projects/simplyhtml/). +It is a basic editor with some drawbacks (such as limited support for keyboard controls), but the team does not currently have the capacity to update it or integrate a different editor with Freeplane. +Offers to help on this front are welcomed. (to be added) ### Map context menu (right-click menu) -Right-click a free space in the background to open the so-called **Background Context Menu** . In this menu you can activate or deactivate the "menu bar", "tool bar", "filter bar", F-key bar and "icon bar" +Right-click a free space in the background to open the so-called **Background Context Menu**. +In this menu you can activate or deactivate the "menu bar", "tool bar", "filter bar", F-key bar and "icon bar" (to be added) ### Node context menu (right-click menu) ## View options + ### To view or hide workspace elements + ### Zoom + ### View settings + ## Navigating the interface with the keyboard + ## Working with map windows + ### Activating maps / moving between maps + ### Creating map windows + ### Arranging map windows + ### Split views + ## Hotkeys + ### Understanding hotkeys ### Customizing hotkeys @@ -97,4 +136,4 @@ Right-click a free space in the background to open the so-called **Background Co ## Other resources -### Videos \ No newline at end of file +### Videos From 1804224e23298a3e499d83f9b6dcdcfcea5f36fc Mon Sep 17 00:00:00 2001 From: Ofossum Date: Tue, 12 Apr 2022 23:38:55 +0200 Subject: [PATCH 5/6] rearranged understanding-nodes.md with newline per sentence --- understanding-nodes.md | 64 ++++++++++++++++++++++++++++++------------ 1 file changed, 46 insertions(+), 18 deletions(-) diff --git a/understanding-nodes.md b/understanding-nodes.md index 92a8662..1ecc744 100644 --- a/understanding-nodes.md +++ b/understanding-nodes.md @@ -3,17 +3,22 @@ ## Node elements ### Overview -Nodes are the fundamental element of mindmaps. Although nodes appear simple at first, they have many optional elements that can increase their functionality. +Nodes are the fundamental element of mindmaps. +Although nodes appear simple at first, they have many optional elements that can increase their functionality. -What appears to be the whole node at first is actually just the [node core](glossary.md#node-core). If you create a new node and begin typing, the text is entered in the node core by default. Beginning users generally limit their use of nodes to the node core. +What appears to be the whole node at first is actually just the [node core](glossary.md#node-core). +If you create a new node and begin typing, the text is entered in the node core by default. +Beginning users generally limit their use of nodes to the node core. Additional information can be stored in nodes outside the core as node details, node notes, and node attributes. ### Node core -The node core is the only part of the node that is always visible whenever the node itself is visible. The node core can itself contain several types of information: text (including numbers), icons, images, and links. +The node core is the only part of the node that is always visible whenever the node itself is visible. +The node core can itself contain several types of information: text (including numbers), icons, images, and links. -The text in the node core can be interpreted or parsed by Freeplane in different ways, which can be set in the Format Panel drop-down menu `Core text->Format`. To understand the implications of this setting, see (to be added). +The text in the node core can be interpreted or parsed by Freeplane in different ways, which can be set in the Format Panel drop-down menu `Core text->Format`. +To understand the implications of this setting, see (to be added). ### Node Details @@ -25,14 +30,25 @@ The text in the node core can be interpreted or parsed by Freeplane in different ### Connectors -Unlike edges, connectors must be added manually, one by one. To add a connector, select two nodes, `right-click` for a context menu and select `Connect (Ctrl+L)`. Another way is to `Ctrl+Shift + drag` one node onto another. On some systems it's also possible to `right-click + drag` one node onto another. +Unlike edges, connectors must be added manually, one by one. +To add a connector, select two nodes, `right-click` for a context menu and select `Connect (Ctrl+L)`. +Another way is to `Ctrl+Shift + drag` one node onto another. +On some systems it's also possible to `right-click + drag` one node onto another. ![connectors](images/connectors.gif) -Connectors' properties can be edited. When you `right-click` a connector (it's best to select one of the connected nodes first), a **Connector** dialog appears. Here you can set formatting properties individually or select a Style (or both), set labels' text and remove the connector. - -By default, a connector's shape is `Curve`. The other options are `Line`, `Linear path` and `Simulate edge`. The last one does exactly that: simulates an edge between the nodes. The other 3 types' shape can be changed using curve-shaping of either end.
-To change the shape of a connector, click on the line near a node (it's best to select the node first). You will see handles appear. By dragging your mouse up to ~50% of the distance between the nodes, the near handle is adjusted. Going beyond ~50% or clicking near the middle adjusts both handles at once. +Connectors' properties can be edited. +When you `right-click` a connector (it's best to select one of the connected nodes first), a **Connector** dialog appears. +Here you can set formatting properties individually or select a Style (or both), set labels' text and remove the connector. + +By default, a connector's shape is `Curve`. +The other options are `Line`, `Linear path` and `Simulate edge`. +The last one does exactly that: simulates an edge between the nodes. +The other 3 types' shape can be changed using curve-shaping of either end.\ +To change the shape of a connector, click on the line near a node (it's best to select the node first). +You will see handles appear. +By dragging your mouse up to ~50% of the distance between the nodes, the near handle is adjusted. +Going beyond ~50% or clicking near the middle adjusts both handles at once. You'll often need to repeat your click-drag-release several times before you get the expected result, i.e. without affecting the far end. #### Same-node connectors @@ -40,27 +56,37 @@ You'll often need to repeat your click-drag-release several times before you get Both ends of a connector can be attached to the same node, looping back to itself. To create such a connector, `right-click` a single node and select `Connect (Ctrl+L)` or use any of the other methods described above. -When using `Line` as the type, the connector appears one-ended. `Line` is often used to draw an arrow going out of a node into empty space (as seen in Freeplane `Help->Tutorial`). +When using `Line` as the type, the connector appears one-ended. +`Line` is often used to draw an arrow going out of a node into empty space (as seen in Freeplane `Help->Tutorial`). #### Connector styles -Connectors, just like nodes, use styles. See [Styles](styles.md) for more information. +Connectors, just like nodes, use styles. +See [Styles](styles.md) for more information. -When a connector is added, a style is applied to it, which determines how the connector looks like. By default, it's the **Default** style. There's an option to apply a style based on the connector style defined on the source or the target node. To use it, turn it on in `Preferences (Ctrl+COMMA)->Defaults->Connectors->Assigns node dependant styles to new connectors`. -If the source node has a style applied which has a connector style defined, the style is applied to the connector. Otherwise, the target node is checked for the same. +When a connector is added, a style is applied to it, which determines how the connector looks like. +By default, it's the **Default** style. +There's an option to apply a style based on the connector style defined on the source or the target node. +To use it, turn it on in `Preferences (Ctrl+COMMA)->Defaults->Connectors->Assigns node dependant styles to new connectors`. +If the source node has a style applied which has a connector style defined, the style is applied to the connector. +Otherwise, the target node is checked for the same. ## Types of nodes In addition to standard nodes, there are some special types of nodes: ### The root node -Every mind map begins with a central node call the root node. Node levels are defined based on their distance from the root node. +Every mind map begins with a central node call the root node. +Node levels are defined based on their distance from the root node. ### Free nodes -Free nodes are nodes that appear separate from the map hierarchy. They are "free" because they can be freely positioned around the map. They are not automatically positioned like other nodes and they generally do not affect other nodes when they are changed or moved. +Free nodes are nodes that appear separate from the map hierarchy. +They are "free" because they can be freely positioned around the map. +They are not automatically positioned like other nodes and they generally do not affect other nodes when they are changed or moved. -Note: although free nodes are positioned independently, technically, they are first-level nodes that are invisibly connected to the root node. You can add children, parents, or siblings to free nodes, but you may get unexpected behaviors. +Note: although free nodes are positioned independently, technically, they are first-level nodes that are invisibly connected to the root node. +You can add children, parents, or siblings to free nodes, but you may get unexpected behaviors. Technically, a free node is simply a node with three features: @@ -74,8 +100,10 @@ Other nodes can also be given the style `Floating node` and can be set to be pos ### Node groups #### Summary nodes -Summary nodes have brackets that suggest that their content summarizes a group of sibling nodes. Technically, summary nodes are specially marked sibling nodes of the summarized -nodes. Summary nodes can include other summary nodes within their brackets, creating the impression of a "reverse" map with branches joining rather than splitting. +Summary nodes have brackets that suggest that their content summarizes a group of sibling nodes. +Technically, summary nodes are specially marked sibling nodes of the summarized +nodes. +Summary nodes can include other summary nodes within their brackets, creating the impression of a "reverse" map with branches joining rather than splitting. Summary node brackets are unusual in that, unlike most Freeplane elements, their appearance is not (currently) customizable. From 819efe0f649eaf8697548e3eb79390d222601850 Mon Sep 17 00:00:00 2001 From: Ofossum Date: Tue, 12 Apr 2022 23:40:02 +0200 Subject: [PATCH 6/6] rearranged working-w-mindmap-files.md with newline per sentence --- working-w-mindmap-files.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/working-w-mindmap-files.md b/working-w-mindmap-files.md index 42fa756..ff082cb 100644 --- a/working-w-mindmap-files.md +++ b/working-w-mindmap-files.md @@ -2,19 +2,28 @@ ## Create a new map -Create a new map with `File->New map (Ctrl+N)`. This creates a new map using the default template. +Create a new map with `File->New map (Ctrl+N)`. +This creates a new map using the default template. -Create a new map from a different template with `File->New map from template…`. This opens a file picker that lets you choose a template to use to create a new map. +Create a new map from a different template with `File->New map from template…`. +This opens a file picker that lets you choose a template to use to create a new map. -Create a new password-protected map with `File->New protected (encrypted) map…`. This opens a password dialog used to encrypt a new map created using the default template. Encrypted maps cannot be opened or read without the password. +Create a new password-protected map with `File->New protected (encrypted) map…`. +This opens a password dialog used to encrypt a new map created using the default template. +Encrypted maps cannot be opened or read without the password. ## Open maps -Open an existing map with `File->Open mind map… (Ctrl+O)`. This opens a file picker to let you chose a Freeplane `.mm` map file to open. In this dialogue you can also choose standard or user-defined template-mindmaps from the dropdown-menu at the bottom (see [Templates](templates.md)). +Open an existing map with `File->Open mind map… (Ctrl+O)`. +This opens a file picker to let you chose a Freeplane `.mm` map file to open. +In this dialogue you can also choose standard or user-defined template-mindmaps from the dropdown-menu at the bottom (see [Templates](templates.md)). -Open an existing map from a list of recently opened maps with `File->Open recent map...`. Hovering over this Menu action shows a list of recently opened maps. Click on any map on this list to open it. +Open an existing map from a list of recently opened maps with `File->Open recent map...`. +Hovering over this Menu action shows a list of recently opened maps. +Click on any map on this list to open it. -If you have Autosave enabled, you can open an autosaved version of an existing map with `File->Open older version`. See [Autosave](#Autosave) for more information. +If you have Autosave enabled, you can open an autosaved version of an existing map with `File->Open older version`. +See [Autosave](#Autosave) for more information. ## Close maps @@ -53,7 +62,9 @@ The preferences you can set are: ## Import -The `File->Import` menu has two types of functions. One is importing map branches from other Freeplane maps into an active map. The other is importing content from non-Freeplane maps into an active map. +The `File->Import` menu has two types of functions. +One is importing map branches from other Freeplane maps into an active map. +The other is importing content from non-Freeplane maps into an active map. ### Importing Freeplane map branches into an active map