Welcome, Guest. Please login or register. Did you miss your activation email?
Pages: [1]

Author Topic: Why .chm doc?  (Read 3475 times)

0 Members and 1 Guest are viewing this topic.

netrick

  • Full Member
  • ***
  • Posts: 174
    • View Profile
Why .chm doc?
« on: August 02, 2013, 12:55:02 pm »
Why SFML.Net uses Windows-specific .chm instead of something crossplatfrom (HTML)? For example on my distro (Lubuntu) there is nothing installed that can open it. I guess that there are some apps for linux that can open .chm, but why bother? As SFML.Net is also aimed at mono, it should provide cross platform doc.
Logged

eXpl0it3r

  • SFML Team
  • Hero Member
  • *****
  • Posts: 11030
    • View Profile
    • development blog
    • Email
Re: Why .chm doc?
« Reply #1 on: August 02, 2013, 02:20:42 pm »
Compiled HTML is not Windows specific, in fact Linux had better chm-file readers long before good PDF-readers.
Just because it's not installed by default, it doesn't mean it's "not supported", with that logic would PDFs not be a format for Windows (< 8 ) since there's no reader shipped with Windows. ;)

The reason why SFML.NET is shipped with a chm file is probably, because it's easier to generate. With PDF generation you'll need to get some LaTeX compiler,  which isn't always that straight forward and can come in different versions with different problems. But I guess it's worth suggesting. :)
Logged
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: Why .chm doc?
« Reply #2 on: August 02, 2013, 02:24:01 pm »
The generator that I use is SandCastle, and the last time I checked (a long time ago) it was only able to produce CHM.

Maybe it has changed, or maybe there are better tools now. I don't know.
Logged
Laurent Gomila - SFML developer

netrick

  • Full Member
  • ***
  • Posts: 174
    • View Profile
Re: Why .chm doc?
« Reply #3 on: August 02, 2013, 02:49:59 pm »
Well it is windows specific :P I know it can be read on other systems but still.
Quote
Microsoft Compiled HTML Help is a Microsoft proprietary online help format

But anyway, regular SFML comes with html doc, why can't .net binding do the same? I think html is the easiest to generate and certainly the most portable (you can even open it on non-smart phone).
Logged
Pages: [1]