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

既存 theme のアップデート #34

Merged
merged 7 commits into from
Apr 8, 2021
Merged

Conversation

yamasy1549
Copy link
Member

create-vivliostyle-theme v0.3.0 (#31) や最近変わった VFM の記法に合わせて既存の theme をアップデートする。特に

@yamasy1549 yamasy1549 self-assigned this Apr 8, 2021
@yamasy1549 yamasy1549 marked this pull request as ready for review April 8, 2021 08:15
@yamasy1549
Copy link
Member Author

@MurakamiShinyu example/ に含まれていた原稿で、すでに使えなくなっている VFM 記法などを削除して書き換えました。確認お願いします 🙏

Comment on lines 137 to 180
$$
I_{D} = {0.549 (V_{GS} + 0.649)^2 - 3.389 (V_{GS} + 0.381) + 4.297 } \times 10^{-3}
$$
$$I_{D} = {0.549 (V_{GS} + 0.649)^2 - 3.389 (V_{GS} + 0.381) + 4.297 } \times 10^{-3}$$
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ディスプレイ数式の記法で $$...$$ を1行にまとめたのはなぜでしょう?

この $$...$$ の扱いが、現状 vfm で使われている remark-math はクセがあり、$$ だけの行で囲んだ場合にだけディスプレイ数式になり、$$...$$ を改行しないで書くとインライン数式になってしまいます。
参照: vivliostyle/vfm#18 (comment)

↓組版結果を見ると分数が縮小されているのはこのためです(インライン数式扱いなので分数は小さい)。


Screen Shot 2021-04-08 at 18 55 55


vfm 1.0 では基本的に MathJax を使う方向 vivliostyle/vfm#37 (comment) なので、 $$...$$ は改行しないでもディスプレイ数式になるはずだと思いますが、このような処理系の違いで違う結果にならないように、次の書き方をするのがよいと思います:

  • ディスプレイ数式は必ず $$ の前後で改行を入れる、
  • インライン数式はひとつだけの '$' で囲む

Copy link
Member Author

@yamasy1549 yamasy1549 Apr 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「次に図6の〜傾きを求める。[数式]逆数〜[数式]これをドレイン抵抗r_dとする。」までがひとつの段落というつもりで書いています。ディスプレイ数式を内包するかたちで<p>タグを付与してほしかったのでこうしています。

$ echo '傾きを求める。\n$$\nfrac{1}{2}\n$$\n逆数' | vfm --partial --hardLineBreaks

<p>傾きを求める。</p>
<div class="math math-display">...</div>
<p>逆数</p>
$ echo '傾きを求める。\n$$frac{1}{2}$$\n逆数' | vfm --partial --hardLineBreaks

<p>
  傾きを求める。
  <br>
  <span class="math math-inline">...</span>
  <br>
  逆数
</p>

本当はこんな↓出力が欲しいですが、現状はそうなっていません。

$ echo '傾きを求める。\n$$\nfrac{1}{2}\n$$\n逆数' | vfm --partial

<p>
  傾きを求める。
  <div class="math math-display">...</div>
  逆数
</p>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

現状のvfmでは $$ だけの行があると、その前後に空行がなくても段落(p要素)が終わってしまいますね。
vivliostyle/vfm#37 (comment) で提案した方法で MathJax を使うようにすれば、p要素の途中にディスプレイ数式が入ることになります。

なおHTMLの規則で、p要素の中にdiv要素は入れることができません。MathJax はディスプレイ数式をspan要素にしてspan要素を display: block にします。

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

了解です。では $$ 前後で改行して VFM 側の実装を待つことにします。

@@ -26,3 +26,31 @@
}
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/* cannot use named page */
// @page cover {

"cannot use named page" というコメントが残ってます。named page は実装されましたがここで使えませんか?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v2.7.0 で使えるようになってましたね! 使います

Comment on lines 54 to 56
@page :nth(2) {
counter-reset: p;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

通常の書籍では(左→右の横書きなら)左ページが偶数ページ、右ページが奇数ページですが、この academic の場合は、左右ページの扱いは不要というものなのですか?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

自分が書いてきたレポートは、奇数偶数ページによらずページ番号を中央に配置するよう指定されたものが多かったのでそうしています。学会誌も(分野によるかもしれませんが)中央だったり小口側だったり様々です。

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

そうですね。previewで見開きで見たとき左ページが奇数ページになったのでちょっと違和感あったのですが、そのようなレポートであれば見開きページ単位という概念がないので、たぶんそれでよいのでしょう。

},
],
vfm: {
hardLineBreaks: true,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hardLineBreaks: true, を使う理由は何ですか? 以前の VFM でデフォルトで hardLineBreaks: true 相当の動作だったのを直したのは理由があったことでした。 vivliostyle/vfm#50

このモードの使用はなるべく避けた方がよいのでないでしょうか。

Copy link
Member Author

@yamasy1549 yamasy1549 Apr 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#34 (comment) この挙動を得るために改行を<br>としていましたが、必要なくなったので修正します。

@yamasy1549
Copy link
Member Author

@MurakamiShinyu

https://github.com/vivliostyle/vivliostyle_doc/tree/gh-pages/samples/gutenberg/ の 3 つのサンプル (Alice, Fang, Sherlock) に合わせたテーマです。example/*.md でもなるべく元の HTML を使うようにしていますが、Markdown (VFM) で書き直したほうがよいでしょうか?

@MurakamiShinyu
Copy link
Member

https://github.com/vivliostyle/vivliostyle_doc/tree/gh-pages/samples/gutenberg/ の 3 つのサンプル (Alice, Fang, Sherlock) に合わせたテーマです。example/*.md でもなるべく元の HTML を使うようにしていますが、Markdown (VFM) で書き直したほうがよいでしょうか?

欧文の小説を書くためのテーマだとするのであれば、markdownに直した方がよいと思います。

もともとこのサンプルは、Project Gutenberg で公開されているコンテンツを利用したものです。

"Alice's Adventures in Wonderland" であれば、http://www.gutenberg.org/ebooks/11 にある HTML http://www.gutenberg.org/files/11/11-h/11-h.htm が元データです。ただし、Vivliostyle 用 HTML+CSS サンプルにするときに HTML マークアップは別のものに変わってます。したがって、"theme-gutenberg" だからといって、Project Gutenberg にあるコンテンツの HTML をこの theme で簡単に利用できるわけでもありません。

この theme を使って、新しい作品をマークダウンで書く、あるいは既存のテキスト(たとえば Project Gutenberg の作品のテキスト版、 http://www.gutenberg.org/files/11/11-0.txt など)に Markdown 記法を見出しなどに加えるとこの theme でちゃんとした欧文小説の体裁になるというほうが意味があるだろうと思います。

@yamasy1549
Copy link
Member Author

すみません、#32 にコメントしたと思っていたら間違えてこちらにコメントしてしまいました…… > #34 (comment)

Copy link
Member

@MurakamiShinyu MurakamiShinyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@yamasy1549 yamasy1549 merged commit e25674f into master Apr 8, 2021
@yamasy1549 yamasy1549 deleted the update-package-structure branch April 8, 2021 15:38
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

Successfully merging this pull request may close these issues.

#31 Update create-vivliostyle-theme に合わせて既存 theme のファイルの構造を変える
2 participants