-
Notifications
You must be signed in to change notification settings - Fork 13
docs: 日本語版についてのセクションを追加 #329
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,25 @@ | ||
# Typst 日本語ドキュメント (非公式) | ||
# Typstドキュメント日本語版 | ||
|
||
[](https://github.com/typst-jp/docs/actions/workflows/website.yml) | ||
|
||
> [!NOTE] | ||
> For English version, please refer to [README.en.md](README.en.md). | ||
[Typst Documentation](https://typst.app/docs/)のコミュニティ主導の日本語版。 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 「非公式」という表現だけでは誤解を招く懸念があるため、「コミュニティ主導の」という表現にしています。 |
||
|
||
組版システム [Typst](https://typst.app/docs) の非公式な日本語ドキュメントです。[Typst GmbH](https://typst.app/legal/) の許諾を得て作成されています。 | ||
A community-driven Japanese translation of the [Typst Documentation](https://typst.app/docs/). | ||
|
||
このリポジトリは[中国語版](https://github.com/typst-doc-cn/typst-doc-cn.github.io)からフォークして作成され、2024年10月時点での最新版である [Typst v0.13.1](https://typst.app/docs/changelog/#v0.13.1) の公式ドキュメントを元に日本語訳を行います。 | ||
https://typst-jp.github.io/docs/ | ||
|
||
実際に作動している Web 版は、以下の URL から閲覧できます。 | ||
> https://typst-jp.github.io/docs/ | ||
プロジェクトの詳細は、[日本語版について](https://typst-jp.github.io/docs/about/)をご覧ください。 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. メンテナンスの観点でREADMEの内容は最低限とし、Webサイトの「日本語版について」に誘導する形に変更しました。 |
||
|
||
## 翻訳に参加するには | ||
For project details, please refer to [About the Japanese version](https://typst-jp.github.io/docs/about/). | ||
|
||
[貢献ガイドライン (CONTRIBUTING.md)](CONTRIBUTING.md) をご覧の上、[Pull Request](https://github.com/typst-jp/docs/pulls) を作成してください。[Issue](https://github.com/typst-jp/docs/issues)での質問や議論も歓迎します。 | ||
## 謝辞 | ||
|
||
ご質問などがある場合は、[「くみはんクラブ」のDiscordサーバー](https://discord.gg/9xF7k4aAuH)に参加してご連絡ください。 | ||
このプロジェクトは、上流の[typst/typst](https://github.com/typst/typst)を含めた全ての貢献者によって支えられています。 | ||
|
||
## 翻訳参加者 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. メンテナーの一覧表示を手動で管理するのはメンテナンスの観点で面倒なので、外部サービスを利用する形に変更しました。 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. コミットを伴わない貢献者の区分があるので、「日本語版について」のページに簡単なクレジット表記をする方針が良い気がします。 |
||
This project is supported by all contributors, including upstream [typst/typst](https://github.com/typst/typst). | ||
|
||
<table cellspacing="0" cellpadding="0"> | ||
<tbody> | ||
<tr> | ||
<td align="center"><a href="https://github.com/mkpoli"><img src="https://github.com/mkpoli.png" width="100px" alt="mkpoli"/><br /><sub><b>mkpoli</b></sub></a><br/><code>mkpoli</code><br/>言い出しっぺ<br/>保守者</td> | ||
<td align="center"><a href="https://github.com/3w36zj6"><img src="https://github.com/3w36zj6.png" width="100px" alt="3w36zj6"/><br /><sub><b>3w36zj6</b></sub></a><br/><code>3w36zj6</code><br/>インフラ整備<br/>保守者</td> | ||
<td align="center"><a href="https://github.com/stepney141"><img src="https://github.com/stepney141.png" width="100px" alt="stepney141"/><br /><sub><b>stepney141</b></sub></a><br/><code>stepney141</code><br/>インフラ整備<br/>保守者</td> | ||
<td align="center"><a href="https://github.com/gomazarashi"><img src="https://github.com/gomazarashi.png" width="100px" alt="gomazarashi"/><br /><sub><b>gomazarashi</b></sub></a><br/><code>gomazarashi</code><br/>翻訳者<br/>保守者</td> | ||
<td align="center"><a href="https://github.com/monaqa"><img src="https://github.com/monaqa.png" width="100px" alt="monaqa"/><br /><sub><b>monaqa</b></sub></a><br/><code>monaqa</code><br/>翻訳者<br/>保守者</td> | ||
</tr> | ||
<tr> | ||
<td align="center"><a href="https://github.com/kimushun1101"><img src="https://github.com/kimushun1101.png" width="100px" alt="Shunsuke KIMURA"/><br /><sub><b>Shunsuke KIMURA</b></sub></a><br/><code>kimshun1101</code><br/>翻訳者<br/>保守者</td> | ||
<td align="center"><a href="https://github.com/zr-tex8r"><img src="https://github.com/zr-tex8r.png" width="100px" alt="Takayuki YATO"/><br /><sub><b>Takayuki YATO</b></sub></a><br/><code>zr-tex8r</code><br/>アドバイザー</td> | ||
<td align="center"><a href="https://github.com/m1sk9"><img src="https://github.com/m1sk9.png" width="100px" alt="Sho Sakuma"/><br /><sub><b>Sho Sakuma</b></sub></a><br/><code>m1sk9</code><br/>校正者</td> | ||
<td align="center"><a href="https://github.com/ultimatile"><img src="https://github.com/ultimatile.png" width="100px" alt="ultimatile"/><br /><sub><b>ultimatile</b></sub></a><br/><code>ultimatile</code><br/>翻訳者<br/>保守者</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
<a href="https://github.com/typst-jp/docs/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=typst-jp/docs" /> | ||
</a> | ||
|
||
Made with [contrib.rocks](https://contrib.rocks). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
--- | ||
description: | | ||
翻訳ガイドライン | ||
--- | ||
# 翻訳ガイドライン | ||
|
||
[JTF日本語標準スタイルガイド 第3.0版]: https://www.jtf.jp/pdf/jtf_style_guide.pdf | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../CONTRIBUTING.md |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../TRANSLATING_GUIDELINES.md |
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,37 @@ | ||||||||
--- | ||||||||
description: Typstドキュメント日本語版について | ||||||||
--- | ||||||||
|
||||||||
# 日本語版について | ||||||||
|
||||||||
[Typst Japanese Community]: https://github.com/typst-jp/ | ||||||||
[Typstドキュメント日本語版]: https://typst-jp.github.io/docs/ | ||||||||
[くみはんクラブ]: https://discord.gg/9xF7k4aAuH | ||||||||
[Typst Documentation]: https://typst.app/docs/ | ||||||||
|
||||||||
「[Typstドキュメント日本語版]」は、組版全般の日本語での議論や情報交換のためのDiscordサーバー「[くみはんクラブ]」の有志によって構成された「[Typst Japanese Community]」が、[Typst GmbH](https://typst.app/legal/) の許諾を得た上でメンテナンスしている、Typstの公式ドキュメント「[Typst Documentation]」のコミュニティ主導の日本語版です。 | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. プロジェクトの成り立ちを知らない人向けの文章を想定していますが、良い言い回しがあればご指摘ください。 |
||||||||
|
||||||||
本プロジェクトは現在進行中のため、未翻訳の箇所や誤訳が残っている場合があります。また、情報が古くなることもあるため、バージョン情報にはご注意ください。ご利用の際は[Typst Documentation]の最新情報とあわせてご参照ください。 | ||||||||
|
||||||||
さらに、本Webサイトでは公式ドキュメントにはない、日本語の組版に特化した情報や独自コンテンツを提供しています。 | ||||||||
|
||||||||
本サイトの情報が、皆様のTypst利用の一助となれば幸いです。 | ||||||||
|
||||||||
## 貢献する | ||||||||
|
||||||||
本Webサイトはオープンソースで、どなたでもメンテナンスにご参加いただけます。翻訳の提案や誤字脱字の修正、Typstに関する日本語記事の追加など、さまざまな形での貢献を歓迎しています。詳しくは下記ガイドラインをご覧の上、[Pull Request](https://github.com/typst-jp/docs/pulls)の作成をお願いします。[Issue](https://github.com/typst-jp/docs/issues)でのご質問やご意見もお待ちしています。 | ||||||||
|
||||||||
- [貢献ガイドライン]($about/contributing) | ||||||||
- [翻訳ガイドライン]($about/translating-guidelines) | ||||||||
|
||||||||
ご不明な点があれば、[くみはんクラブ]のDiscordサーバーにてお気軽にご連絡ください。 | ||||||||
|
||||||||
## FAQ | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. プロジェクトの知名度が上がってきたことを踏まえて、追加で書いておくべきだと思われる内容があればご教示ください。 |
||||||||
|
||||||||
### 機械翻訳やLLMの性能が上がっている中で、なぜ人力で翻訳するのですか? | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 個人的にこのセクションは書いておきたいと考えていますが、良い文章の案はありますでしょうか? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Copilotの案が大体良さそうですが、それに加えてLLM関連サービスがウェブ検索して回答を作成するようになっていることから日本語ドキュメントを作成しておくと日本語の回答がより安定するという恩恵が受けられるという点があります。 |
||||||||
|
||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The first FAQ question about machine translation vs human translation is missing an answer. This leaves the FAQ section incomplete and unhelpful to users.
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||||
### Webサイトの生成ツールはOSSですか? | ||||||||
|
||||||||
はい。Webサイトの生成ツールは[typst-community/typst-docs-web](https://github.com/typst-community/typst-docs-web)で配布されており、Apache-2.0 licenseで利用可能です。 | ||||||||
|
||||||||
TypstのコンパイラとドキュメントはOSSですが、WebサイトはOSSではありません。そこで、コミュニティ主導でドキュメントのWebサイトの生成ツールを開発する必要がありました。OSSではないWebサイトのアセットを含まないため、Webサイトのデザインは独自のものとなっています。 |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,18 +7,10 @@ description: | | |
|
||
<div class="info-box"> | ||
|
||
**はじめに: Typst Japanese Communityより** | ||
|
||
日本語版Typstのドキュメントへようこそ! [Typst](https://typst.app/) はアカデミック・ライティング用途を念頭に開発された、TeXなどの今までのシステムを覆しうる革新的で多機能な組版エンジンです。もちろん、学術論文に限らず、雑誌や書籍の組版にも適しています。 | ||
|
||
このWebサイトは、[Typst GmbH](https://typst.app/legal/) の許諾を得て、非公式日本語コミュニティ「[Typst Japanese Community](https://github.com/typst-jp/)」のボランティアたちが[公式ドキュメント](https://typst.app/docs/)を翻訳したものです。まだ翻訳途上ですので、翻訳されていない部分や誤訳などがたくさんあり、また情報が古くなる可能性もあるため、ご了承ください。最新の情報は[公式ドキュメント](https://typst.app/docs/)をご覧ください。ただし、本Webサイトには、公式ドキュメントにはない日本語の組版に特化した情報やコンテンツも掲載される予定です。 | ||
|
||
皆様がTypstをご利用になる上で、本サイトの情報が一助になれば幸いです。 | ||
「Typstドキュメント日本語版」のプロジェクトの詳細は、[日本語版について]($about)をご覧ください。 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. READMEと同様にメンテナンスの観点で文章は最小限にしています。 |
||
|
||
</div> | ||
|
||
---- | ||
|
||
Typstは、学術用途のために新たに生まれたマークアップベースの組版システムです。LaTeXのような高度なツールや、WordあるいはGoogleドキュメントのような手軽なツールの両方に取って代わるものとして設計されています。私たちがTypstを通して目指しているのは、高機能 _かつ_ 使っていて楽しくなるような組版ツールを作ることです。 | ||
|
||
このドキュメントは、2つの部分に分かれています:実際の使用例を通じてTypstの使い方を学べる、初心者にやさしいチュートリアル。そして、Typstのあらゆる仕様・機能を扱った包括的なリファレンスです。 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
英語ドキュメントを別ファイルとして分離すると、内容が更新されずに放置される懸念があり、メンテナンスの観点で面倒なため、READMEに日本語と英語を併記する形に変更しました。