SCW - Technical_Specification_V0.1.doc - Smartcopying

assistantashamedΔιαχείριση Δεδομένων

29 Νοε 2012 (πριν από 4 χρόνια και 7 μήνες)

231 εμφανίσεις


Commercial in Confidence

S
MART
C
OPYING WEBSITE

Technical Specification






education.au

Page
i

Filename:

assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

Document Details

Document Name

Smart Copying website

-

Technical Specification

Revision

0.1

Author

Miles Tillinger

Creation Date

13 July 2007

Number of Time Edited

0

File Name

Technical.Specification.doc

File Path

C:
\
Documents and Settings
\
mtillinger
\
My
Documents
\
My Websites
\
Smart
Co
pying
\
Technical.Specification.doc

No. Of Pages

18
1, including the Cover, Revision History, and
Table of Contents


Amendment History

Date

Version

Comment

13/07/2007

0.1

Initial Draft


Related Documents

Document Name

Document

Owner

Version

Approvals


Name/Position/Organisation

Signature

Delia Browne

Project Manager / Director

National Copyright Unit






/ /



education.au

Page
ii

Filename:

assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

Thanh Tran

Project Manager

Education.au



/ /




education.au

Page
iii

Filename:

assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

List of Definitions

Term

Explanat
ion

Apache

A popular public domain, Unix
-
based Web server from the
Apache Software Foundation. It is considered the most widely
used HTTP server on the Internet.

Boolean

A Boolean value is a truth value; either “true” or “false”, often
coded 1 and 0, res
pectively.

Breadcrumbs

A trail of the users navigation path is displayed enabling users
to retrace there steps.

Content Management
System (CMS)

A content management system (CMS) is a computer software
system for organising and facilitating collaborative
creation of
documents and other content. A CMS is frequently a web
application used for managing websites and web content.

CSS

Cascading Style Sheets. A central file(s) that control the site
design and branding.

Hosting

Making a website available on the

Internet. Many ISP’s host
multi
-
page, commercial websites at a wide range of prices. A
single computer can hold dozens to hundreds of small
websites, while a dedicated computer may be used for one
large website.

HTML

A mark
-
up language used to structure
text and multimedia
documents and to set up hypertext links between documents,
used extensively on the World Wide Web.

Jahia

Jahia is an Enterprise Content Management server. It is 100%
Java based and the full source code is available under a
collaborativ
e source licence.

JavaScript

A popular scripting language that is widely supported in Web
browsers and other Web tools. It adds interactive functions to
HTML pages, which are otherwise static.



education.au

Page
iv

Filename:

assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

Term

Explanat
ion

Template

Pages in Jahia are created using a selection of temp
lates.
Depending on the site requirements there may be multiple
templates available to administrators’, each providing different
functionality and structure. A basic template is divided into
sections called containers and within each container you are
ab
le to add multiple portlets.


To see the template structure of a page, you need to have
‘write’ permissions and be in Edit Mode.


Portlet

To manage content within Jahia a number of different portlet
types have been created.


The idea is that when you ad
d a new portlet, you add the kind
of portlet best suited to your requirements. For example, a
Files portlet to add a file to a page, a RSS portlet to display
recently added items, a Links portlet to add an internal link to
another page within the CMS or a
n external link to another
website etc.




education.au

Page
v

Filename:

assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

Table of Contents

Smart Copying website

................................
................................
........

1

Technical Specification

................................
................................
........

1

1

Introduction

................................
................................
.....................

1

1.1

Background

................................
................................
................................
........

1

1.2

Assumptions

................................
................................
................................
.......

1

1.3

Constraints

................................
................................
................................
.........

1

2

Technical Design Overview

................................
............................

1

2.1

Solution Overview and Components

................................
................................

1

2.2

Environment configuration

................................
................................
................

2

3

Design Goals

................................
................................
...................

5

3.1

Web Standards

................................
................................
................................
...

5

3.2

Accessibility

................................
................................
................................
.......

5

3.3

Usability

Principles

................................
................................
............................

5

4

Style Guide/Design

................................
................................
..........

7

4.1

Style guide

................................
................................
................................
..........

7

4.2

Design

................................
................................
................................
.................

7

5

Templates file structure

................................
................................
..

8

5.1

HTML Structure

................................
................................
................................
..

8

5.2

CSS structure

................................
................................
................................
.....

9

5.3

DIV naming conventions
................................
................................
....................

9

6

Error Handling

................................
................................
...............

10

7

Help

................................
................................
................................

11



education.au

Page
vi

Filename:

assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

8

Amendments

................................
................................
..................

11





education.au

Page
1

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

1

Introduction

1.1

Background

This document has been produced to document the specifications required to develop
Smart Copying web site and CMS. The requirements that form this document were
captured during workshops with members from
education
.au

and the National
Copyright unit.


1.2

Assumptions

The following assumptions have been identified by the
education.au

project team:



The website content will be provided by the client, and will be uploaded by
education.au

prior to the product release.

1.3

Constr
aints

The following requirements are considered out of scope for the Smart Copying website
project.



Detailed requirements have not been captured for the development phase.
While a reasonable level of knowledge is known about the project’s
requirements,
e
ducation.au

is aware that the order of any possible future
development might change depending on business need and user feedback.
Due to this it is recommended that detailed requirements be captured and
reviewed before commencement of development.


2

Techni
cal Design Overview

2.1

Solution Overview and Components

2.1.1

Apache Tomcat

The default Jahia 5.0 Community Edition is distributed with an embedded Apache
Tomcat 4.1.24 application server.

2.1.2

PostgreSQL

The database platform used with the Jahia CMS will be PostgreSQL

7.3.6.

2.1.3

Jahia



education.au

Page
2

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

The chosen CMS for the Smart Copying web site is Jahia version 5.0 Community
Edition. The Jahia CMS performs a number of functions and a summary is provided
below. All functions will be described in detail in a Jahia End User Guide prior to

implementation. Jahia CMS provides the following:




Allows different levels of users to be able to manage the CMS



Allows edit/delete/update facilities of all CMS website pages



Provides numerous build templates. For example, Home Page, content
page. Thes
e templates also can be added, deleted and updated by the
appropriate users.



Provides numerous portlets in order to manage content effectively and
efficiently.



Workflow to allow an authorised content author to edit and preview pages
before they are publish
ed.



Contains file conflict management advising users that pages are locked or
being updated.



Has the ability to upload a number of standard file types (eg. Excel, Word,
PDF’s, media files etc.)



Provides an automatically generated site map.


Visit
www.jahia.org

for more information.

2.1.4

AWStats

The AWStats application will provide comprehensive statistics on site usage. At
production release, the statistics will be available at:


http://apps
-
2.edna.edu.au/awstats/awstats.pl?config=smartcopying


2.2

Environment configuration

2.2.1

Servers

Environment

Base URL

App
Server

DB
Server

Database Name

Development

(no external
access)

http://devel
-
smartcopying

d
evel

devel

devel_jahiasmartcopying

System
Testing

(no external
access)

http://systest
-
smartcopying

systest

otis

systest_jahiasmartcopying



education.au

Page
3

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

User
Acceptance
Testing

http://smartcopying.uat.edna.edu.au

Spo
ngeb
ob

otis

uat_jahiasmartcopying

Production

http://www.smartcopying.edu.au

Apps
-
2

apps
-
4

jahiasmartcopying


2.2.2

CVS Repository

All interface templates, portlets and associated JSP’s, will be stored in our Conc
urrent
Versioning System repository along with some parts of the Jahia source code that have
been modified for our needs.


2.2.2.1

Repository name

smartcopying

2.2.2.2

CVS Web


http://lithium/viewvc/smartcopying

2.2.2.3

The top
-
level repository folders




errors

Apache Tomcat error pages




resources

Jahia specific language files




templates

Jahia templates, portlets, images, styles, scripts and associated files.




validation

Configuration file defining validation rules


2.2.3

Directory Str
ucture

2.2.3.1

Application root

/usr
/local/jahia5_smartcopying/

2.2.3.2

Errors

/usr
/local/jahia5_smartcopying/tomcat/webapps/smartcopying/jsp/jahia/errors/

2.2.3.3

Resources

/var
/JAHIA/jahia5_smartcopying/



education.au

Page
4

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

2.2.3.4

Templates

/usr
/local/jahia5_smartcopying/tomcat/webapps/smartcopying/jsp/j
ahia/templates/smar
tcopyingsite/default/

2.2.3.5

Validation

/usr
/local/jahia5_smartcopying/tomcat/webapps/smartcopying/WEB
-
INF/etc/struts/




education.au

Page
5

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

3

Design Goals

The CMS will comply to the below design goals and standards.

3.1

Web Standards

Public interface must be made availa
ble as either standard HTML 4.01 or XHTML
1.1 as defined by
World Wide Web Consortium

(W3C) specifications

3.2

Accessibility

Public interface must achieve Conformance Level “AA” of the
Web Content
Accessibility Guidelines



Must

adhere to all Priority 1 Checkpoints



Must

adhere to all Priority 2 Checkpoints



May

adhere to all Priority 3 Checkpoints

3.3

Usability

Principles

Interface design process must employ a ‘pervasive usabil
ity’ principle, evaluating
usability at every stage of the design process whilst keeping in mind the goals of
the project and users’ needs.

3.3.1

Ease of Use



Sites must be intuitive to the end users
-

with minimal learning required to use
the site effectively



Us
er expectations should be met with regard to links, buttons and navigation
(i.e. what users expect to happen, actually happens, users know where they
are in the site)



Labeling (such as links) must be consistent across the site



Terminology used across the s
ite should be consistent with industry
standards



The site must be built to meet
education.au

GUI standards



Benchmarks for maximum clicks to required information

3.3.2

Speed

of use



Accepted screen response times, as determined by a benchmarking process
to be unde
rtaken during the planning phase



Web pages are painted in such a way to maximize the perception of a
responsive site



Once logged in, key (regularly used) functions should be one click away



Once logged in, important information should be displayed up front
(in the
initial viewing area)



education.au

Page
6

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

3.3.3

Effective

Appearance



Screen real estate is used effectively (e.g. not too cluttered, no excessive
white space)



Screens look good across 800x600 and 1024x768 screen resolutions



Key information is viewable within the initial vie
wing area of major screen
resolutions



Vertical scrolling should be minimized



There should never be any horizontal scrolling unless absolutely necessary



Use of interface design techniques that work appropriately in browsers that
adhere to W3C standards for
CSS, HTML and JavaScript i.e. IE5+, Firefox,
Netscape 7+ on Windows, Safari, Firefox on Mac OSX. Degrades gracefully
in browsers without complete support, i.e. Netscape 4.x & 6.x., IE 4.x, on
Windows, IE 5.2 on Mac OSX.





education.au

Page
7

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

4

Style Guide/Design

4.1

Style guide

T.
B.A

4.2

Design

T.B.A



education.au

Page
8

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

5

Templates file structure



images

o

icons
(for document types)

o

optimised images (gif, jpg, png)



include

o

portlets (.jsp)

o

other (.jsp, .inc))



scripts

o

javascript (.js)

o

behaviours (.htc)



styles

o

css (.css)

o

templates (.jsp)


5.1

HTML Structure

Site logo

Heading 1

Will use image replacement
technique to replace text
heading with logo

Page Title

Heading 2


Portlet Title

Heading 3


Content

Heading 3, 4, 5, 6





education.au

Page
9

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

5.2

CSS structure

basic.css

Defines the basic HTML formatting. This
style sheet will be used for

all browsers
and platforms.

layout.css

Defines layout and positioning for major
DIV elements. This style sheet will be
used for all browsers that support CSS2.

navigation.css

Defines layout and formatting for all
navigation items

This style sheet will
be used for all
browsers that support CSS2.

content.css

Defines layout and formatting for all page
content, eg.



Headings



Paragraphs



Lists



Images



Error text



etc.

This style sheet will be used for all
browsers that support CSS2.

macie.css

Defines styles sp
ecific to Internet Explorer
on the Mac OS. This style sheet will only
be used for Mac IE browsers.


5.3

DIV naming conventions

Header

header

Top Navigation

topnav

Left or Right

left or right

Page Title

pagetitle

Content

content

Footer

footer




education.au

Page
10

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

6

Error Han
dling

To provide a quality service to users, the website will provide customised error
messages for the following common web errors:


Error

Probable Cause

Message

401

The user is not authorised to access the
page, or has entered an incorrect username
and
/or password.

The server is looking for an
encryption key and is not
getting it, the wrong
password may have been
entered. Try again, paying
close attention to case
sensitivity.

403

The url accessed is incorrect, user was
misdirected to the page, the pag
e now has
restricted access or the session has expired,
in which case you need to log in again.

Special permission is needed
to access this site. Contact
the site administrator for
access.


404

Page has expired, moved, removed or
directed to the wrong ur
l.

The server cannot find the
file you requested, it has
either been moved, deleted,
or the wrong URL or
document name has been
entered. Check and try again
or contact the site
administrator if the problem
persists.

500

A server configuration/scripting er
ror.

The HTML document could
not be retrieved due to
server
-
configuration
problems. Contact the site
administrator


Please refer to
Error Page

regarding the layout of the error messages.



education.au

Page
11

Filename:
assistantashamed_0d24bf08
-
ac18
-
4933
-
b3b7
-
92413f9d35dc.doc

7

Help

Help text information will be
available to administrators of the CMS. The link to help
content will appear once the administrator has logged in and is in edit mode. This will
ensure that the content is only available to the appropriate people (administrators).
Content help regarding

the site or information to users will be added by administrators
using the general CMS functionality (ie appropriate portlets and templates).


8

Amendments