File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes package.html & userguide.txt Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "package.html & userguide.txt" Watch "package.html & userguide.txt" New topic

package.html & userguide.txt

Shrenik Sakriya
Ranch Hand

Joined: May 07, 2001
Posts: 40
Hi Folks,

I've 2 questions around 2 topics package.html & userguide.txt

1. package.html : in order to add comments next to the package i had to create the little package.html files which reside in the respetive package. Is it ok if the source files also have package.html in the final submission jar file .

2. userguide.txt : In my userguide.txt i have application execution details e.g. how to start database? how to connect to remote database? how to connect to the local database? etc .. It desn't have the application installation in it e.g. unjar the submission jar etc etc. Is it to now have the installation details in the userguide.txt. It would be interesting to hear from the experienced folks to understand whether or not this is required.

Your help with the answer to above questions is highly appreciated since i'm looking to submit my assignment tomorrow.

Shrenik Sakriya

SCJP1.2 88%<br />SCWCD1.4 89%<br />CCNA 94%
K. Tsang

Joined: Sep 13, 2007
Posts: 3131

Hi Shrenik,

Nice to hear you are almost done. For the package.html file, it's ok as it is. In the final submission jar, those package.html files are inside that "code" directory. However, in the runme.jar file, there shouldn't have any package.html files.

For user guide (mine in html), what I had were a quick start guide (how to run the runme.jar in client/server/stand-alone modes), how to enter those config for each of the modes with screen shots, possible errors, normal operation procedures.

You don't need to worry about how to unjar the submission file. If Sun examiners can't unjar that, they won't able to access the user guide.

K. Tsang JavaRanch SCJP5 SCJD OCPJP7 OCPWCD5 OCPBCD5 OCPWSD5 OCMJEA5 part 1 part 2/3
Shrenik Sakriya
Ranch Hand

Joined: May 07, 2001
Posts: 40
Thanks a lot for your reply. This clarifies my doubts & i can submit my assignment without any probs.
I agree. Here's the link:
subject: package.html & userguide.txt
It's not a secret anymore!