Functional spec on articles page
Version control
Version
V1.0
Date
Changed by
Eugenia
Comments
Initial draft
Content
1.
Objective ......................................................................................................................................................................................... 2
2.
General functionality ....................................................................................................................................................................... 2
3.
Users of the Articles pages .............................................................................................................................................................. 2
3.1.
User Access and rights ................................................................................................................................................................ 3
4.
Entity Definitions ............................................................................................................................................................................ 3
4.1.
Article attributes ......................................................................................................................................................................... 3
5.
Poetry/Prose attributes ..................................................................................................................................................................... 5
6.
Picture Gallery attributes ................................................................................................................................................................. 5
7.
Look up............................................................................................................................................................................................ 5
7.1.
Article Categories and Subcategories ......................................................................................................................................... 5
8.
Pages Layouts .................................................................................................................................................................................. 6
8.1.
Art page ...................................................................................................................................................................................... 6
8.2.
Art page – Subcategory............................................................................................................................................................... 7
8.3.
Linking to poetry/prose ............................................................................................................................................................... 7
8.4.
Poetry/Prose page ....................................................................................................................................................................... 8
8.5.
Painting subcategory ................................................................................................................................................................... 8
8.6.
Painter’s Gallery ......................................................................................................................................................................... 9
9.
Entity relationships .......................................................................................................................................................................... 9
10.
Archive ......................................................................................................................................................................................10
11.
Search Articles ...........................................................................................................................................................................10
11.1.1.
Search Criteria ......................................................................................................................................................................10
11.1.2.
Deep Search ..........................................................................................................................................................................10
12.
Dependencies .............................................................................................................................................................................10
13.
Sorting .......................................................................................................................................................................................10
14.
Archival .....................................................................................................................................................................................10
1
1. Objective
Article pages at republicofarmenia.com will allow users to register new article on various themes, browse and read them.
2. General functionality
Article pages will allow to see (browse)/add/edit/delete news and articles.
A prior posting any articles the publisher has to register company/newspaper/magazine and obtain RA Administrator’s approval.
Once article is completed, writer will submit it for editing. Writer can submit it to multiple editors, but only one of them will be
Default Editor.
Article will be published on the site, once it has been approved by an editor, unless the article is written by Trusted Writer. In the case
if the independent writer articles can be reviewed be multiple editors, but only one of them will be the responsible/default Editor.
For all independent writers there will be default publisher (e.g. UNKNOWN publisher) within the database.
All approved and published articles will be forwarded/emailed to RA Admin.
3. Users of the Articles pages
Anonymous
Writer
Trusted Writer
Editor
RA administrator
User
Anonymous
Definition
Membership approval
Block
membership
Anonymous is unknown (anonymous)
person with no profile
Can only write new articles and edit
his/her own unpublished articles.
A Writer is able to submit articles to
some categories, but is not able to make
them appear on the website. Also, once a
Writer has submitted an article, it cannot
be modified by anyone other than an.
Can write new articles and publish them
live to the website
A Trusted Writer is able to create articles
in some categories, and can make them
visible on the website. Also, this user may
see a list of any articles that they've
created. Any of these articles may be
modified or erased
Able to approve articles written by
writers
An Editor has full control over some of
the categories on the site. This user may
modify and delete any articles in these
categories. An Editor may also view
articles that have been submitted by
Writers, these articles will have a status
of "pending". By modifying these articles
and changing the status to "visible", the
Editor can approve these articles and
make them display on the website.
n/a
n/a
Registration will be
confirmed by RA
Administrator
Can be blocked by
RA Administrator
Registration will be
confirmed by RA
Administrator
Can be blocked by
RA Administrator
Registration will be
confirmed by RA
Administrator
Can be blocked by
RA Administrator
RA Administrator
Administrator at republicofarmenia.com
n/a
n/a
Publisher
Writer who administrates given
publishing, must approve its writers and
the articles written by them.
Registration will be
confirmed by RA
Administrator
Can be blocked by
RA Administrator
Writer
Trusted Writer
Editor
Comments
Writers all articles
must be approved
by an editor or
administrator before
they will be
published
2
3.1.
User Access and rights
Function
Anonymous
Browse1 and query
news and article
databases
Browse2 and query
Publisher databases
Add new Publishing
company /Agency
Writer
Trusted
Writer
Y
Y
Y
Y
Y
Edit/delete existing
Publisher information
Publication that need
Editor’s approval
User
Editor
Comments
Publisher
Admin
RA
Administrator
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
N
Y
Y
Y
Y
Y
Y (only its
writer’s
postings)
Should register
publishing
company/agency
first
Y
Can
approve/disapprove
Writer’s and
Trusted writer’s
postings
Add new user in any
given category
(Writer, Trusted
writer, Editor)
Contact Editor
Y
Y
Y
Y
Approve writer
Y
The editor will
receive an email
notification to
check and approve
the new posted
article
Y
RA Administrator:
RA Administrator has full access to everything. In the case of edit/delete admin should be able to send a note notifying the article
owner on the changes. In the meantime there wall be an option of changing article without any notification (in the case if people write
some garbage). “Users agreement" should cover these cases.
RA Administrator should be able to see the list of all new articles/news. Publisher info should not be shown unless it has been
approved. In the meantime if Publisher info once has been approved, but later has been changed, then the Publisher info can be
changed immediately on the site, but RA Administrator should receive a notification to be able to track any violations.
RA Administrator should be able to block any users (with given email address) from adding/changing Publisher information as well as
their postings.
4. Entity Definitions
Articles – materials that have no time limits, and in most cases are very general (articles about poets, artists, history, language etc.)
4.1.
Article attributes
Attribute
Mandatory/Optional
Format/Default values
1
Browse by Country, City, Article Name, Media type, published date, subject
2
Browse by Country, City, Publisher Name, Media type
Comments
3
Date to be published
Time to be published
Title
Type
Mandatory
Mandatory
Mandatory
Mandatory
Category
Mandatory
Subcategories
Mandatory
Content Status
Mandatory
Publishing Status
Mandatory
Article type
Mandatory
Subject
Importance Score
Mandatory
Mandatory
Stay active
Optional
Date
Depreciation factor
Optional
Number
Language
Summary
Content
Photo
Mandatory
Mandatory
Mandatory
Optional
Lookup languages
Picture Gallery
Video
Optional
Optional
Audio
Optional
Poetry/Prose
Optional
Date created
Last updated
Publisher
Writer
Mandatory
Mandatory
Mandatory
Mandatory
Editor
Link
Mandatory
Optional
Article
General article*
The default value for
every article is “Article”.
General article is inserted
only by RA Admin. It can
even be fixed in html
code
List of categories is given
below
List of subcategories is
given below
Approved-visible
Approved-hidden
Pending
Not-approved
Visible
Hidden
Full Article
Abstract
Min - 0
Max - 100
Available only for
literature category
This score will be used to
sort articles in the front
page
Set explicitly date whey
the article will be
deactivated, i.e. archived
Depreciate importance
score every day.
Abstract of the article
Main text
Multiple occurrences.
Dynamically can be
added any time. No limits
For painting subsection
Multiple occurrences.
Dynamically can be
added any time. No limits
Multiple occurrences.
Dynamically can be
added any time. No limits
Multiple occurrences.
Dynamically can be
added any time. No limits
Generated automatically
Generated automatically
Users see this as an
author of the article.
Link to other related
article (5 articles); this
4
will be done by Editor.
* For each subcategory there should exist one General article, describing the theme of category. E.g. On the
main page of Literature subcategory there should be a brief article about Armenian literature. This type of
articles will appear on the main page of each subcategory, and will be written and edited by RA Admin.
Article will be stored on static pages. Please note articles will not be changes. In the meantime there should be
entries in the database to allow querying all articles.
Query can be done based on combination of the following field: Country, City, Article Name, Media type,
published date, and subject.
Also, while reading articles/news users should be able to choose similar articles, or articles written by the same
author.
There should templates to present articles. Article pages should be based on style sheets, i.e. there should be a
way of changing article layout and color scheme without touching every page.
5. Poetry/Prose attributes
Attribute
The name
Poem/Prose
Writer
Year written
Mandatory/Optional
Optional
Mandatory
Mandatory
Optional
Description
The poem/prose itself
6. Picture Gallery attributes
Attribute
Mandatory/Optional
Picture
Author
Title
Mandatory
Mandatory
Mandatory
Owner
Optional
Article
Mandatory
Location
Description
Optional
Optional
Source
Optional
Date created
Optional
Date posted
Mandatory
Format/Default
values
Comments
String
String (up to 200
chars)
In case the picture
now belongs to certain
person
To which article this
gallery is linked to
String (up to 2000
chars)
Is used in case the
picture is taken from
some other site
Date when the original
has been created (e.g.
Generated
automatically
7. Look up
7.1.
Article Categories and Subcategories
Category name
Art
Subcategories
Literature
Section
Comments
Art
5
Culture
Entertainment
Sport
Politics
Economy
Science
State
Government
Military
People
Painting
Wood Craft
Photo
Miniatures
Music
Textiles
Metalwork and
Engravings
Art
Art
Art
Art
Art
Art
Art
Religion
Language
Culture
Culture
History
Cuisine
Architecture
Holidays
Sculpture
Culture
Culture
Culture
Culture
Culture
Can contain linking to
poetry/prose
Info
Info
Info
Info
Info
8. Pages Layouts
8.1.
Art page
Art page - main
[Sections]
Literature
Painting
Photo
Wood Craft
Miniatures
Music
Textile
Metalwork
and
Engravings
Art page
List of subcategories available with their illustrations
The last articles
posted:
One article from
each subcategory, i.e.
8 articles
Third party
ads, banners,
6
etc.
8.2.
Art page – Subcategory
Art page – Subcategory main page
[Sections]
Literature
Painting
Photo
Wood Craft
Miniatures
Music
Textile
Metalwork
and
Engravings
Art page/Literature/General article about Armenian literature
Literature articles
General article about this subcategory, i.e. Armenian literature in
brief description.
General articles for each subcategory are provided by RA Admin
Third party
ads, banners,
etc.
8.3.
Linking to poetry/prose
Art page – Certain article chosen
[Sections]
Literature
Painting
Photo
Wood Craft
Miniatures
Music
Textile
Metalwork
and
Engravings
Art page/Literature/Literature Article 1
Literature article 1
Literature article 2
Literature Article 1
Literature article 3
Article text
[Linking to poetry/prose]
Writer:
Editor:
Date, time, etc.
Third party
ads, banners,
etc.
7
8.4.
Poetry/Prose page
Art page – Certain article chosen/Poetry
[Sections]
Literature
Painting
Photo
Wood Craft
Miniatures
Music
Textile
Metalwork
and
Engravings
Art page/Literature/Literature Article 1/Poetry
Literature article 1
Literature article 2
Literature Article 1
Literature article 3




Poem/prose 1
Poem/prose 1
Poem/prose 1
Poem/prose 1
Poem/prose 1 title
Poem/prose 1 text
Third party
ads, banners,
etc.
Author
Year written
By default in this page there’s shown just the list of poetry/prose. The table containing certain poem/prose
appears after choosing the appropriate poem/prose.
The other subcategories have the same structure.
The pages which differ are shown below
8.5.
Painting subcategory
Art page – Certain article chosen
[Sections]
Literature
Painting
Photo
Wood Craft
Miniatures
Music
Textile
Metalwork
and
Engravings
Art page/Painting/Painting Article 1
Painting article 1
Painting article 2
Painting Article 1
Painting article 3
Article text
[Linking to Gallery]
Writer:
Editor:
Date, time, etc.
Third party
ads, banners,
etc.
8
8.6.
Painter’s Gallery
Art page – painter’s gallery
Sections:
Painting
Literature
Article
Painter
1
Article section header/Article Painter 1/Gallery
Article
Painter 2
Article
Painter 3
Description, description, description, description, description, description.
Year: ####
[Location]
<< previous
next>>
9. Entity relationships
Entity relationships:
Publisher – Writer: one-to-many (Publisher could have multiple writers; each writer is attached to one publisher)
Publisher – Article: one-to-many (Publisher could have multiple articles; each article belongs to certain publisher)
Editor – Article: many-to-many (Editor can edit multiple articles; each article can be edited by multiple editors, but only one of them
will be Default Editor)
Editor – Writer: many-to-many (Editor can supervise multiple writers; each writer can be supervised by multiple editors).
9
10. Archive
Users should be able to browse and query archived article.
Articles in the archive can be browsed or queried by Country, City, Article Name, Media type, published date, and subject.
By browsing articles users will get name of the articles and by clicking to those they will get the full description
The trick is we have to store the links into database and than query.
11. Search Articles
11.1.1. Search Criteria
Keyword search is based on the following fields: Title, Summary.
11.1.2. Deep Search
The associative rules will be kept in the database. Each word could have multiple associations (N-M; many-to-many relationship).
Also consider multiple word associations. This thesaurus will be maintained by RA_admin: add/remove/edit privileges.
NB: In the future we could have some king of interface allowing entering new associations (for now we can insert records into the
database table directly).
NB please note, each word can have multiple associations and each of these associative words will have their own synonyms and so
on. In order to avoid unlimited recursion there should be a parameter allowing us to limit the depth of the search.
12. Dependencies
Publisher Data described in this spec is linked with business pages, i.e. publisher is a registered company
13. Sorting
Sorting of the articles done based on the importance score, published date etc. (will be discussed and confirmed later).
14. Archival
Importance Score can be decreased everyday by certain depreciation factor, which can be defined for each article The simple formula
could be: <Importance Score Today> = <Importance Score Yesterday> - < Depreciation Factor>
10