Skip to content

Commit

Permalink
feat: update description of multiple sources
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldtse committed Jul 10, 2024
1 parent 776d708 commit 304570a
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 11 deletions.
31 changes: 26 additions & 5 deletions author/topics/blocks/figures.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -397,12 +397,27 @@ image::logo.jpg[]

A figure block can incorporate an indication of its source.

To set this, the source is expected to be a bibliographical reference, just as
with term
sources [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.4.2].
As with term sources, multiple sources can be given
The source is expected to be a bibliographical
reference [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.4.2].

.Figure with source
Multiple sources can be given with separate `[.source]` blocks.

.Figure with a single source
======
[source,asciidoc]
--
[figure]
.Rice husk separation
====
image::logo.jpg[]

[.source]
<<iso1212>>
====
--
======

.Figure with multiple sources
======
[source,asciidoc]
--
Expand All @@ -418,8 +433,14 @@ image::logo.jpg[]
<<iso1213>>,
====
--
The first source will indicate it is "reformatted" as the text after the comma
is treated as the modification, while the second source will indicate it is
"modified" since there is a trailing comma but no description of modification.
======

NOTE: The mechanism for indicating source is identical for terminology sources
and table sources.

== SVG: re-mapping hyperlinks

Expand Down
42 changes: 37 additions & 5 deletions author/topics/blocks/tables.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -354,12 +354,35 @@ a large range of table formatting options. Search for `#table1`.

== Table sources

A table can incorporate an indication of its source,
which in Metanorma is expected to be a bibliographical reference, just as with
term sources [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.4.2].
Any such sources need to appear after the table, and before any notes which will also be
included in the table. As with term sources, multiple sources can be given for a table.
A table can incorporate an indication of its source.

The source is expected to be a bibliographical
reference [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.4.2].

Multiple sources can be given with separate `[.source]` blocks.

Any such sources need to appear *after the table*, and *before any notes* which
will also be included in the table.

.Table with a single source and a note
======
[source,asciidoc]
--
|===
| Head | Head
| Row | Row
|===
[.source]
<<iso1212>>
NOTE: Note 1
--
======

.Table with multiple sources and notes
======
[source,asciidoc]
--
|===
Expand All @@ -378,3 +401,12 @@ NOTE: Note 1
NOTE: Note 2
--
The first source will indicate it is "reformatted" as the text after the comma
is treated as the modification, while the second source will indicate it is
"modified" since there is a trailing comma but no description of modification.
======


NOTE: The mechanism for indicating source is identical for terminology sources
and figure sources.
11 changes: 10 additions & 1 deletion author/topics/sections/concepts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1296,6 +1296,9 @@ renders as
image::/assets/author/topics/document-format/section-terms/fig-term-single-source.png[Example of a single source tagged as modified]
====


===== Multiple sources

A term and definition can be sourced from multiple sources (in accordance with
ISO 10241-1). In this case each source should be entered in a separate
`[.source]` paragraph.
Expand All @@ -1309,10 +1312,16 @@ ISO 10241-1). In this case each source should be entered in a separate
<<ISO7301,section 3.2>>,
[.source]
<<ISO7302,section 3.10>>,
<<ISO7302,section 3.10>>
--
The first source will indicate it is "modified" since there is a trailing comma
but no description of modification.
====

NOTE: The mechanism for indicating source is identical for table sources
and figure sources.


===== Sourcing concepts from termbases

Expand Down

0 comments on commit 304570a

Please sign in to comment.