Note
This version of the guide covers the new PHP-based rendering of Documentation with the TYPO3 Documentation theme.
If the project you are looking at has a file Documentation/guides.xml it is using the new rendering.
Otherwise, consider to migrate the Documentation or head over to the legacy version of this guide: How to document, Sphinx based.
Styled numbered sections (bignums)
With XXL Big Numbers
Source: :
.. rst-class:: bignums-xxl
1. One one one bignums-xxl
Lots of stories here ...
...
How it looks:
-
ONE One one bignums-xxl
Lots of stories here ...
-
TWO Two two
Lots of stories here ...
-
THREE Three three
- Well, here we are again, old lovely...
- You may now serve the fish.
- Fish. Very good, Miss Sophie. Did you enjoy the soup?
With Big Numbers
Source: :
.. rst-class:: bignums
1. ONE One one
Delicious, James
How it looks:
-
ONE One one
Delicious, James.
Thank you, Miss Sophie, glad you enjoyed it. Little bit of North Sea haddock, Miss Sophie.
I think we'll have white wine with the fish.
-
TWO Two two
More ...
-
THREE Three three
More ...
With Big Numbers - Tip
Uses the same color as background, that is used in a tip textblock.
Source: :
.. rst-class:: bignums-tip
1. ONE One one bignums-tip
More ...
How it looks:
-
ONE One one bignums-tip
More ...
-
TWO Two two
More ...
-
THREE Three three
More ...
With Big Numbers - Attention
Source: :
.. rst-class:: bignums-attention
1. ONE One one bignums-attention
More ...
How it looks:
-
ONE One one bignums-attention
More ...
-
TWO Two two
More ...
-
THREE Three three
More ...
With Big Numbers - Important
Source: :
.. rst-class:: bignums-important
1. ONE One one bignums-important
More ...
How it looks:
-
ONE One one bignums-important
More ...
-
TWO Two two
More ...
-
THREE Three three
More ...
With Big Numbers - Warning
Source: :
.. rst-class:: bignums-warning
1. ONE One one bignums-warning
More ...
How it looks:
-
ONE One one bignums-warning
More ...
-
TWO Two two
More ...
-
THREE Three three
More ...
Nested bignums-xxl > bignums > Normally Styled
Source: :
.. rst-class:: bignums-xxl
1. ONE One one bignums-xxl
This is the story of my life ...
.. rst-class:: bignums
1. When I was young
#. this
#. and that
#. and this
How it looks:
-
ONE One one bignums-xxl
This is the story of my life ...
-
When I was young
- this
- and that
- and this
-
When I was grown
Oops, ...
-
When I was old
Oh dear, ...
-
More Examples of Nesting
-
Prepare
-
Check the requirements
- Machine accessible?
-
Is
abc
installed? Run:which abc
Copied! - Is
bcd
available?
- Get yourself a coffee
- Stop everything else!
-
-
Install
Now the actual stuff.
-
Abc
- Download from ...
- unpack
- run installer
-
Bcd
- Download from ...
- unpack
- run installer
-
Cde
- Download from ...
- unpack
- run installer
-
-
Cleanup
BEWARE:
- Do not xxx!
- Do not yyy!
- Do not zzz!
-
Be a happy user!
- Run the stuff all day
- Run the stuff all night
- Never ever stop again