• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

User guide question

 
Liviu Carausu
Ranch Hand
Posts: 159
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,
I quote from my specifications:

User documentation for the database server and the gui client. If your user documentation is online then you may omit this file. However, if the documentation is not online, you must provide either a single plain ASCII (not word processor format) text document, which must be called userguide.txt, or multiple HTML files which must all be accessible from a starting point document that must be called userguide.html.


I have only one html file called userguide.html which is structured using internal links, similar with the provided instructions.html. I have a subdirectory where I keep all the images referenced from the html file.
It is a problem if I have only one html file or should I break into more html files? The specification is saying "multiple HTML files" . What do you think ?
Thanks,
Liviu
 
Roberto Perillo
Bartender
Posts: 2271
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Howdy, Liviu!

Well, in my opinion, it isn't really a problem if you have only one .html file. It can be either one or multiple files. If your file is called userquide.html, it's ok.
 
Liviu Carausu
Ranch Hand
Posts: 159
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Roberto,
Thanks for your answer. I have just splitted my html file in more files, just to be sure
that I do not break any must rule.
Greetings,
Liviu
 
Jeffry Kristianto Yanuar
Ranch Hand
Posts: 759
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Liviu, make sure that the HTML file doesn't exceed the minimum jar size to send. I just used text file to make my jar size as small as possible.


Jeffry Kristianto Yanuar SCJP, SCJA, SCJD
 
Liviu Carausu
Ranch Hand
Posts: 159
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Jeffry,

Thanks for your advice. My jar file had about 850kB, I uploaded it without problems.

Thanks,

Liviu
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic