2
0
Fork 0
textout/README.rst

35 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Planète Casio's textout() BBcode markup language translator
===========================================================
This module contains a BBcode to HTML translator for
`Planète Casio`_. For more information, read the
2019-06-25 14:57:15 +02:00
documentation accessible on `the official website`_.
2018-07-26 20:33:43 +02:00
.. warning::
2019-06-25 14:49:22 +02:00
If you are accessing this repository from another forge (such as
2019-06-25 14:51:27 +02:00
`Planète Casio's forge <https://gitea.planet-casio.com/cake/textout>`_),
keep in mind that it is only a mirror and that the real repository
2019-06-25 14:51:27 +02:00
is located `in my forge <https://forge.touhey.org/pc/textout.git>`_
for now.
2019-06-25 14:49:22 +02:00
For example, if we want to translate some basic multi-block text to HTML:
2019-06-25 14:49:22 +02:00
.. code-block:: python
2019-06-25 14:49:22 +02:00
from textoutpc import tohtml
text = """[img=center]https://www.planet-casio.com/skins/bootstrap/img/default/logo.png[/img]
Hello [color=R10]world[/color]!
[ul]
[*]This module is made by [url=https://thomas.touhey.fr/]Thomas Touhey[/url]!
[*]Use `.tohtml()` to translate magically to HTML!
[/]
"""
print(tohtml(text))
.. _Planète Casio: https://www.planet-casio.com/
2019-06-25 14:49:22 +02:00
.. _the official website: https://textout.touhey.pro/