Skip to content

slack qa team 2020 03 19

akabeko edited this page Apr 19, 2020 · 1 revision

2020-03-19

Time (UTC) Icon Name Message
02:04 shinyu 小形さんから「Vivliostyle」という名前が何を指すのかが分かりづらいと指摘されました。
それで考えたことがこの提案です:
https://vivliostyle.slack.com/archives/CNN5GPF9V/p1584583392054900
提案:
• Vivliostyle Core + Viewer の monorepo のリポジトリ名を「vivliostyle」から「vivliostyle.js」に再変更する。
• 「Vivliostyle.js」という名前をブラウザ上で動く Vivliostyle プログラム(Core と Viewer)の総称として使う。
• Vivliostyle のダウンロードパッケージのファイル名を vivliostyle-js-latest.zip, vivliostyle-js-canary.zip, vivliostyle-js-v2.0.0.zip などにする。

理由:
• 「Vivliostyle」という名前は、Vivliostyle CLI や Vivliostyle Pub も含む Vivliostyle ファミリーの総称であるべきだが、Core+Viewer の名前が「Vivliostyle」では混乱する。
• 過去のリリースノート内での issue へのリンクなどが、vivliostyle.js→vivliostyle の GitHub リポジトリのURL変更でリンク切れになっていた。vivliostyle.js に戻せばリンクが復活。
• vivliostyle.js→vivliostyle の変更してからの vivliostyle リポジトリ <https://github.com/vivliostyle/vivliostyle> へのリンクは、vivliostyle.js にリポジトリ名の再変更をしたら自動的に <https://github.com/vivliostyle/vivliostyle.js> にリダイレクトされるはず。
• 「.js」が名前についていることで、これが(ブラウザ上の)JavaScript 環境で動くプログラムであることが分かってよい。
• Vivliostyle と同類(ブラウザ上で動く JavaScript による CSS 組版エンジン)の OSS プロジェクトである Paged.js を知る人たちに、「Vivliostyle.js」のことも認識してもらうのに好都合。
02:04 Kiara Translation 🇬🇧: Mr. Ogata pointed out that it was difficult to understand what the name "Vivliostyle" refers to.
So what I thought is this suggestion:
https://vivliostyle.slack.com/archives/CNN5GPF9V/p1584583392054900
02:20 shinyu ソースコードはTypeScriptなのに名前に “.js” が付くのは不自然かとも考えたのですが、ビルド結果はJavaScriptなのでOKでしょう。

名前に “.js” が付くTypeScriptで書かれたプログラムがほかにないか探したら次のものがありました:
TensorFlow.js https://github.com/tensorflow/tfjs
A WebGL accelerated JavaScript library for training and deploying ML models.
02:20 Kiara Translation 🇬🇧: Though the source code is TypeScript, I thought it was unnatural to add “.js” to the name, but since the build result is JavaScript, it will be OK.

Looking for other programs written in TypeScript that have “.js” in their names, I found the following:
TensorFlow.js https://github.com/tensorflow/tfjs
02:53 ogwata 「vivliostyle.js」へリポジトリ名を改称しようという件、別の角度から補足します。

GitHubのリポジトリを基準に考えると、現在の「Vivliostyle」というのは、下記のように整理できると思います。

02:53 Kiara Translation 🇬🇧: Supplement from another angle, renaming the repository name to "vivliostyle.js".

Considering the GitHub repository, the current “Vivliostyle” can be organized as follows.

                           
07:51 ogwata @spring-raining さん
ただ今、「使ってみる」における Vivliostyle CLI の原稿を書いています。
https://vivliostyle-org.yamasy1549.now.sh/ja/getting_started/

以下ですが、なにか間違いはないでしょうか。確認をお願いします。

Vivliostyle CLI (v2.0.0)

コマンドラインから CSS 組版をして表示します。PDFに出力でき、印刷入稿可能なPDF/X-1a もサポートします。

インストール方法
• <https://www.ghostscript.com/
07:51 Kiara Translation 🇬🇧:  San
Right now, I am writing a manuscript for the Vivliostyle CLI in Getting Started.
https://vivliostyle-org.yamasy1549.now.sh/ja/getting_started/

Below is something wrong? Please check.

* Vivliostyle CLI (v2.0.0)

Displays the CSS formatted from the command line. PDF / X-1a, which can be output to PDF and printable, is also supported.

How to install *
• Installation of <https://www.ghostscript.com/
07:55 spring-raining そうですねー PDF/X-1aの案内はむしろpress-readyのREADMEに任せてしまったほうが良いかもしれないです https://github.com/vibranthq/press-ready
🚀 Make your PDF compliant with press-ready PDF/X-1a.
07:55 Kiara Translation 🇬🇧: Well, it may be better to leave the guidance of PDF / X-1a to the README of press-ready https://github.com/vibranthq/press-ready
07:55 spring-raining また、--press-ready を使わない場合ghostscriptやxpdfを使わないのでそのことも明記されていると誤解が少なそうです
07:55 Kiara Translation 🇬🇧: Also,
08:02 ogwata お返事感謝、改訂してみます!
08:02 Kiara Translation 🇬🇧: Thanks for your reply, I will revise it!
09:01 ogwata @uetchy さん。
ただ今新サイト「使ってみる」での Vivliostyle CLI に関するテキストを書いています。それに関して質問です。

CLI における PDF/X-1a 出力について、「使ってみる」では簡単に出力可能なことを述べるに止め、要件については press-ready のREADMEへのリンクですませようと思っています。

他方、私が Vivliostyle CLI で PDF / X-1a 出力を試した際、pdffonts が必要である旨のエラーが出て、これが含まれる Xpdf のインストールが必要になりました(キャプチャ参照)。

しかし、press-readyのREADMEでは、Xpdf が必要なのは Heroku 上で動かすときのみと書いてあるように思います。
https://github.com/vibranthq/press-ready/blob/master/README.ja.md#advanced-usage

正しいのはどちらなのでしょう?
https://vivliostyle.slack.com/files/UJS3RCS86/F010B4ZPTRT/____________________________2020-03-19_17.44.31.png
09:01 Kiara Translation 🇬🇧:  San.
I'm writing a text about Vivliostyle CLI on the new site "Try it now". I have a question about that.

Regarding PDF / X-1a output in CLI, "Try it out" only states that it can be easily output, and I will try to link the requirements to the press-ready README.

On the other hand, when I tried PDF / X-1a output with Vivliostyle CLI, I got an error saying that pdffonts was required, and I needed to install Xpdf, which included it (see capture).

However, the press-ready README states that Xpdf is only required when running on Heroku.
https://github.com/vibranthq/press-ready/blob/master/README.ja.md#advanced-usage

Which is correct?
09:21 ogwata @spring-raining さん、改訂してみました。

------
Vivliostyle CLI (v2.0.0)

• コマンドラインから CSS 組版をして表示します。PDF に出力できます。
• v2において press-ready をマージしたことにより、PDF/X-1a 出力がサポートされました(本機能には <https://www.ghostscript.com/
09:21 Kiara Translation 🇬🇧:  I tried to revise it.

------
* Vivliostyle CLI (v2.0.0) *

• Display and format CSS from the command line. You can output to PDF.
• PDF / X-1a output is supported by merging press-ready in v2. (This feature is available for <https://www.ghostscript.com/
10:56 uetchy モチベーションに賛成しますが、Vivliostyle CoreとViewerはnpmの @vivliostyle/core@vivliostyle/viewer と一対一で対応しているので、Vivliostyle.jsに改称するとその辺りに統一性が生まれなくなる懸念があります。
さらに、GitHub上の名前空間が vivliostyle.js/packages/core になるため Vivliostyle Core という名称との不一致を引き起こします。
仮に改称を検討する場合でも、名前に[.]が入っているとシステムの要件でドットが使えない場合に代替表記をしないといけなくなり非常に面倒なので TF に倣って vivliostylejs とした方が良いです。
10:56 Kiara Translation 🇬🇧: I agree with motivation, but Vivliostyle Core and Viewer have a one-to-one correspondence with @ vivliostyle / core and @ vivliostyle / viewer of npm, so renaming it to Vivliostyle.js will create uniformity around that There is concern that it will go away.
In addition, the namespace on GitHub will be vivliostyle.js / packages / core, causing a conflict with the name Vivliostyle Core.
Even if you consider renaming, if [.] Is included in the name, if the dot cannot be used due to the requirements of the system, it will be necessary to substitute notation, so it is very troublesome, so it is better to use vivliostylejs according to TF Is good.
13:23 shinyu GitHubリポジトリ名を vivliostyle.js に戻すデメリットもあること分かりました。しかし、そうしないことのデメリットも大きいと思います。

Vivliostyle Core の組版エンジンは多くのissueが残っていて、それらを調べるのに過去の変更を追うことが役にたちます。しかし、リリースノートや、issues/pulls/commitsのコメントからのリンクの多くが404エラーになってしまい、それがとても不便になっています。

vivliostyle.js というリポジトリ名はあまり良いものでなかったとしても、他の名前にするよりも、Vivliostyle開発初期からのリポジトリ名を維持するメリットがあると思います。

「Vivliostyle CoreとViewerはnpmの @vivliostyle/core@vivliostyle/viewer と一対一で対応」ということと、GitHub上の名前空間は vivliostyle.js/packages/corevivliostyle.js/packages/viewer ということとで、何か問題が起きるのでしょうか?

ドットが使えない場合の代替表記としては、vivliostyle.jsvivliostyle-js に変えるという決まりでよいかと思います。
13:23 Kiara Translation 🇬🇧: It turned out that there was a disadvantage to reverting GitHub repository name to vivliostyle.js. However, I think the disadvantages of not doing so are significant.

Vivliostyle Core's typesetting engine has a lot of issues left, and it's helpful to keep track of past changes to examine them. However, many of the links from the release notes and comments in issues / pulls / commits resulted in 404 errors, which is very inconvenient.

Even if the repository name vivliostyle.js is not very good, I think it has the advantage of maintaining the repository name from the beginning of Vivliostyle development, rather than using another name.

`` Vivliostyle Core and Viewer correspond one-to-one with @ vivliostyle / core and` @ vivliostyle / viewer` of npm, and the namespace on GitHub is `vivliostyle.js / packages / core` and` vivliostyle. Does js / packages / viewer` cause any problems?

As an alternative notation when the dot cannot be used, I think that the rule of changing `vivliostyle.js` to` vivliostyle-js` should be fine.
13:36 shinyu GitHubリポジトリ名を vivliostyle から vivliostyle.js に再変更すると、リポジトリ名 vivliostyle のURLから vivliostyle.js にリダイレクトされるようになるはずです。monorepo化したあとのURLを使っているリンクでもリンク切れにならないので再変更にともなう問題はあまりないと思います。
13:36 Kiara Translation 🇬🇧: Renaming the GitHub repository from vivliostyle to vivliostyle.js should redirect you to vivliostyle.js from the URL with the repository name vivliostyle. Even if the link uses the URL after monorepo conversion, the link will not be broken, so I think that there is not much problem with re-change.
Clone this wiki locally