homepage Welcome to WebmasterWorld Guest from
register, free tools, login, search, pro membership, help, library, announcements, recent posts, open posts,
Become a Pro Member

Home / Forums Index / Code, Content, and Presentation / HTML
Forum Library, Charter, Moderators: incrediBILL

HTML Forum

Using HTML docs as documentation ref
HTML docs as documentation reference

 10:52 am on Sep 10, 2004 (gmt 0)

I am starting to add reference documentation to my website but find that I am only using html paragraphing and links to provide the information. I notice elsewhere others will decide to use pdf documents within their website for a more professional feel for formal documentation of this type. I must admit, when you compare the two, pdfs look and feel better. Is there any program template to improve the look and feel to documentation using standard html methods?



 11:06 am on Sep 10, 2004 (gmt 0)

Trouble is, it's all looks - in every other aspect, the HTML version is far better. PDF files are for printing, not for onscreen display - they take ages to load, they are user-unfriendly, they are inaccessible and they work poorly in the search results.

If you need a good-looking page for printing, you can use a print-only stylesheet to accompany the standard one on your HTML pages.


 12:57 pm on Sep 10, 2004 (gmt 0)

Perhaps you should take a deep look inside Adobe site [adobe.com]

[edited by: korkus2000 at 2:54 pm (utc) on Sep. 10, 2004]
[edit reason] Linked url [/edit]


 1:01 pm on Sep 10, 2004 (gmt 0)

Using just simple css can do a lot to spruce up the look of your docs. Docs don't have to be layout and interface intensive since they're -- just docs. Just make a linked stylesheet with some simple css declarations for <h1>, <h2>, and <p> or more classes and you'll have nice, easy-to read docs that look real nice too.

It's also nice to use id's for linking to specific parts of your documentation, which I don't think pdf's can do at this stage. Once your docs are loaded, they're cached so switching around to different id's with <a href="docs.html#thisid"> type url's goes real fast, documentation isn't completely reloaded.


 4:36 pm on Sep 10, 2004 (gmt 0)

I like the idea of a print only stylesheet, where can I get one of these from?


 3:46 pm on Sep 11, 2004 (gmt 0)

You write your own print style sheet. You can get help on this in the CSS forum.

Global Options:
 top home search open messages active posts  

Home / Forums Index / Code, Content, and Presentation / HTML
rss feed

All trademarks and copyrights held by respective owners. Member comments are owned by the poster.
Home ¦ Free Tools ¦ Terms of Service ¦ Privacy Policy ¦ Report Problem ¦ About ¦ Library ¦ Newsletter
WebmasterWorld is a Developer Shed Community owned by Jim Boykin.
© Webmaster World 1996-2014 all rights reserved