Red Gate forums :: View topic - Possible issue with HTML generation
Return to www.red-gate.com RSS Feed Available

Search  | Usergroups |  Profile |  Messages |  Log in  Register 
Go to product documentation
SQL Doc 3
SQL Doc 3 forum

Possible issue with HTML generation

Search in SQL Doc 3 forum
Post new topic   Reply to topic
Jump to:  
Author Message
dykesa



Joined: 19 Jan 2012
Posts: 11
Location: Indianapolis, IN

PostPosted: Wed Dec 11, 2013 7:04 pm    Post subject: Possible issue with HTML generation Reply with quote

First, I like the new SQL Doc (3), it has a lot of nice features. I think there may be a slight problem with the HTML generation. I thought I was just not understanding something but some thought has led me to think it might just be a detail that was overlooked.

When the documentation is generated, it makes 3 .html files in the primary directory:
1) index.html
2) main.html
3) tree.html

By default a web browser will request index.html from a URL if no file is specified but the index.html file doesn't have any links. It looks like it is the "splash" page and sure enough, if you load main.html, it appears that tree.html is loaded on the left frame and index.html is loaded on the right frame.

This isn't the end of the world once you figure out what is going on but if I upload my documentation to a server, say mywebserver.com under the web path /databasedocumentation and then open a web browser to http://mywebserver.com/databasedocumentation -- I essentially get a page that does nothing and has no documentation info. I think maybe that what is being put into main.html should be in index.html and vice versa.
_________________
( Twitter | Blog )
Back to top
View user's profile Send private message
dykesa



Joined: 19 Jan 2012
Posts: 11
Location: Indianapolis, IN

PostPosted: Wed Dec 11, 2013 7:18 pm    Post subject: Reply with quote

And while I was poking around with my documentation files flipping main.html and index.html, I noticed that the top couple of lines of tree.html also reference index.html.
_________________
( Twitter | Blog )
Back to top
View user's profile Send private message
JonathanWatts



Joined: 15 Dec 2004
Posts: 399
Location: Red Gate Software

PostPosted: Mon Dec 16, 2013 3:22 pm    Post subject: Reply with quote

Hi there,

We carried this style forward from SQL Doc v2. However, as you say it is not particularly intuitive. I have raised an enhancement request for you: SDOC-1567. I cannot promise when this will be done, but we will take a look at it for the next release.

Regards,

Jonathan
_________________
Jonathan Watts

-Project Manager
-Red Gate Software Ltd
Back to top
View user's profile Send private message
Display posts from previous:   
Reply to topic All times are GMT + 1 Hour
Page 1 of 1

 
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group