Opus   Opus 2.30 Publisher's Manual
   Product Overview
   Installation and Set Up
   Customising a Paper 
   Templates
   Using Datacards
   Using Objects
   Author Maintenance
   Activity Logging
   Technical Issues
    vp_article
     Opus Directories
     Table Definitions
    vp_author
    vp_paper
    vp_section
   Appendices

Note that text shown in this style documents a feature which isn't in the current release but will be in the next release and text shown thus indicates a feature which is being removed in the next release.

If you find anything in this documentation which is wrong or unclear then please use the link at the bottom on the page to comment and we will update the page to correct it or make it clearer.

Search:


vp_article

This table stores the individual articles - one row per article.

Name Type Usage
articlecode int(9) unique identifier for article. High articlecodes are used to store temporary copies of articles:
  • Articles in the range 800000000-899999999 are used to store quarantined copies of articles upon which you are working. So if you're working on article nnnnnnnn then, when you preview it, it's saved with an articlecode of 8nnnnnnnn.
     
  • Articles in the range 900000000-999999999 are used to store new quarantined articles upon which you are working. So if you're working on a new article then, when you preview it, it's saved with an articlecode in this range. Opus garbage collects articles in this range automatically.
papercode int(9) unique identifier for paper - cross references to vp_paper
sectioncode int(9) unique identifier for section within paper - cross references to vp_section
typecode char(3) type of article:
  "web" - web page
  "new" - news article
  "xdb" - database record
  "doc" - document
authorcode int(9) unique identifier for author - cross references to vp_author
headline tinytext the headline for the article (1-255 chars)
text mediumtext the article itself, up to 16MB (a type of "text" only allows 64KB and it's plausible that some articles could be larger - the next biggest size allowed by mySQL is 16MB!) )
datewritten date date/time article was written
timewritten time
approved char(1) article has been approved (Y/N) - this field is currently always set to "Y" but there has always been a plan to add an editorial option where non-trusted authors could write articles which would be held here with a value of "N" until approved by the paper's editor or the publisher.
dateapproved date date/time article was approved by editor (currently always the same as datewritten/timewritten)
timeapproved time
embargoed char(1) article is embargoed (Y/N)
dateembargo date date/time article is embargoed until (set to datewritten/timewritten if article isn't embargoed)
timeembargo time
expires char(1) article will expire (Y/N)
dateexpires date date/time article expires
timeexpires time
diary char(1) article is to go in diary (Y/N)
datehappens date date event will occur. We currently have no support for events which span more than one day, or repeated events.
timestarts time time event starts - set to zero if no start/end time
timeends time time event ends - set to zero if no start/end time
sent char(1) article sent to subscribers (Y/N) - another feature which isn't used yet, so always set to "N"
location tinytext location of event (for articles with diary = "Y")
visibility char(1) visibility of article (S)earchable, (N)ot searchable or (I)nvisible.
  • Searchable article are the vast majority of articles, which you want users to be able to find via the search engine.
     
  • Not searchable articles are articles which you want to be visible but you don't want to appear in searches. Typically these are pseudo articles, like a menu which is inserted in the template which you want to be editable so you make it an article.
     
  • Invisible articles are to all intents and purposes deleted. If you try to look at them Opus will claim they don't exist. However you can see them from the "Browse articles" option in the Author Menu where they are shown with their headline struck out and recovered by clicking on the "edit" link.
parentcode int(9) article code of this article's parent. This is used by some navigation schemes - for example the one used in this manual where this page is article 77 and its parent is 76.
mapurl char(40) apparent URL of this article if URL remapping is active. If this is blank the URL of the article will be opusnnn.html where nnn is the articlecode of the article.
document_name tinytext document filename if the article is a document (typedoc = "doc")
document_intro char(1) if set to "Y" then, if this article is a document, then anyone viewing it gets to see an introductory page first with a hyperlink to the document
auxfield1 tinytext auxiliary fields 1 through 4. You can create up to four auxiliary fields for each article and get authors to enter data into them. See this page for more information about this.
auxfield2 tinytext
auxfield3 tinytext
auxfield4 tinytext
headliner char(1) Whether or not the article is a headliner (Y/N) - if set to "Y" then the article appears above other news articles in the news page
real_visibility char(1) Used when articles are quarantined prior to publication
datedated date Date associated with an article (used by the {index} tag)
sortcode char(4) Experimental feature used by {index} tags
htmlarea char(1) Whether or not the article text was created using htmlArea (Y/N)
searchtext mediumtext The headline and article text stripped of tags and punctuation for search purposes.
searchmeta mediumtext searchtext converted to metaphones for search purposes.
dateamended date date/time article last amended.
timeamended time
parentsort char(20) Articles which have the same parent are sorted in order of parentsort followed by headline.

Comment on this page

Copyright
Privacy Policy