Core Publisher Content Import

Size: px

Start display at page:

Download "Core Publisher Content Import"

Merry Russell
6 years ago
Views:

1 Core Publisher Content Import As part of the Core Publisher on-boarding process, stations can import archived content into their new Core Publisher site. Because of the station effort required to prepare content for import, DS recommends that stations run a content analysis to determine how actively end users are accessing their archive. Stations should evaluate whether it makes sense to manually migrate their most popular archive material or to proceed with the larger content transfer described in this document. The content import process will require technical development skills at the station to successfully transfer content. Stations lacking internal technical expertise must contract out this work at an additional expense to their station. Please note the entire content import process can take between 4 and 7 weeks to complete, and the content transferred is not imported into the NPR API. Content is only imported into the station s Core Publisher site. Your Digital Services Station Support Manager will walk you through the 4 steps to transferring your content archive into Core Publisher. 1. Station prepares the content that they want imported by putting that content into a standard XML file format described in detail below. 2. DS Support Manager provides the station with access to a content import checker to review for possible errors in the XML file that will result in corrupted content. The station must fix all errors before submitting their XML file for importing. This import checker is described in detail below. 3. DS Support Manager will import the content into the station s Core Publisher site. 4. Station must review and verify the content in their Core Publisher site. Step 1: Building the XML File The XML schema for station content is below, followed by an explanation of each field. Typically a station will ask one of its developers or contractors to export desired content from the station s existing website or content management system. That export will then be converted into this schema. This developer should have knowledge of the station's current website or content management system, and understand how to create a valid XML file from that content to conform to the XML schema below. For more on XML you can refer to the W3C at <DSnprml version=0.01>

2 <storylist> <story> <title> </title> <teaser> </teaser> <slug> </slug> <text><![cdata[ ]]></text> <textwithhtml><![cdata[]]> </textwithhtml> <image primary=true/false order=n> <url> </url> <caption> </caption> <credit> >/credit> <agency> </agency> </image> <audio primary=true/false> <description> </description> <url></url> </audio> <category id=n> </category> <tag> </tag> <publisheddate> </publisheddate> <lastmodifieddate> </lastmodifieddate> <author id=n> </author> </story> </storylist> <categorylist> <category id=n> <title> </title> <description> </description> </category> </categorylist> <capacitylist> <capacity id=n> <title> </title> <description> </description> </capacity> </capacitylist> <peoplelist> <person id=n>

3 <name> </name> <capacity id=n> </capacity> <title> </title> <biography><![cdata[]]> </biography> <image> <url> </url> <caption> </caption> <credit> </credit> <agency> </agency> </image> < > </ > <facebook></facebook> <twitter> </twitter> <googleplus></googleplus> </person> </peoplelist> </DSnprml> DSnprml - The Digital Services of National Public Radio Markup Language, which defines how a group of stories and story related data is imported into Digital Service's Core Publisher. The version is updated by NPR Digital Services. storylist - The container for a list of stories. story - An individual story in the list. There can be one or more stories in a story list. title - The headline for a story. Required. teaser - A short description of the story, often the first 150 characters of a story's body. slug - A short (2-4 words) highlight for a story. Required. 50 characters max. text - The plain text content of a story. No markup is allowed in the text. Used when textwithhtml is not present, and for search indexing. This element should be wrapped in a CDATA sub-element. Though not required it is recommended that this field be supplied. textwithhtml - The text of a story with any available HTML. Images and audio elements can be defined with the image or audio element to be displayed outside of the body of the story in Core Publisher. This element should be wrapped in a CDATA sub-element. image - A story may have zero to many images related to a story. Currently these will be displayed in a lightbox/slide show outside of the story's body. The largest possible version of an image should be used,

4 Core Publisher will resize the image to the appropriate size for display. It's best to supply the largest most detailed version of an image. primary - Each story with images should have 1 image designated as the primary image. This image will be displayed in the river of news and other places where there is a single image displayed as a pointer to the larger story. If this is omitted the first image in the list will be treated as the primary image. If no images are contained in an image list, the first image appearing in the textwithhtml element will be treated as the primary image. order - This is the order for the slide show that images are desired to be displayed. If no order parameter is set, then top-down will be assumed as the story element is parsed. url - The current publicly available URL of the image. Core Publisher will extract the image from this address and copy it to the Core Publisher platform. caption - A short caption for the image, this will also be used as an alt-tag for the image for accessibility. Truncated at 128 characters. credit - Typically the creator of the image. Truncated at 128 characters. agency - The organization or owner of the image. Truncated at 128 characters. audio - A story may have one or more audio files related to a story. Audio will be served from where they are hosted prior to importing into Core Publisher. Currently audio files must fit this format: File Size < 75Mb File Type = mp3 Sampling Rate = 44.1kHz Bit Rate = 64 kbps mono or 128 kbps joint stereo primary - Each story with audio should have 1 audio file designated as the primary audio file for the creation of podcasts. If this omitted the first audio file in the list will be treated as the primary audio file. description - A brief description of the audio file. url - The current publicly available URL of the audio file. Core Publisher will serve the audio file from this address. category - Each story can be categorized with only one category. id - The id should correspond to an id of a category element presented later in this document. tag - A free form text tag to help categorize a story. publisheddate - The original date of publication for this story. Date format should be yyyy-mm-dd hh:mm:ss. lastmodifieddate - The last date this story was modified if available.

5 author - An author can be free form text id - An ID can also be used to denote an author element that will be described in this document. categorylist The container for a list of categories. category - Categories for stories are site-wide taxonomy terms that are used for grouping of stories. Categories can be presented in the main navigation menu on Core Publisher. id - Each category should have a unique ID to be used in the story element to refer to this category. title - A brief title for a category, i.e. "World News", "Economy", "Entertainment". description - A detailed description of the category. capacitylist - The container for a list of roles at the station. capacity - Capacities are site-wide taxonomy terms that are used for grouping people roles at the station. id - Each capacity should have a unique ID to be used in the person element. title - A brief title for the role, i.e. "Author", "Radio Host". description - A detailed description of the capacity. personlist - The container for a list of named people at the station. person - Person elements with a unique id to enable an author element to be related to a story element. A person element can be used to describe an author or a radio host or a person behind the scenes of a station. id - Each person should have a unique ID to be used in the story element. name - The name of the person. capacity - The type of job the person performs. This is used to aggregate authors and radio hosts and other groups of people, i.e. "author", "host", "board member", "vice president". The id should correspond to an id of a capacity element presented above. title - The job title of the person. biography - The person's biography. This element should be wrapped in a CDATA sub-element. image - A person may have an image displayed with their biography. url - The current publicly available URL of the image. Core Publisher will extract the image from this address and copy it to the Core Publisher platform. caption - A short caption for the image, this will also be used as an alt-tag for the image for accessibility. credit - Typically the creator of the image. agency - The organization or owner of the image.

email - The person's email address. facebook - The person's Facebook page url. twitter - The person's Twitter handle. googleplus - The person's Google+ information.

6 - The person's address. facebook - The person's Facebook page url. twitter - The person's Twitter handle. googleplus - The person's Google+ information. Step 2: Run the Import File Checker In your Core Publisher instance, navigate to Configuration -> PI Utilities -> Verify External Content. Click on the File Upload Page link to add the XML file you want to import. Either click Add file or drag and drop your file onto the page.

7 Return to the Verify External Content page, select which file you wish to validate and click Verify.

8 If there are XML errors, you will see a screen with warnings showing line numbers in the file where XML parsing failed. You must correct these errors before proceeding.

9 Once XML errors are fixed, you will see a count of stories, categories, people, and capacity records. If there are problems with the content itself, you will then see an additional set of errors with line numbers from the file. You must correct these errors before proceeding.

11 When you re done. You will only see a success message with information on the content contained in the file. Step 3: Send Your XML File to NPR Digital Services Your Station Relations support manager will import your file into your Core Publisher site for you. Step 4: Verify Your Content Your Station Relations support manager will notify you when content import is complete. You should then verify the content to make sure it matches your expectations. If there are errors, you will need to fix the contents of your XML file and go through each of these steps again. Your Station Relations support manager will remove content from the previous import for you.

WPM for Departments Using WPM to Edit Your Department s Website

WPM for Departments Using WPM to Edit Your Department s Website Overview Web Profile Manager allows Ithaca College community members to easily edit department sites. All of the specialty language and code has been omitted to provide a consistent format and to make