Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

規則文記述フォーマットの策定 #5

Open
Crow314 opened this issue Nov 30, 2023 · 20 comments
Open

規則文記述フォーマットの策定 #5

Crow314 opened this issue Nov 30, 2023 · 20 comments
Assignees

Comments

@Crow314
Copy link
Contributor

Crow314 commented Nov 30, 2023

About

機械可読性と人間にとっての可読性を両立したフォーマットの仕様を策定する

Why

  • 機械可読性の必要性
    • 改定による差分の管理
    • 印刷用データの組版
    • 規則案作成補助ツールの作成
  • 人間への可読性の必要性
    • ツールに依らない規則の閲覧及び規則案作成
      • 閲覧者又は規則案作成者が特殊なフォーマットを理解できるとは限らない
@toririm
Copy link

toririm commented Dec 5, 2023

toml

@eniehack
Copy link
Member

eniehack commented Jan 30, 2024

schema記述はrelax-ngの軽量構文によって行うこととしよう

https://relaxng.org/

@eniehack
Copy link
Member

eniehack commented Jan 30, 2024

ただ、私自身法令文に明るくないため構造(n条のmがどうこうという話が以前上がった記憶がある)がどうあるべきかとかはようわからんな
国の法令の構造に従う必要がなければ、適当に設計するけど

@Crow314
Copy link
Contributor Author

Crow314 commented Jan 31, 2024

近いものとしてはe-govにXMLスキーマが載っていたはずではある
多少違いはあれど参考にはなりそう

@eniehack
Copy link
Member

relax-ngのvalidatorであるjingをGitHub Actionsに乗せられるとうれしい

@eniehack
Copy link
Member

将来的にはcsv、tsvやxlsxからXMLが作れるとうれしい

@Crow314
Copy link
Contributor Author

Crow314 commented Feb 12, 2024

FYI
https://x.com/puripuri2100/status/1757062437629759884
https://elaws.e-gov.go.jp/file/XMLSchemaForJapaneseLaw_v3.pdf

@toririm
Copy link

toririm commented Feb 12, 2024

最初は十分すぎるくらいに情報を持った(=細かすぎる)スキーマにしておけば後で情報落とす分には問題なさそう

@toririm
Copy link

toririm commented Feb 12, 2024

機械可読性と人間にとっての可読性を両立した

これTOMLだと思う。XML、人が読むものではない。

@eniehack
Copy link
Member

これTOMLだと思う。XML、人が読むものではない。

いいえ。例えXMLがヒトにとって可読性が低いものであったとしても、TOMLがその代替になりうるかと言えばノー。
理由として規則文は長い文字であることが考えられる(設定ファイルと比べたときにAPI Keyより長い文字列が規則文においては容易に想像付くでしょう)。
その他にもTOMLは込み入った仕様があるように思えるし情報が少ないので。

@eniehack
Copy link
Member

最初は十分すぎるくらいに情報を持った(=細かすぎる)スキーマ

細かすぎるスキーマどうやって作るんだろうか
未来のニーズをあれこれ考え、何が必要であるかを列挙することは難しい。

@eniehack
Copy link
Member

たぶん、ユーザフレンドリーなもの(ここにおけるユーザとはプログラミングや情報リテラシに明るくないひとびとのことを指す)はExcelファイルかcsvだと思うので、そこを始点にHTMLとXMLを生成すれば取り回しが効くと思われる

@eniehack
Copy link
Member

方法1

  1. フォーマットに沿って規則や条文番号を書く(Excel上)
  2. tkinter製ソフトウェアでHTMLに変換
  3. HTMLをcommit

方法2:

  1. フォーマットに沿って規則や条文番号を書く(Excel上)
  2. xlsxかcsvのいずれかをgitに登録する
  3. GitHub Actions上で、PythonのCLIで動作するソフトウェアを動作させ、HTMLに変換しGitHub Pagesにデプロイする

@eniehack
Copy link
Member

方法1はデバッグ時に使いやすいが、生成物をGitに登録するのが微妙、方法2は方法1の微妙な点は解消されているものの、xlsxをGitに登録するのが微妙というのがあるな

@eniehack
Copy link
Member

xlsx(Excelで作る)→csv(ソフトウェアでxlsxから変換されて作られる、gitに登録する用)→html(Actionsで生成される)とかがよさそうか

@eniehack
Copy link
Member

tkinterもCLIもインタフェースに過ぎないので共通部分が出せそうだな

@eniehack
Copy link
Member

WindowsではデフォルトでPythonが動かないことも見越して、packagingまでやりたさ

@eniehack
Copy link
Member

(ところで、Gitが必要な時点でGitを扱う人が必要であり、Gitを扱う人のPCにはPythonが入っていそうなものだが……)

@eniehack
Copy link
Member

eniehack commented Apr 25, 2024

対面でも言ったような気がしますが、これ本当に使いますか?使える人はいますか?今年度ですら使われるか怪しいと思うのですが
それよかは段階的に、例えばサイトの公開から始めるなど、やるべきことはあるような気がしますが

@toririm
Copy link

toririm commented Apr 26, 2024

あまりにも正しい。まずはサイトの公開

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants