Win a copy of Functional Reactive Programming this week in the Other Languages forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

question about userguide.html

 
yang wulong
Greenhorn
Posts: 5
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hello,

Packaging of Submissions
All elements of your submission must be packaged in a single JAR file. The JAR file must have the following layout and contents in its root:
The executable JAR containing the programs. This must be called runme.jar.
The original, unchanged database file that was supplied to you. Note that you must keep a copy of the original database file supplied to you, and this must be the file you submit. The marking process will expect the exact same data without any changes.
A directory called code, containing all the source code and related parts of your project. You must create subdirectories within this to reflect your package structure and distribute your source files within those directories.
A file called version.txt. This must contain pure ASCII (not a word processor format) indicating the exact version of JDK you used, and the host platform you worked on.
A directory called docs, containing the following items at the top level:
This html file.
A subdirectory called javadoc, containing HTML/Javadoc documentation for all classes and interfaces you are submitting.
A file called choices.txt that containing pure ASCII (not a word processor format) text describing the significant design choices you made. Detail the problems you perceived, the issues surrounding them, your value judgments, and the decisions that you made. This document should also describe any uncertainties you had regarding the project, and the decisions you made when resolving them.
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.


from the instruction you can see "If your user documentation is online then you may omit this file. "
my userguide.html is online
1.I think online means that the userguide.html can be accessed by the pragram, is that right?
2.because my userguide.html is online, is that right to put the userguide.html in the root ,( just like the db file put in the working directory to let the program to access that),and not put that in the \doc \ ? or the sun would not allow the extra file put in the root?
can anyone help me about that?
thank you.
 
Jon Entwistle
Ranch Hand
Posts: 118
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Yang,


1.I think online means that the userguide.html can be accessed by the pragram, is that right?


That is what I understood it to mean.


2.because my userguide.html is online, is that right to put the userguide.html in the root


I think they expect you to put any html files which are 'online' into the jar file itself. I used:

setPage(this.getClass().getResource("/help/menu.html"));

to find the menu.html file which held links the the remaining help files.


Regards,

Jon
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic