[TYPO3-doc] [ReST] Inline code markup question

[François Suter]

Hi Martin,

Thanks for the explanations. That makes it much clearer.

> In general I think here we are facing the task of having to develop our
> own TYPO3 specific notations gradually.

Yes, I agree. We should start making a list of what we need. On top of 
:code:, we already discussed having a role for quick-linking to 
api.typo3.org. We should review this soon, as I'm facing this need quite 
clearly while working on Core APIs. We have the one for Forge issues 
already too.

> See http://sphinx.pocoo.org/markup/inline.html
> """
> The default role (`content`) has no special meaning by default. You are
> free to use it for anything you like, e.g. variable names; use the
> default_role config value to set it to a known role.
> """

So we should define what role to use here. Or advise people against 
using this simple markup.

>> I found out that it gets transformed into a<cite>  tag. Is that correct?
>> Does it make sense?
>
> I don't know.

Doesn't IMO ;-) As said above, we should define the use of this role or 
avoid using it.

> https://wiki.fysik.dtu.dk/ase/development/writing_documentation_ase.html

Interesting to see what other projects do.

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch