The moose likes Developer Certification (SCJD/OCMJD) and the fly likes User guide question Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of Android Security Essentials Live Lessons this week in the Android forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "User guide question" Watch "User guide question" New topic

User guide question

Liviu Carausu
Ranch Hand

Joined: Oct 07, 2004
Posts: 157
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 ?

Oracle Certified Master Java SE6 Developer(SCJD),
OCE JEE 6 JSP and Servlets Developer.
Roberto Perillo

Joined: Dec 28, 2007
Posts: 2258

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.

Cheers, Bob "John Lennon" Perillo
SCJP, SCWCD, SCJD, SCBCD - Daileon: A Tool for Enabling Domain Annotations
Liviu Carausu
Ranch Hand

Joined: Oct 07, 2004
Posts: 157
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.
Jeffry Kristianto Yanuar
Ranch Hand

Joined: Oct 01, 2007
Posts: 759
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

Joined: Oct 07, 2004
Posts: 157
Hi Jeffry,

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


subject: User guide question
Similar Threads
Is one userguid.txt enough for all those sections.
Read file from Jar - Exception
NX: userguide.txt vs. online help
Userguide question.
HTML user guide question