metanorma / mn-samples-plateau

Project PLATEAU by MLIT: Japanese Ministry of Land, Infrastructure, Transport and Tourism (国土交通省)
https://www.mlit.go.jp/plateau/
1 stars 0 forks source link

Replace all the "参考" ("reference") and "出典" ("source") #32

Closed ronaldtse closed 3 months ago

ronaldtse commented 3 months ago

We need to generate them with proper semantics so we need to encode them.

Source

For "source", we need to link them back to the bibliography like we do with terms.

001 Table

|===
...
| 58 | 個人
| 59 | その他

|===

出典:河川基盤地図ガイドライン(案)、国土数値情報、サイバーポート

001 Text:

アピアランスとは、地物の表面の外観に関する情報である。[出典:OGC City Geography Markup Language (CityGML) EncodingStandard]

002 Image source:

.縦断図の例
image::images/372.webp.png[]

出典:国道13号 大鍋トンネル 設計図( https://www.thr.mlit.go.jp/road/kouji/kouji-tunnel/24_R13_oonabe/data_05_.pdf[])

Solution

Metanorma already supports the ISO DIR 2 "SOURCE", so we can do:

|===
| table
|===

[.source]
<<ISO_6709>>

Reference

For "reference", which is somewhat a "fuzzy link" because the relationship is uncertain, e.g.:

001 Text with reference:

カーテンウォールはbldg:WallSurfaceにより表現する。カーテンウォールとは、建築物の外側に配置され、建築物を囲む非耐荷重の壁である。 +
[参考 ISO 6707-1:2020 Buildings and civil engineering works — Vocabulary — Part 1: General terms]
...

001 Table with reference:

|===
...
| some table
| 27 | 膜構造
| 28 | その他
| 9020 | 不明

|===

参考:OGC CityGML2.0 AnnexC.1及びISO6701-1

002 List content with reference:

. ② 前項で作成した各面を境界とする立体を作成する。
+
建築物モデル(LOD2)の作成については、以下の技術レポートを参考にできる。 +
参考「AI等を活用したLOD2自動生成ツールの開発及びOSS化 技術検証レポート」 +
( https://www.mlit.go.jp/plateau/libraries/technical-reports/)

Solution

Metanorma does not yet support "REFERENCE". We need a way to represent it...

Maybe something like this?

|===
| table
|===

[.reference]
<<ISO_6709>>

Ping @opoudjis .

ReesePlews commented 3 months ago

@ronaldtse what "word" will these be replaced with?

ronaldtse commented 3 months ago

(Moved content to OP)

ReesePlews commented 3 months ago

@ronaldtse

"参考" ("reference") = [.reference] this would be an enhancement...

"出典" ("source") = [.source] implemented in metanorma

in discussion with the client, we can use "出典" ("source") = [.source] only.

that will be sufficient. therefore, the "参考" ("reference") = [.reference] is not needed.

opoudjis commented 3 months ago

If you want this, you are not going to get [.reference]. I will not introduce a completely separate markup rule for one ill-defined flavour, and with deliberately unspecified semantics. Metanorma is unmaintainable enough as is with its existing proliferation of markup.

If this is still desired, it is going to be [.source,type=reference], because this is a still a source.

ReesePlews commented 3 months ago

hello @opoudjis thank you for the note. in my discussion with the client, it will be enough to use only the [.source] construct and no enhancement is needed.

so all of these "参考" will need to be changed manually to [.source] in the document and the appropriate characters to display for [.source] are: "出典"

i hope that is clear. if not let me know and i will discuss with @ronaldtse. still learning the correct vocabulary here to describe these support issues.

the main takeaway is that no enhance will be needed.

opoudjis commented 3 months ago

Ok. Just saying that if this changes, that's how it will be handled, as [.source,type=...] instead of [.reference]. But in general, the less idiosyncrasy, the better for these documents...

ReesePlews commented 3 months ago

thank you @opoudjis my understanding is that the [.source] is already and implemented construct in metanorma. if that is not correct please let me know. it seemed that an enhancement to support something new is not needed.

ronaldtse commented 3 months ago

@ReesePlews has clarified with the client:

So there's no enhancement needed.

ronaldtse commented 3 months ago

The first part of this work is done in #30; all references are now in Metanorma syntax referencing an "anchor", although those anchors do not exist yet.

Therefore the next task is to ensure the bibliographic items are encoded with the correct anchors.