Page MenuHomePhorge

Escaping elements in remarkup
Closed, ResolvedPublic

Asked by ap on Apr 17 2023, 01:04.

Details

Is it possible to escape Remarkup elements? Say you wish to refer to S3 and you have at least 3 spaces configured you... kinda can't as it becomes an active element.

It'd be nice to be able to escape the S with the traditional backslash so that it's inactive. Same goes for *, _ and other tidbits.

That's assuming something like this isn't already there. :)

Edited:

Basically I just want to be able to type, for example, "We should get S3 storage with Wobblebottom." and have it come out as a normal sentence with normally displaying words.

All the current solutions either put weirdness there (grey boxes, turn it into links, etc) or force a paragraph (with added weirdness :) ).

It'd also be nice to type in an asterisk in the beginning of a line without it becoming a bullet point and so on. Or to write a URL like http://www.cow.org/ without it becoming a link but with it being a normal part of the sentence.

Answers

valerio.bozzolan
Updated 396 Days Ago

Disabling Parsing: Percentages! (%%%)

It seems you can disable Remarkup for some lines creating a block with %%% (newline) %%%.

Example Remarkup:

%%%Example something T15231 etc. S2 **not bold** yeah //not italic//
Example Example ~~eheh~~
%%%

How the above Remarkup renders:

something T15231 etc. S2 **not bold** yeah //not italic//
Example Example ~~eheh~~

↑ As you can see, stuff inside %%% is not expanded, it's not monospaced: it's just normal disarmed Remarkup text.

NOTE: It seems %%% must be at the very beginning of a line.
NOTE: It seems, after the first %%%, we should avoid a newline. I honestly don't know if this is a feature.

Creating monospaced grey text: 1 Backtick! (`)

Also, you can of course put stuff inside backticks (`) but that will change the rendering.

So that `things` become `like this` in grey and with a monospace font and `**without expanding bold** //italic// S2 spaces T123 Tasks etc.`.

Rendering:

So that things become like this in grey and with a monospace font and **without expanding bold** //italic// S2 spaces T123 Tasks etc..

Monospace block: 3 Backticks Block!

You can also do this to create a monospaced block:

```
VERY LONG STUFF T123 S1 **bold
VERY LONG STUFF // italic
```

Rendering:

VERY LONG STUFF T123 S1 **bold
VERY LONG STUFF // italic

Disabling stuff

As avivey said, you can configure the site Config remarkup.ignored-object-names (in page /config) to just ignore specific words like S3.

Full Remarkup documentation

https://we.phorge.it/book/phorge/article/remarkup/


Some related bug reports:

T15487: Fix message in page "/config/edit/storage.s3.bucket/" when you have spaces

This answer has been hidden.

New Answer

Answer

This question has been marked as closed, but you can still leave a new answer.