• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Where to put the images that are used in the userguide.htm

 
Chirag Doshi
Greenhorn
Posts: 21
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi All,
I have decide to create the userguide as an html page. In this HTML page I want to put some images of screen shots of the application.
I am thinking in the final submission,where should these image files reside.

this is how is my assignment's submission section reads
----------------------------------
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:
o This html file.
o A subdirectory called javadoc, containing HTML/Javadoc documentation for all classes and interfaces you are submitting.
o 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.
o 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.

----------------------------------
now in this structure they have not allowed for any place to put image files that are used int the userguide.html.
I was thinking that I shall create a directory called userguide_file in the docs directory which will contain the images.

thus the structure from docs onwards would be

docs > instructions.html
docs > javadocs
docs > choices.txt
docs > userguide.html
docs > userguide_files
docs > userguide_files > image1.gif

Do you guys think it is ok to add a directory to the specified structure ? Or do you think it is better not to change the strcutre at all. Should I not use images at all, just because they have not provided a placeholder for them ?

I am concerned if they verify the structure of the jar programmatically then
such a change may well cause an automatic failure.

What do you think ?

Chirag
 
Hanna Habashy
Ranch Hand
Posts: 532
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Chirag:
I don't have an answer to you question, however I want to warn you about these images. When the time comes to submit your project, they going to tell you that many people faces problems trying to submit files larger than 1000K. YOu will need to optimize your graphics to make the overall size between 200K and 400K.
So be carefull, and make sure that the overall size is not too large, otherwise you might have some problems uploading your project.
good luck
 
Leo Tien
Ranch Hand
Posts: 156
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi, Chirag:
I think you are right, and there is another way to put your images file: leave your userguide.html online, then your can execute the image online too. But if do this, I don't find where should we write the userguide.html URL, old hand tell me please !!!
 
Robert Konigsberg
Ranch Hand
Posts: 172
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Also make sure you're using an operating-system neutral file format for your images!
 
Chirag Doshi
Greenhorn
Posts: 21
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks everyone,
I think I am going to get rid of the images from my userguide. Its not worth the bother.
I think the userguide would be as explanative without the images, since the application is such a simple one.

Thanks
Chirag
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic