Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .textlintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,29 @@ module.exports = {
plugins: ["html"],
filters: {
comments: true,
allowlist: {
allow: ["/<(code|pre)[^>]*>[\\s\\S]*?</(code|pre)>/"],
},
},
rules: {
"preset-jtf-style": {
// デフォルトで無効のため
"2.1.5.カタカナ": true,
// デフォルトで無効のため
"2.1.6.カタカナの長音": true,
// デフォルトで無効のため
"2.2.1.ひらがなと漢字の使い分け": true,
// 階層構造を表現する記号としての>の使用例があるため
"4.3.7.山かっこ<>": false,
},
prh: {
rulePaths: ["./prh.yaml"],
checkLink: false,
checkBlockQuote: false,
checkEmphasis: true,
checkHeader: true,
checkParagraph: true,
checkCodeComment: [],
},
},
};
174 changes: 102 additions & 72 deletions bun.lock

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions crates/typst-library/src/foundations/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use crate::foundations::{
///
/// # 引数シンク
/// 組み込み関数と同様に、カスタム関数も可変長引数を受け取れます。
/// 余分にある引数をすべてまとめて受け取る _引数シンク_(キッチンシンクのようにさまざまなものが流れ込む先)は、`..sink`の形で指定できます。このとき生成される`sink`の値は`arguments`型になります。この型は、位置引数と名前付き引数の両方にアクセスするためのメソッドを提供しています。
/// 余分にある引数を全てまとめて受け取る _引数シンク_(キッチンシンクのようにさまざまなものが流れ込む先)は、`..sink`の形で指定できます。このとき生成される`sink`の値は`arguments`型になります。この型は、位置引数と名前付き引数の両方にアクセスするためのメソッドを提供しています。
///
/// ```example
/// #let format(title, ..authors) = {
Expand Down Expand Up @@ -109,7 +109,7 @@ impl Args {
Ok(None)
}

/// 可能ならn個の位置引数を取り出します。
/// 可能ならn個の位置引数を取り出します。
pub fn consume(&mut self, n: usize) -> SourceResult<Vec<Arg>> {
let mut list = vec![];

Expand Down
8 changes: 4 additions & 4 deletions crates/typst-library/src/foundations/datetime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ use crate::World;
///
/// # フォーマット
/// [`display`]($datetime.display)メソッドを使うことで、日時をカスタマイズして表示するフォーマットを指定できます。日時のフォーマットは、_コンポーネント_ に _修飾子_ を組み合わせることで指定します。
/// コンポーネントは、日時の中の特定の部分(たとえば年や月など)を表します。そして修飾子を使うことで、そのコンポーネントをどのように表示するかを細かく設定できます。
/// コンポーネントは、日時の中の特定の部分(例えば年や月など)を表します。そして修飾子を使うことで、そのコンポーネントをどのように表示するかを細かく設定できます。
/// コンポーネントを表示するには、コンポーネントの名前を角かっこで囲みます(例:`[[year]]`は年を表示します)。修飾子を追加するには、コンポーネント名の後に半角スペースを入れ、修飾子名、コロン(:)、修飾子の値を記述します(例:`[[month repr:short]]`は月名を短縮形で表示します)。
///
/// 使用可能なコンポーネントと修飾子の組み合わせは以下のとおりです
/// 使用可能なコンポーネントと修飾子の組み合わせは以下の通りです
///
/// - `year`: `datetime`の年を表示します。
/// - `padding`: 年表示のパディングは`zero`(ゼロ)、`space`(空白)、`none`(なし)が指定できます。
Expand Down Expand Up @@ -100,7 +100,7 @@ use crate::World;
/// - `second`: `date`の秒を表示します。
/// - `padding`: 秒表示のパディングは`zero`(ゼロ)、`space`(空白)、`none`(なし)が指定できます。
///
/// すべてのコンポーネントが常に使用できるとは限らない点には注意してください。たとえば、`{datetime(year: 2023, month: 10, day: 13)}`のようにして新しい`datetime`を作成すると、内部的には日付のみが保持されるため、`hour`や`minute`のようなコンポーネントは使用できません。それらは特定の時刻が指定された`datetime`でのみ動作します。
/// 全てのコンポーネントが常に使用できるとは限らない点には注意してください。例えば、`{datetime(year: 2023, month: 10, day: 13)}`のようにして新しい`datetime`を作成すると、内部的には日付のみが保持されるため、`hour`や`minute`のようなコンポーネントは使用できません。それらは特定の時刻が指定された`datetime`でのみ動作します。
#[ty(scope, cast)]
#[derive(Debug, Clone, Copy, PartialEq, Hash)]
pub enum Datetime {
Expand Down Expand Up @@ -208,7 +208,7 @@ impl Datetime {
/// _注_:指定する`datetime`の要素によって、Typstが保持する形式は次の3通りのいずれかになります。
/// * 年、月、日だけを指定した場合、Typstは日付のみを保持します。
/// * 時、分、秒だけを指定した場合、Typstは時刻のみを保持します。
/// * 年、月、日、時、分、秒すべてを指定した場合、Typstは完全な日時を保持します。
/// * 年、月、日、時、分、秒の全てを指定した場合、Typstは完全な日時を保持します。
///
/// 保持形式に応じて、[`display`]($datetime.display)メソッドはデフォルトで異なるフォーマットを選択します。
///
Expand Down
12 changes: 6 additions & 6 deletions crates/typst-library/src/foundations/func.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ use crate::foundations::{
/// ```
///
/// 関数はTypstにおいて基礎となる構成要素です。
/// Typstは様々な組版タスクに応じた関数を提供しています
/// さらには、作成されるマークアップの裏側では関数が用いられており、すべてのスタイル設定は関数を介して行われます
/// このリファレンスでは利用可能なすべての関数とその使い方を示します
/// Typstはさまざまな組版タスクに応じた関数を提供しています
/// さらには、作成されるマークアップの裏側では関数が用いられており、全てのスタイル設定は関数を介して行われます
/// このリファレンスでは利用可能な全ての関数とその使い方を示します
/// Typstで関数をさらに活用する方法については、[setルール]($styling/#set-rules)および[showルール]($styling/#show-rules)のドキュメントも参照して下さい。
///
/// # 要素関数
Expand All @@ -61,10 +61,10 @@ use crate::foundations::{
///
/// 関数バインディングの右辺は関数本体で、ブロックか任意の式です。
/// 関数の戻り値を定義し、引数に依存させることができます。
/// 関数本体が[コードブロック]($scripting/#blocks)の場合、戻り値はブロック内のすべての式を連結させた結果になります
/// 関数本体が[コードブロック]($scripting/#blocks)の場合、戻り値はブロック内の全ての式を連結させた結果になります
///
/// 関数本体内では、`return`キーワードを用いて処理を途中で抜け出したり、必要に応じて戻り値を指定して返したりできます。
/// 戻り値が明示的に与えられない場合、本体は`return`の前の式すべてを連結した結果として評価されます
/// 戻り値が明示的に与えられない場合、本体は`return`の前の式全てを連結した結果として評価されます
///
/// 意味のある値を何も返さない関数は、代わりに[`none`]を返します。
/// このような関数の戻り値の型はドキュメント中では明示的に指定されていません
Expand Down Expand Up @@ -107,7 +107,7 @@ use crate::foundations::{
/// ```
///
/// # 関数の純粋性に関する注意
/// Typstにおいて関数はすべて _純粋_ です。
/// Typstにおいて関数は全て _純粋_ です。
/// これは同じ引数からは常に同じ結果が返ってくることを意味します。
/// 純粋関数は2回目の呼び出し時に別の値を生成するために何かを「記憶」することはできません。
///
Expand Down
4 changes: 2 additions & 2 deletions crates/typst-library/src/html/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ pub fn module() -> Module {
/// Typstは有効なHTMLが何であるかを認識しています。
/// タグとその属性は、構文的に有効なHTMLを構成していなければなりません。
/// `meta`のようないくつかのタグはコンテンツを受け付けません。
/// したがって、それらに対して本文を提供してはいけません。
/// 将来的に、この機能に対して更に多くのチェックを追加する可能性があるため、この関数を使用する際は有効なHTMLを生成していることを確認してください。
/// 従って、それらに対して本文を提供してはいけません。
/// 将来的に、この機能に対してさらに多くのチェックを追加する可能性があるため、この関数を使用する際は有効なHTMLを生成していることを確認してください。
///
/// 通常、Typstは`html`、`head`、および`body`タグを生成します。
/// 代わりにこの関数でそれらを作成した場合、Typstは自身の生成するタグを省略します。
Expand Down
4 changes: 2 additions & 2 deletions crates/typst-library/src/layout/align.rs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ use crate::text::TextElem;
/// ```
///
/// # 配置のネスト
/// レイアウトコンテナおよびその内部の要素に様々な配置設定を適用できます
/// レイアウトコンテナおよびその内部の要素にさまざまな配置設定を適用できます
/// このようにすることで複雑なレイアウトを作成できます。
///
/// ```example
Expand Down Expand Up @@ -115,7 +115,7 @@ impl Show for Packed<AlignElem> {
/// - `bottom`: 下側に配置。
///
/// これらの値はグローバルスコープでも、alignment型のスコープでも用いることができます。
/// したがって、以下の2つのどちらでも書くことができます。
/// 従って、以下の2つのどちらでも書くことができます。
///
/// ```example
/// #align(center)[Hi]
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/layout/angle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use typst_utils::{Numeric, Scalar};

use crate::foundations::{func, repr, scope, ty, Repr};

/// 回転を表す角度
/// 回転をあらわす角度
///
/// Typstは以下の角度の単位をサポートしています。
///
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/layout/dir.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use crate::layout::{Axis, Side};
/// - `{btt}`: 下から上。
///
/// これらの値はグローバルスコープでも、direction型のスコープでも用いることができます。
/// したがって、以下の2つのどちらでも書くことができます。
/// 従って、以下の2つのどちらでも書くことができます。
/// ```example
/// #stack(dir: rtl)[A][B][C]
/// #stack(dir: direction.rtl)[A][B][C]
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/layout/length.rs
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ impl Length {
/// このlengthをポイントに変換します。
///
/// このlengthの`em`単位の値が(単に`2pt`ではなく`5em + 2pt`のように)非ゼロの場合にエラーが発生して失敗します。
/// 長さの`em`成分を無視するために(`(5em + 2pt).abs.pt()`のように)`abs`フィールドを使用してください(したがって数値部分のみが変換されます)。
/// 長さの`em`成分を無視するために(`(5em + 2pt).abs.pt()`のように)`abs`フィールドを使用してください(従って数値部分のみが変換されます)。
#[func(name = "pt", title = "Points")]
pub fn to_pt(&self, span: Span) -> SourceResult<f64> {
self.ensure_that_em_is_zero(span, "pt")?;
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/layout/pad.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ pub struct PadElem {
#[external]
pub y: Rel<Length>,

/// 四辺すべてを同じ値で設定するための省略記法
/// 四辺全てを同じ値で設定するための省略記法
#[external]
pub rest: Rel<Length>,

Expand Down
6 changes: 3 additions & 3 deletions crates/typst-library/src/layout/page.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ use crate::visualize::{Color, Paint};
/// この関数は主にsetルールでページのプロパティに影響を与えるために使用されますが、引数を独自のページセットに明示的にレンダリングするためにも使用できます。
///
/// ページでは幅と高さに`{auto}`が設定可能です。
/// この場合、ページは各軸方向においてコンテンツに合わせて大きくなります
/// この場合、ページは各軸方向においてコンテンツにあわせて大きくなります
///
/// [ページセットアップガイド]($guides/page-setup-guide)では多くの例とともにこの関数と関連する関数を用いてどのように文書をセットアップするかを説明しています。
///
Expand Down Expand Up @@ -71,7 +71,7 @@ pub struct PageElem {
/// ページの高さ。
///
/// これが`{auto}`に設定された場合、[改ページ]($pagebreak)は手動で挿入したときのみ発火させることができます。
/// このドキュメントのほとんどの例では、ページの高さに `{auto}` を指定しており、コンテンツに合わせて動的に伸縮するようにしています
/// このドキュメントのほとんどの例では、ページの高さに `{auto}` を指定しており、コンテンツにあわせて動的に伸縮するようにしています
#[resolve]
#[parse(
args.named("height")?
Expand Down Expand Up @@ -109,7 +109,7 @@ pub struct PageElem {
/// A4のページでは2.5cmの余白になります。
/// - 単一の長さ指定: 全ての辺に同じ大きさの余白を適用します。
/// - 辞書指定: 辞書を用いることで余白を個々に設定可能です。
/// この辞書に含められるキーは以下のとおりです。リストは優先順位の順に並んでいます。
/// この辞書に含められるキーは以下の通りです。リストは優先順位の順に並んでいます。
/// - `top`: 上部の余白。
/// - `right`: 右側の余白。
/// - `bottom`: 下部の余白。
Expand Down
4 changes: 2 additions & 2 deletions crates/typst-library/src/layout/place.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use crate::layout::{Alignment, Em, Length, Rel};
/// 親コンテナに対して相対的なコンテンツの配置。
///
/// コンテンツはオーバーレイ(デフォルト)またはフロートのいずれかで配置できます。
/// オーバーレイのコンテンツは、指定された[`alignment`]($place.alignment)に従って親コンテナに合わせて配置され、これまでに追加された他のコンテンツの上に表示されます。
/// オーバーレイのコンテンツは、指定された[`alignment`]($place.alignment)に従って親コンテナにあわせて配置され、これまでに追加された他のコンテンツの上に表示されます。
/// フロートのコンテンツは、親コンテナの上部または下部に配置され、他のコンテンツを下または上にそれぞれずらします。
/// 両方の場合で、コンテンツの位置は[`dx`]($place.dx)および[`dy`]($place.dy)オフセットを用いてレイアウトに影響を与えることなく調整可能です。
///
Expand Down Expand Up @@ -161,7 +161,7 @@ pub enum PlacementScope {
/// 現在の列に配置する。
#[default]
Column,
/// 親要素に対して相対的な位置に配置され、コンテンツがすべての列にまたがって表示されます
/// 親要素に対して相対的な位置に配置され、コンテンツが全ての列にまたがって表示されます
Parent,
}

Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/loading/csv.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use crate::loading::{DataSource, Load, Readable};
///
/// CSVファイルは読み込まれ、文字列からなる2次元配列にパースされます。
/// 具体的には、CSVファイルの各行が文字列の配列として表現され、
/// すべての行が単一の配列にまとめられます
/// 全ての行が単一の配列にまとめられます
/// ヘッダー行は削除されません。
///
/// # 例
Expand Down
4 changes: 2 additions & 2 deletions crates/typst-library/src/loading/xml.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ use crate::loading::{DataSource, Load, Readable};
/// XMLノードは要素または文字列になり得ます。
/// 要素は以下のキーを持つ辞書として表現されます。
///
/// - `tag`: 要素の名称を表す文字列
/// - `attrs`: 要素の属性を表す文字列からなる辞書
/// - `tag`: 要素の名称をあらわす文字列
/// - `attrs`: 要素の属性をあらわす文字列からなる辞書
/// - `children`: 要素の子ノードからなる配列。
///
/// この例におけるXMLファイルは、ルート要素である`news`タグと複数の`article`タグを含んでいます。
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/math/attach.rs
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ pub struct LimitsElem {

/// 字形を伸縮します。
///
/// この関数は、上部及び下部アタッチメントがフィットするように、自動的にアタッチメントのベースを伸縮させることにも使えます。
/// この関数は、上部および下部アタッチメントがフィットするように、自動的にアタッチメントのベースを伸縮させることにも使えます。
///
/// 伸縮可能な字形は限られており、どの字形が伸縮可能かは使用する数式フォントに依存することに注意してください。
/// ただし、この点に関して多くの数式フォントで違いはありません。
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/math/matrix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ pub struct CasesElem {
#[default(DEFAULT_ROW_GAP.into())]
pub gap: Rel<Length>,

/// 場合分けの各分岐を表す子要素
/// 場合分けの各分岐をあらわす子要素
#[variadic]
pub children: Vec<Content>,
}
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/math/root.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub fn sqrt(
RootElem::new(radicand).pack().spanned(span)
}

/// 累乗根
/// 冪根
///
/// ```example
/// $ root(3, x) $
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/math/style.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ pub fn sans(
/// このため、スタイル間の切り替えは[フォントフィーチャー]($text.features)を用いてサポートされているフォントでのみ可能です。
///
/// デフォルトの数式フォントでは、ラウンドハンドスタイル(丸みを帯びた筆記体)が`ss01`フィーチャーとして利用可能です。
/// したがって、以下のように独自の`\mathscr`が定義できます。
/// 従って、以下のように独自の`\mathscr`が定義できます。
///
/// ```example
/// #let scr(it) = text(
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/model/bibliography.rs
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ pub struct BibliographyElem {
/// `{show bibliography: set heading(numbering: "1.")}`
pub title: Smart<Option<Content>>,

/// 文書内で引用されていないものも含めて、参考文献ファイルにあるすべての文献を出力するかどうか
/// 文書内で引用されていないものも含めて、参考文献ファイルにある全ての文献を出力するかどうか
///
/// 個々の引用文献を表示させずに追加するには、 [`form`]($cite.form) を `{none}`として [`cite`]($cite) 関数を使用します。
#[default(false)]
Expand Down
2 changes: 1 addition & 1 deletion crates/typst-library/src/model/document.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use crate::foundations::{

/// 文書とそのメタデータのルート要素。
///
/// すべての文書は、自動的に`document`(文書)要素でラップされます。
/// 全ての文書は、自動的に`document`(文書)要素でラップされます。
/// この文書要素は自分で作成することはできません。
/// この関数は、[setルール]($styling/#set-rules)と組み合わせて文書のメタデータを指定する場合にのみ使用されます。
/// setルールは、レイアウトコンテナの内部に置いてはいけません。
Expand Down
Loading