Welcome, Guest. Please login or register. Did you miss your activation email?

Author Topic: Automatically link SFML class from the forum to the documentation  (Read 4695 times)

0 Members and 1 Guest are viewing this topic.

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 11039
    • View Profile
    • development blog
    • Email
I just got this idea, although I'm not sure if it could get annoying or if it's even possible to implement (in a simple way) but I write it down anyway.

When ever some one writes down the class name of a SFML class the forum should automatically link the class to the documentation.
For the class name I would suggest that only names in the form of sf::ClassName get recognized and if they're not in a code block (or other blocks).

For the linking I could think of two diffrent ways:
  • The entry gets 'postprocessed' and with that the sf::ClassName get surrounded with the specific link.
  • Before the text is sent to the user the sf::ClassName get linked to the documentation.
Additionally one could also add the tt-block to let it stand out more.

The question now is which version of SFML to link to. I'd go for SFML 2 (at least as soon as it gets released).

I think it would greatly help specially for the new users to discover the documentation.
« Last Edit: April 04, 2012, 08:10:32 pm by eXpl0it3r »
Official FAQ: https://www.sfml-dev.org/faq.php
Official Discord Server: https://discord.gg/nr4X7Fh
——————————————————————
Dev Blog: https://duerrenberger.dev/blog/

Laurent

  • Administrator
  • Hero Member
  • *****
  • Posts: 32498
    • View Profile
    • SFML's website
    • Email
Re: Automatically link SFML class from the forum to the documentation
« Reply #1 on: April 04, 2012, 09:51:26 pm »
It should be possible, and probably not so complicated, but I definitely don't have the time to write it.
Laurent Gomila - SFML developer