Skip to content

Commit

Permalink
fix/convert textual note/warnings to astro/starlight :::note
Browse files Browse the repository at this point in the history
  • Loading branch information
oxy86 committed Dec 10, 2024
1 parent 2d30d9d commit a1186b9
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 11 deletions.
12 changes: 9 additions & 3 deletions src/content/docs/manual/analysis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,9 @@ SocNetV uses the **Bron–Kerbosch algorithm** to find all **maximal cliques** i

![Clique census of Florentine families](/data/uploads/screenshots/22/socnetv-2.2-clique-census-florentine-families-report-1.png)

**Note:** The computation of **maximal cliques** can be slow in very large or dense social networks due to the **NP-complete** nature of the clique problem.
:::caution
The computation of **maximal cliques** can be slow in very large or dense social networks due to the **NP-complete** nature of the clique problem.
:::

---

Expand Down Expand Up @@ -767,7 +769,9 @@ For example, in the case of **Simple Matching**, the similarity matrix depicts t

These measures of similarity are particularly useful when ties are binary (not valued).

**Note:** In very sparse networks (with low density), measures such as exact matches, correlation, and distance will show little variation among the actors, making it difficult to classify the actors into structural equivalence classes.
:::note
In very sparse networks (with low density), measures such as exact matches, correlation, and distance will show little variation among the actors, making it difficult to classify the actors into structural equivalence classes.
:::

### Pearson Correlation Coefficients

Expand Down Expand Up @@ -803,4 +807,6 @@ The result of **Hierarchical Cluster Analysis** is the clusters per level and a

![Example dendrogram of HCA](/data/uploads/screenshots/22/socnetv-2.2-hca-results-2-dendrogram.jpg)

**Note:** The complexity of agglomerative clustering is $ O(n^2 \log n) $, which makes it too slow for large data sets.
:::caution
The complexity of agglomerative clustering is $ O(n^2 \log n) $, which makes it too slow for large data sets.
:::
25 changes: 18 additions & 7 deletions src/content/docs/manual/gui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,9 @@ Right-clicking on a node opens a context menu to:
- Add an edge.
- Change node properties (e.g., color, size, label).

> **Note**: All nodes are tagged with their node number by default. To display labels, enable the option in `Options -> Node -> Display Labels`.
All nodes are tagged with their node number by default. To display labels, enable the option in `Options` -> `Node` -> `Display Labels`.

> **Warning**: In large networks, finding specific nodes can be challenging. Use `CTRL+F` to search for nodes by number or label. Press `CTRL+F` again to undo the highlight.
In large networks, finding specific nodes can be challenging. Use `CTRL+F` to search for nodes by number or label. Press `CTRL+F` again to undo the highlight.

From the **Node Properties** dialog, you can:
- Enter a node label.
Expand All @@ -218,7 +218,9 @@ To select multiple nodes:
- All nodes inside the rectangle are selected.
- Right-click one of the selected nodes to edit all selected nodes together in the **Node Properties** dialog.

> **Warning**: In networks with thousands of edges, group selection may be slow.
:::caution
In networks with thousands of edges, group selection may be slow.
:::

---

Expand All @@ -231,8 +233,10 @@ By default:
- New links have a weight of `w = 1`.
- You can change the weight by right-clicking on the edge and selecting "Change Weight."

> **Note**: Edge widths are proportional to their weight using the formula:
:::note
Edge widths are proportional to their weight using the formula:
$ \text{width} = 1 + \log(1 + \log |weight|) $.
:::

You can also create edges using:
- **Right-click**: Select "Create Edge" and specify the source/target node and edge weight in the dialog.
Expand All @@ -245,7 +249,9 @@ Create a directed edge from Node 1 to Node 2:
- Middle-click on Node 2.
A new line appears, indicating the directed edge.

> **Note**: Clicking on an edge highlights its source and target nodes. Click again to undo the highlight.
:::note
Clicking on an edge highlights its source and target nodes. Click again to undo the highlight.
:::

---

Expand All @@ -258,9 +264,14 @@ A **relation** represents a specific type of tie between nodes.
- Add new relations using the `+` button in the toolbar.
- Navigate between relations using the arrow buttons in the toolbar.

> **Note**: While modifying multi-relational networks, you can add nodes but cannot remove them.
:::note
While modifying multi-relational networks, you can add nodes but cannot remove them.
:::

> **Warning**: SocNetV saves only the active relation when saving a network. Save other relations by switching to them and saving again.

:::caution
SocNetV saves only the active relation when saving a network to a format other than GraphML. To save all relations, use GraphML.
:::

---

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/manual/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Otherwise, if the package is just an macOS image disk (a file with a `.dmg` exte
You will see a new window with the SocNetV executable icon inside. Right-click on it and select Open to run the application.

:::note
Note: The first time you will run SocNetV, macOS may tell you that it cannot verify the software developer/publisher. That's because we do not sign our released packages with any code signing certificates (which are not free by the way).
The first time you will run SocNetV, macOS may tell you that it cannot verify the software developer/publisher. That's because we do not sign our released packages with any code signing certificates (which are not free by the way).
Please press Cancel, not Move to Bin! Then, right-click again on SocNetV app and select Open to run the application normally.
:::

Expand Down

0 comments on commit a1186b9

Please sign in to comment.