Okay, so maybe these empty lines were required after all.
This reverts commit 998054165a
.
This commit is contained in:
parent
998054165a
commit
c682ac247c
13
GUIDE.rst
13
GUIDE.rst
|
@ -26,6 +26,7 @@ To align the text, you can use either ``[<alignment mode>]`` or
|
|||
For example, to right-align some text, you could do something like this:
|
||||
|
||||
.. code::
|
||||
|
||||
[right]some text[/]
|
||||
|
||||
----------------
|
||||
|
@ -36,6 +37,7 @@ Do you want to include titles or subtitles to your message, integrated with
|
|||
the website's design? Use the ``[title]`` and ``[subtitle]`` tags for that:
|
||||
|
||||
.. code::
|
||||
|
||||
[title]Just do it![/]
|
||||
[subtitle]Don't let your dreams be dreams![/]
|
||||
|
||||
|
@ -105,6 +107,7 @@ tag accepts several types of values:
|
|||
Here are some examples:
|
||||
|
||||
.. code::
|
||||
|
||||
[blue]I'm blue![/]
|
||||
[color=rgb(255, 255,255,0.4)]I'm black![/]
|
||||
[color=hsl(0,100%, 0.5)]I'm red![/]
|
||||
|
@ -123,6 +126,7 @@ will be taken as the link title.
|
|||
Here are examples:
|
||||
|
||||
.. code::
|
||||
|
||||
[url]https://planet-casio.com[/]
|
||||
[url=https://planet-casio.com]Planète Casio[/]
|
||||
[url=/relative/url.html][/]
|
||||
|
@ -132,6 +136,7 @@ take no attribute but take a content which is the user whose the profile
|
|||
is to be linked's name. For example:
|
||||
|
||||
.. code::
|
||||
|
||||
[profil]Cakeisalie5[/]
|
||||
|
||||
---------------
|
||||
|
@ -146,6 +151,7 @@ the display will just be generalistic.
|
|||
Here are examples:
|
||||
|
||||
.. code::
|
||||
|
||||
[quote]Someone said that.[/]
|
||||
[quote=Cakeisalie5]Ever realized that my name contained “Cake”?[/]
|
||||
|
||||
|
@ -158,6 +164,7 @@ hurting people or to hide the solution to a problem, you can use the
|
|||
``[spoiler]`` tag.
|
||||
|
||||
.. code::
|
||||
|
||||
[spoiler]This is hidden![/]
|
||||
[spoiler=Uncover the dark secrets of the night]Boo![/]
|
||||
[spoiler=Uncover this!|Cover this quick!!]BOOO![/]
|
||||
|
@ -175,6 +182,7 @@ There are two code tags:
|
|||
For example:
|
||||
|
||||
.. code::
|
||||
|
||||
[code]Some multiline code, with [center]tags shown as they are[/center].
|
||||
Incredible, heh?[/code]
|
||||
[inlinecode]Some inline code.[/inlinecode]
|
||||
|
@ -199,6 +207,7 @@ the pipe (``|``) character:
|
|||
For example:
|
||||
|
||||
.. code::
|
||||
|
||||
[img=right|float|x24]https://example.org/image.jpg[/]
|
||||
|
||||
is a right-aligned image, floating (which means text will be allowed on
|
||||
|
@ -210,6 +219,7 @@ Planète Casio admins can use the ``[adimg]`` tag which is equivalent to the
|
|||
URLs, so this is possible:
|
||||
|
||||
.. code::
|
||||
|
||||
[adimg]incredible.jpg[/]
|
||||
|
||||
-----------------
|
||||
|
@ -221,6 +231,7 @@ platforms into your message, as a block. To do this, you can use the
|
|||
``[video]`` and ``[video tiny]`` tags. For example:
|
||||
|
||||
.. code::
|
||||
|
||||
[video]https://www.youtube.com/watch?v=yhXpV8hRKxQ[/]
|
||||
[video tiny]https://www.youtube.com/watch?v=yhXpV8hRKxQ[/]
|
||||
|
||||
|
@ -234,6 +245,7 @@ the percentage (between 0 and 100 included) of the advancement as its
|
|||
attribute. For example:
|
||||
|
||||
.. code::
|
||||
|
||||
[progress=50]Building a great wall…[/]
|
||||
[progress=100][/]
|
||||
|
||||
|
@ -253,6 +265,7 @@ You are not obliged to terminate the ``[label]`` tag (the original version of
|
|||
it didn't support the ``[label]`` tag termination, in fact). For example:
|
||||
|
||||
.. code::
|
||||
|
||||
[label=sometag][subtitle]Some chapter[/subtitle]
|
||||
|
||||
...
|
||||
|
|
|
@ -2,6 +2,7 @@ Planète Casio's textout() BBcode markup language translator
|
|||
===========================================================
|
||||
|
||||
.. warning::
|
||||
|
||||
If you are accessing this repository from <https://git.planet-casio.com>_,
|
||||
keep in mind that it is only a mirror and that the real repository
|
||||
is located at <https://forge.touhey.fr/pc/textout.git>_ for now.
|
||||
|
@ -30,6 +31,7 @@ Usage
|
|||
To use this module, simply use the ``to<language>()`` functions once imported:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
#!/usr/bin/env python3
|
||||
import textoutpc
|
||||
|
||||
|
@ -68,6 +70,7 @@ The following tweaks are read by the translator and built-in tags:
|
|||
An example call would be:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
#!/usr/bin/env python3
|
||||
import textoutpc
|
||||
|
||||
|
|
Loading…
Reference in New Issue