Graphics server
Graphics in the Sphinx graphics server are composed of three parts:
- Graphic pack: An overall graphics project, which includes at least one editon published to either reuters.com readers or media clients through Reuters Connect.
- Archive: A ZIP file uploaded to the graphics server that includes one or more editions.
- Edition: Collection of files that make up an embeddable or editable graphic or a graphics page.
Graphic packs
Within the graphics server, a graphic pack looks like a collection of ZIP files with nested folders. ZIP files are archives and folders nested below them, editions.
Directorypublic.zip Archive
- interactive Edition
Directorymedia-en-page.zip Archive
- interactive Edition
- media-interactive Edition
Directorymedia-en-map.zip Archive
- interactive Edition
- media-interactive Edition
- PNG Edition
- EPS Edition
Directorymedia-es-map.zip Archive
- interactive Edition
- media-interactive Edition
- JPG Edition
- EPS Edition
Archives
Generally, archives represent individual graphics or a collection of HMTL pages that are published to one of the available publishing locations. An archive must contain at least one edition.
Directorymedia-en-page.zip Archive
- interactive Edition
- media-interactive Edition
On your local file system, archives are structured with an archive folder and one or more nested editon folders:
Directorymedia-en-page Archive
Directoryinteractive Edition
- …
Directorymedia-interactive Edition
- …
When using the publisher, archives will be named according to one of the following conventions:
public.zip
media-{locale code}-{slug}.zip
Locale codes are any valid language code like en
, de
or es
.
A slug is an ID used to identify the archive and the graphic it contains, like map
, bar-chart
or page
.
Editions
Editions represent a specific format of a graphic that can be published to one of the available publishing locations.
Root files
Each edition must also have a root file located at the root of the edition folder. The type of file determines what format of graphic the edition contains and will drive what publishing options are avilable on the graphics server.
When determining what is the edition’s root file, .html
files take precedence. Other commonly used root edition file types: .txt
, .jpg
, .png
, .pdf
. Note that if multiple files of the same type are present at the root, the first file added to the zip will be the root edition file. At present, it is not possible to control which file is added first.
Interactive editions
Directorypublic Archive
Directoryinteractive Edition
- index.html Root file
Directorymore-pages
- index.html
- …
Directoryassets
- styles.css
- scripts.js
- _gfxpreview.png Preview image
Interactive editions contain one or more HTML pages to be published on reuters.com.
The root file is index.html
.
In most cases, additional HTML files should be at least one directory deeper than the root edition file. CSS, JS and images can be at the same level as index.html
.
A _gfxpreview.png
or _gfxpreview.jpg
image must also be at the root of the edition folder, which will be used to preview the edition in the graphics server, Lynx and Reuters Connect.
Media-interactive editions
Directorymedia-en-page Archive
Directorymedia-interactive Edition
- README.txt Root file
- app.zip
- _gfxpreview.png
Media-interactive editions contain a ZIP archive of the project and represent a embeddable graphic that can be purchased on Reuters Connect or embedded into a reuters.com story in Lynx or Arc.
The root file is README.txt
.
A _gfxpreview.png
or _gfxpreview.jpg
image must also be at the root of the edition folder, which will be used to preview the edition in the graphics serve, Lynx and Reuters Connect.
Static file editions
Directorymedia-en-page Archive
DirectoryJPG Edition
- map.jpg Root file
DirectoryPNG Edition
- map.png Root file
DirectoryEPS Edition
- my-map.eps Root file
- map.jpg
DirectoryPDF Edition
- my-map.pdf Root file
Static file editions represent static image versions of graphics, like JPEGs and PNGs, or editable versions like EPS or PDF files.
The root file can be named anything but should be of the same file type as the name of the edition, e.g., PNG
-> map.png
.
Where editions are published
Editions are ultimately published to readers on reuters.com or to media clients through Reuters Connect.
Publishing options
Publishing options are available on individual embeds and determine if and where graphics are published.
Available locations
- Public RNGS : Published to a public URL on reuters.com (including embeddable graphics). This option is only available to interactive editions and JPG/PNG static file editions.
- Media : Published as a purchasable graphic on Reuters Connect. This option is only available to media-interactive editions and EPS/PDF static file editions.
Searchable
Editions can also be made Searchable in Lynx, which makes them available to embed in other reuters.com stories through embed tools in Lynx editor and Arc.