6

ある用語を用語集にリンクしたいが、その用語を複数形で記載しているという状況がよくあります。

したがって、通常、単数形で次のようなことを行います。

Some text before the term :term:`important word` then the stuff after the term

これは完全に異なる用語と見なされます。

Some text before the term :term:`important words` then the stuff after the term

これは解析されません:

Some text before the term :term:`important word`s then the stuff after the term

そして、これは非常に冗長です(しかし、私の現在の知識では唯一の選択肢です):

Some text before the term :term:`important words<important word>` then the stuff after the term

用語を 2 回述べる必要なく、用語を複数形で書く別の方法はありますか?

4

1 に答える 1

17

私は同じ問題に直面しています。私は専門家ではありませんが、これが私が見つけたものです(部分的にあなた自身の発見と重複しています):

.. won't resolve to "foo"
:term:`foos`

.. reST doesn't parse the string
:term:`foo`s

.. ugly markup and gives different formatting for "foo" and "s"
:term:`foo`\ s

.. redundant and verbose, but most versatile
:term:`foos<foo>`

最後から 2 番目のパターンは機能しますが、最後のパターンは本当に必要なものです。複数形の「s」を単語の残りの部分と同じようにフォーマットするだけでなく(foo:term:`foo`\ s s のようなものを与える可能性があるとは異なります)、複数形が単なる連結ではない場合にも機能します。たとえば、ディレクトリ/ディレクトリ、またはデータム/データを検討してください。このような場合には、完全な書き換えメカニズムが最適です。

置換を定義することで、ドキュメントを冗長にすることができます:

.. |foos| replace:: :term:`foos<foo>`

次に、複数形の「foos」が必要な場所に置換参照を記述できます(前のリンクを参照) |foos|。ドキュメント プロセッサはそれを次のように扱います。:term:`foos<foo>`


参考文献:

https://sourceforge.net/p/docutils/mailman/message/31536488/

于 2014-05-25T09:31:32.557 に答える