Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

HTML user guide question

 
Raf Szczypiorski
Ranch Hand
Posts: 383
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi. Being a non-native english speaker, I have a problem understanding this sentence:

"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."

As I understand it, I must provide multiple html files linked to by userguide.html. Why the heck do I have to provide multiple html files? Can't it be only one file, userguide.html?

Raf
 
Roel De Nijs
Sheriff
Posts: 10400
133
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
A single userguide.html will do, but if you have multiple html files or multiple files (images for example) it will all have to be accessible through userguide.html
 
Raf Szczypiorski
Ranch Hand
Posts: 383
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I think I will go for a text file, it's much work... I don't expect any images ;d
 
Roel De Nijs
Sheriff
Posts: 10400
133
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I also used a single plain ascii text file, just a few simple instructions, no images needed.
 
Roberto Perillo
Bartender
Posts: 2271
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Roel De Nijs wrote:I also used a single plain ascii text file


Me too!
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 11914
209
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Whereas I had an older assignment (Fly By Night) and I had lots of HTML files for the user documentation, and even more for the design documentation, including class diagrams and screen shots and ....

(Yes, I well and truly overdid my submission.)
 
Raf Szczypiorski
Ranch Hand
Posts: 383
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Heh. But I am just a normal guy next door, no world-class ninja ;d
 
Roel De Nijs
Sheriff
Posts: 10400
133
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Andrew Monkhouse wrote:(Yes, I well and truly overdid my submission.)

We try to encourage and convince people just sticking to the assignment and the must requirements, and not overcomplicate or do things which are not required. And then the author of the SCJD book homself makes such a statement
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic