我有时想添加一个索引条目,但写得不同。例如:
.. index:: bitwise operator
Bitwise operators are ...
在这种情况下,我不能使用:index:
,因为我不希望我的索引条目有大写和复数。但是,移动段落开头的索引条目可能会很糟糕,因为锚点或页码(用于LaTeX输出(可能是错误的。
有没有办法在文本中设置索引项?
我有其他问题与索引,例如与链接:
Among all other animals, one can cite the `elephant <https://wikipedia...>`_
这里我真的不能放索引:
Among all other animals, one can cite the `:index:`elephant` <https://wikipedia...>`_
我对粗体文本或代码有其他问题,我想在适当的位置轻松索引:
This text is **:index:`bold`** and this :code:`:index:`code`` is indexed...
有任何变通方法的例子吗?
Steve Piercy编辑
在这个例子中,在latex
输出中,粗体字tristique
位于从第1页开始到第2页结束的段落上,索引条目指向错误的页面。因为那个词是粗体的。我不能做:index:'tristique'
。
Document
========
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula nulla auctor sem elementum, et ultricies dolor ultricies. Cras et tortor arcu. Phasellus auctor tortor elit, eget pretium dui tincidunt vitae. Sed et erat a ipsum mollis sodales id eget lorem. Aliquam non risus malesuada, vulputate lorem in, molestie dui. Vestibulum tincidunt, metus sit amet commodo fermentum, ligula eros posuere velit, ut consectetur elit tortor ut nulla.
Nullam hendrerit et tellus molestie pretium. Pellentesque a eros nulla. Nullam lacus libero, tristique eget pulvinar ut, vulputate sed dolor. Nulla porttitor nunc luctus, lobortis risus eu, cursus enim. Proin et laoreet risus. Donec in sodales orci. Praesent eleifend ipsum at dignissim sodales. Ut et mauris est. Donec vel efficitur nulla. Phasellus hendrerit sodales ullamcorper. Aliquam accumsan feugiat eros, quis luctus risus ullamcorper vel. In et urna id massa consectetur luctus. Nullam semper neque in dictum ornare.
Suspendisse potenti. Maecenas commodo neque ac erat suscipit, eget convallis sem viverra. In viverra tempus lobortis. Proin vel pulvinar mauris, at eleifend lectus. Ut est lacus, tempus vitae porttitor congue, fringilla nec massa. Curabitur sed arcu sit amet augue facilisis hendrerit. Nullam fringilla felis non imperdiet accumsan.
Etiam faucibus efficitur lacus, vitae commodo tellus imperdiet non. Phasellus feugiat odio libero, at pharetra ex maximus interdum. Etiam sed commodo ipsum. Nam eros elit, pharetra sit amet nisi suscipit, vehicula efficitur mi. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse potenti. Vestibulum gravida nunc eget dictum luctus. Suspendisse eget ligula augue. Nunc ullamcorper commodo faucibus.
In fringilla bibendum quam eu laoreet. Donec finibus sem lacus, quis eleifend eros suscipit eget. In quis rhoncus felis, non porta tortor. Maecenas fermentum mi sit amet mauris condimentum, sed viverra justo fringilla. Nulla commodo id risus non fringilla. Nunc id velit id erat sodales bibendum. Proin dictum, mi id pellentesque ullamcorper, tellus elit consectetur ex, eget lobortis mauris quam eu elit. Suspendisse sagittis volutpat accumsan. Sed ut nulla nulla. Phasellus in ante felis.
Suspendisse potenti. Maecenas commodo neque ac erat suscipit, eget convallis sem viverra. In viverra tempus lobortis. Proin vel pulvinar mauris, at eleifend lectus. Ut est lacus, tempus vitae porttitor congue, fringilla nec massa. Curabitur sed arcu sit amet augue facilisis hendrerit. Nullam fringilla felis non imperdiet accumsan.
Etiam faucibus efficitur lacus, vitae commodo tellus imperdiet non. Phasellus feugiat odio libero, at pharetra ex maximus interdum. Etiam sed commodo ipsum. Nam eros elit, pharetra sit amet nisi suscipit, vehicula efficitur mi. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse potenti. Vestibulum gravida nunc eget dictum luctus. Suspendisse eget ligula augue. Nunc ullamcorper commodo faucibus.
In fringilla bibendum quam eu laoreet. Donec finibus sem lacus, quis eleifend eros suscipit eget. In quis rhoncus felis, non porta tortor. Maecenas fermentum mi sit amet mauris condimentum, sed viverra justo fringilla. Nulla commodo id risus non fringilla. Nunc id velit id erat sodales bibendum. Proin dictum, mi id pellentesque ullamcorper, tellus elit consectetur ex, eget lobortis mauris quam eu elit. Suspendisse sagittis volutpat accumsan. Sed ut nulla nulla. Phasellus in ante felis.
.. index:: tristique
Praesent sodales leo semper, gravida ligula at, varius metus. Nullam cursus porta venenatis. Sed non dictum risus. Morbi eget elit vel metus vulputate consequat vel a nibh. Etiam felis nisl, mollis a hendrerit eu, accumsan non felis. Nullam lacinia libero sed leo iaculis lacinia. Pellentesque sit amet vestibulum felis. In id blandit leo, eget consectetur massa. Quisque ante orci, interdum ac placerat nec, aliquet at leo. Vestibulum fermentum egestas pellentesque. Morbi non felis a lorem convallis efficitur. Integer risus sem, porta vehicula neque nec, consequat euismod erat. Morbi eget rutrum lorem. Curabitur velit metus, interdum id facilisis sed, ornare vel nisi. Fusce vehicula risus nibh, nec porta magna volutpat quis. Phasellus molestie arcu purus, quis facilisis leo volutpat non. Ut nec euismod metus, eu rutrum lectus. Duis consectetur neque mi, a ornare nulla pulvinar a. Pellentesque id mattis felis. Quisque felis orci, finibus id odio id, feugiat scelerisque velit. Sed vehicula rhoncus condimentum. Integer eget nibh facilisis, lobortis urna ac, lobortis libero. Sed posuere eget enim tristique eleifend. Ut elementum mattis turpis eu cursus. Curabitur ac leo ornare, laoreet mauris quis, feugiat dolor. In laoreet posuere nunc, nec tristique lacus vulputate sed. Vestibulum egestas felis sagittis, hendrerit est et, tincidunt tortor. Donec et lobortis turpis. Ut venenatis congue tincidunt. Sed egestas a ex nec tempor. Sed lectus tellus, faucibus sit amet gravida nec, varius non enim. Mauris facilisis dui est, sed molestie augue faucibus nec. Curabitur id magna eleifend, placerat ligula eget, sagittis leo. Quisque tincidunt ligula ac dolor vehicula volutpat. Mauris porta odio congue, fringilla justo id, sodales nisl. Nam finibus mi metus, sed sollicitudin mi convallis semper. Nunc risus metus, placerat scelerisque lacinia in, rhoncus a sapien. Aliquam erat volutpat. Duis tincidunt massa in orci tristique vestibulum. Nunc placerat ex et purus lobortis bibendum. Proin pellentesque dui id mattis vehicula. In hac habitasse platea dictumst. Donec eget tellus eu tortor vulputate vulputate. Morbi maximus lacus eu pretium tempus. Pellentesque blandit lacinia mauris, vitae accumsan urna vehicula eget. In commodo posuere odio sit amet porttitor. Sed enim ipsum, molestie sit amet viverra in, tincidunt a purus. Nullam molestie erat vitae arcu volutpat, ut tempor libero porta. Aliquam ullamcorper rutrum nisi sed **tristique**. Mauris ut fermentum enim. Nam eu diam vel orci fermentum dignissim id nec lorem. Mauris metus mi, porta id feugiat non, dignissim et lorem. Nulla sit amet nisi in sapien iaculis vestibulum. Aliquam fermentum metus quis congue cursus. Nunc massa augue, pharetra id lorem in, sodales mollis dui. In vehicula, tortor vitae vehicula dignissim, turpis felis luctus lectus, sit amet facilisis felis ipsum quis sapien. In viverra interdum cursus. Nulla enim nunc, sagittis quis varius vel, hendrerit sed erat. Donec ultrices erat a commodo lacinia.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
索引状态的文档:
.. index::
single: execution; context
module: __main__
module: sys
triple: module; search; path
The execution context
---------------------
此指令包含五个条目,这些条目将被转换为生成的索引中的条目,该索引链接到索引语句的确切位置(如果是脱机媒体,则链接到相应的页码(。
您是否按照文档中的描述实际试用了index
,并验证了文档是否正确,换句话说,不是";链接到索引语句的确切位置";?例如,在渲染的HTML中,我得到一个<span>
,它的锚紧挨着<h2>
,这很好。
更新
不知怎的,我错过了你想要内联索引,而不是块的索引。无论如何,用于索引的术语是相似的。在我之前链接到的页面的下方,是内联索引角色:index:
。
角色的内容可以是一个简单的短语,然后将其保存在文本中并用作索引条目。它也可以是文本和索引条目的组合,样式类似于交叉引用的明确目标。在这种情况下,"目标"部分可以是上面指令中描述的完整条目。例如:
This is a normal reST :index:`paragraph` that contains several
:index:`index entries <pair: index; entry>`.
这是两种语法。您可以使用第二种语法来获得所需的索引条目。
:index:`Bitwise operators <single: bitwise operators>` are ...
关于您的其他问题,reStructuredText不支持嵌套角色或指令。这意味着你不能用标记来格式化链接或索引项,但你可以在它们产生的HTML选择器上用CSS来格式化它们。这也意味着你不能索引链接。