Skip to content

Commit

Permalink
update / correct feature description
Browse files Browse the repository at this point in the history
  • Loading branch information
nnako authored Sep 30, 2022
1 parent d588192 commit 06ab04d
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,42 @@ with Freeplane mindmap files, directly.

These are the main features of the package:

- create, read and modify Freeplane mindmaps<br>at least in theory, this package
- **create, read and modify Freeplane mindmaps**<br>at least in theory, this package
will not touch anything it does not know within an opened mindmap. so, you
can read big maps, change them where you like and save them without any
information loss.

- disregard version of Freeplane mindmap<br>even Freemind mindmaps should be
usable
- **transparent handling of different mindmap file versions**<br>different freeplane file
versions are handled seamlessly. even old Freemind mindmaps should work.

- find nodes within a mindmap<br>based on the node's id, core text, attributes,
details, notes, link or icons any node can be found within the mindmap
- **management of each node's creation and modification dates**<br>dates will be
translated into human-readable date strings. when creating or modifying nodes,
the correct dates will be set.

- navigate through the mindmap tree<br>based on parent and children methods it
is possible to reach every node
- **search and find nodes within a mindmap**<br>based on the node's id, core text,
attributes, details, notes, link or icons any node can be found within a mindmap
using the mindmap's or node's `find_nodes` or `find_children` methods.

- retrieve from and modify information from arbitrary nodes<br>core text / html, notes,
details, ...
- **navigate through the mindmap trees**<br>based on the node object's `parent`,
`children`, `next` and `get_child_by_index` attributes / methods it is possible
to reach every node from every starting point within the mindmap.

- create and modify node's attributes<br>core text / html, notes, details, ...
- **modify information within arbitrary nodes**<br>the original attributes of each
node (core text / html as `plaintext`, `notes`, `details`, `link`, `icons`, ...) can
be read and modified. by using the node's `set_attribute`, `get_attribute` and
`attribute` methods, the Freeplane' node attributes can be accessed.

- manage node links
- **manage node links**<br>hyperlinks between nodes within the same mindmap as well
as accross different mindmaps are dealt with by using the `hyperlink` attribute
of a node object.

- set and manage node styles
- **set and manage node styles**<br>in Freeplane, "styles" are used to set and manage
the design of nodes. using the `styles` attribute and the `add_style` attribute of
a map object or the `style` attribute of a node object, the management is done.

- create and manage arrow links
- **create and manage arrow links**<br>besides hyperlinks, "arrow links" can be used
to connect nodes on (this time on a visual level). the node object's
`add_arrowlink` method helps connecting nodes visually.

## installation

Expand Down

0 comments on commit 06ab04d

Please sign in to comment.