Skip to content

Commit

Permalink
update for 2.5
Browse files Browse the repository at this point in the history
  • Loading branch information
infologie authored and Myllaume committed Oct 5, 2024
1 parent 9b43da6 commit 33e82e2
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions man/cosma.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.1.11.1
.\" Automatically generated by Pandoc 3.4
.\"
.TH "Cosma\[cq]s User manual" "" "2023\-12\-03" "" ""
.TH "Cosma\[cq]s User manual" "" "2023\-12\-03" ""
.SH NAME
cosma - document graph visualization
.SH DESCRIPTION
Expand Down Expand Up @@ -222,10 +222,10 @@ reinsert them the next time you use the file.
link type string
stroke Link type stroke style single (solid
stroke Link type stroke style simple (solid
line), dash
(dashed line),
dash (dotted
dotted (dotted
line), double
(two parallel
lines)
Expand Down Expand Up @@ -459,15 +459,15 @@ In accordance with the YAML specification, the list of keywords can be
written in \f[I]block\f[R] mode:
.IP
.EX
tags:
\- keyword 1
\- keyword 2
tags\f[B]:\f[R]
\f[B]\-\f[R] keyword 1
\f[B]\-\f[R] keyword 2
.EE
.PP
Or in \f[I]flow\f[R] mode:
.IP
.EX
tags: [keyword 1, keyword 2]
tags\f[B]:\f[R] \f[B][\f[R]keyword 1\f[B],\f[R] keyword 2\f[B]]\f[R]
.EE
.PP
\f[B]Why a YAML header?\f[R]
Expand Down Expand Up @@ -872,6 +872,8 @@ For nodes, only the \f[CR]title\f[R] metadata is required.
label Description of the link (optional). This description
is displayed in the context tooltips of the links.
type Type of the link (optional)
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.EE
.RE
Expand Down Expand Up @@ -919,7 +921,7 @@ In the example below, the \f[CR]custom.css\f[R] file contains
declarations that change the fonts used in the cosmoscope:
.IP
.EX
:root {
\f[BI]:root\f[R] {
\-\-sans: \[dq]IBM Plex Sans\[dq], sans\-serif;
\-\-serif: \[dq]IBM Plex Serif\[dq], serif;
\-\-mono: \[dq]IBM Plex Mono\[dq], monospace;
Expand Down Expand Up @@ -1092,7 +1094,7 @@ You can view and download this data in the cosmoscope by clicking on the
You can also access it from within the cosmoscope source code, under the
\f[CR]<article id=\[dq]citation\-references\[dq]>\f[R] tag.
.SS Treating references as graph nodes
When configuration setting \f[CR]citations_as_nodes\f[R] is set to
When configuration setting \f[CR]references_as_nodes\f[R] is set to
\f[CR]true\f[R], it modifies the behavior of the \f[CR]\-\-citeproc\f[R]
option of \f[CR]cosma modelize\f[R], making it so that bibliographic
references become nodes in the graph: each cited reference is treated as
Expand All @@ -1104,11 +1106,11 @@ records.
.PP
To use this feature, you must do three things:
.IP "1." 3
set \f[CR]citations_as_nodes\f[R] to \f[CR]true\f[R] in the
set \f[CR]references_as_nodes\f[R] to \f[CR]true\f[R] in the
project\[cq]s configuration;
.IP "2." 3
define a value for \f[CR]references_type_label\f[R] (this is a new
setting introduced alongside \f[CR]citations_as_nodes\f[R] in this
setting introduced alongside \f[CR]references_as_nodes\f[R] in this
release);
.IP "3." 3
create a record type with the same name as the value for
Expand All @@ -1117,13 +1119,24 @@ create a record type with the same name as the value for
For instance:
.IP
.EX
citations_as_nodes: true
references_as_nodes: true
references_type_label: \[dq]référence\[dq]
record_types:
référence:
stroke: \[dq]#6C6C6C\[dq]
fill: \[dq]#6C6C6C\[dq]
.EE
.PP
When references are treated as nodes, you can use link types on
citations.
Link types can only be used when citations are within brackets.
They must be the first string within the brackets, ending with a colon
\f[CR]:\f[R].
Example:
.IP
.EX
On writing as a technology of the intellect [cites as authority:\[at]goody1977, 46\-52]...
.EE
.SH USING THE COSMOSCOPE
.SS Layout
The cosmoscope is organised in three columns:
Expand Down

0 comments on commit 33e82e2

Please sign in to comment.