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

Verbatim text does not work in itemizations #31

Open
triska opened this issue Sep 10, 2017 · 1 comment
Open

Verbatim text does not work in itemizations #31

triska opened this issue Sep 10, 2017 · 1 comment

Comments

@triska
Copy link
Member

triska commented Sep 10, 2017

In the documentation of crypto_data_encrypt/4, I would like to format text as follows:

  • chacha20-poly1305
    Description1
  • aes-128-cbc
    Description2
  • aes-128-gcm
    Description3

So, I use:

%     * =|chacha20-poly1305|=
%       Description1
%
%     * =|aes-128-cbc|=
%       Description2
%
%     * =|aes-128-gcm|=
%       Description3

As result, I unexpectedly get:

=() | chacha20()-poly1305()|=()
    Description1 
=() | aes()- 128-cbc()|=()
    Description2 
=() | aes()- 128-gcm()|=()
    Description3 

The issue here seems to be that verbatim text, i.e., =|...|= is not recognized as an item of the itemization if there are also additional descriptions present.

@JanWielemaker
Copy link
Member

Cute. The rule applied is that if all first lines of all items are valid Prolog terms we render the Prolog terms and make lists like

  * Term
     Description

Now, =|chacha20-poly1305|= parses as a Prolog term. The rendering obviously fails badly. That is a bug, but if all worked right the result would still be =|chacha20-poly1305|=. If these are atoms, please write 'chacha20-poly1305'. The quote is lost in the rendering, but this can (and should) be fixed.

If you want a description list without Prolog terms, use the variant derived from Twiki:

  $ =|label|= :
  Description

The label is fixed width, but also bold.

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

No branches or pull requests

2 participants