openNewspaper¶

Articles¶

Any newspaper consists of a number of articles. The article is the basic building block of a newspaper.

A typical article consists of a header, a kicker, a teaser and/or an introduction, and the article text. However, any article, especially online articles, can consist of many more elements. In openNewspaper these elements are called Extras or “web elements”. These Extras are placed in an article before or after paragraphs of text. Placing Extras in an article is called placement.

Default extra placement¶

Usually, an article should have a certain number of predefined extras. For example every article could be required to have an image. The extras required for articles might change depending on the sections the article is in - in the commentary section articles may have no image.

For that reason it is possible to define the extras that are associated with an article by default, per section. The position of the extras in the article is also defined per section.

Not only does the default placement depend on the section an article is in, but also on the type of article. For instance, an interview might be required to always display a short biography of the interview partner, while a standard article would not. To distinguish the type of article and subsequently the correct default placement, the user can define an article type and the corresponding default placement.

Sections¶

Articles are grouped into sections. When the reader visits a landing page for a section on the website, he or she expects to see a list of articles belonging to that section.

The articles belonging to a section are managed in Article lists.

Sections can be arranged in a tree-like structure. The "Politics" section may have national and international politics as subsections. Only articles from the "National" section can appear on the landing page for the "National" section, but articles from both "National" and "International" can appear on the "Politics" landing page.

A section is comprised not only of a landing page, but also of other pages.

All sections are usually grouped under a root section. The landing page of the "root" section is the "Start" or "Home" page of the online newspaper. Articles from all sections can appear on the "Home" page.

An article can belong to more than one section, if required. That way an article can appear both in the "Politics" and "Culture" sections, for example. Which articles actually appear on a section landing page, is a matter of editorial decision. The articles and their order are managed in article lists.

Often the articles should appear simply in the order in which they were published, with the newest at the top. But even in this case it may be necessary to tweak the order in which they appear. For that reason these lists are called semiautomatic. In other cases the order of articles is determined entirely by the editor. These article lists are called manual.

Pagetypes and Pagezones¶

Examples for the most common pagetypes are the section- and the articlepage. There may be other possible applications, such as a dedicated pagetype for your marketing pages. Pagetypes serve as a container to which you can assign pagezones.

Examples for pagezones are a main column and a smaller column on the right side of your page. While this may be a desired setup for your section and article pages, you may want your marketing page to use only one pagezone with a center column.

In the example below we would create two pagetypes for the article page and the section page and assign the pagezones maincolumn and rightcolumn . We would create an additional page type for the marketing page and assign the pagezone centercolumn . We would then use the openNewspaper placement module to place extras inside these pagezones .

Tutorial --------

Create an article type¶

In the TYPO3 list module open the Newspaper sysfolder, select the sysfolder Articletype and create a new record Article type . You have to specify a title and an internal name (only lower case letters) for TSConfig usage.

Create page types¶

As in creating article types open the Newspaper sysfolder, select the sysfolder Pagetype and create two new records of the type Page type: Sectionpage and Articlepage . For the Articlepage set the Associated GET variable to art .

Create page zone types¶

As above create two p age zone types , Maincolumn and Rightsidecolumn . Then create one additional Page zone type named ArticleDisplayArea . This p age zone type will be used by openNewspaper to render the article and thus should have the box checked: Can contain articles .

Create preview page¶

Create a page somewhere in your page tree and name it Preview . Check the ID of that page, than go to list view and add the following TSConfig code on your openNewspaper root page:

newspaper.be.previewPageUid = 38 #Substitute your corresponding ID

Create dossier page¶

Create a page somewhere in your page tree and name it Dossier . Check the ID of that page, than go to list view and add the following TSConfig code on your openNewspaper root page:

newspaper.dossier_page_id = 39 #Substitute your corresponding ID

While you are here, also set the get parameter for the dossier article list. We will use this later to get all articles for a particular control tag (see below).

newspaper.dossier_get_parameter = dossier

Create sections¶

You can easily create section by using the wizard provided in the openNewspaper Section-Module. Please see the explanation below regarding the choice of manual and semi-automatic article lists .

We suggest the following section for demonstration purposes:

Start

• Regional
  • Utopia
  • Metropolis
• International
  • Politics
  • Economics

Creating sections manually ~~~~~~~~~~~~~~~~~~~~~~~~~~

If you wish to know more about how newspaper records are mapped to TYPO3 pages, you can follow this guide to manually create some sections. It will provide you with a better understanding of openNewspaper and introduce some some advanced topics such as template sets and pagezones.

Render openNewspaper extension output¶

You will have to implement a way to render the plugin output on your TYPO3 pages. I.e. you can do this by using the automaketemplate extension.

At this point you should have a very basic front end, displaying a simple list with your sections and some output written by the templates.

Configure Parameters¶

You must set the image sizes according to the template you plan on using. For details on more TSConfig parameters, please refere to the corresponding section in this manual:

#Define image dimensions
newspaper.image.basepath = uploads/images
newspaper.image.size.teaser = 200x100
newspaper.image.size.kicker = 400x200
newspaper.image.size.article = 400x200
newspaper.image.size.popup = 800x400
newspaper.image.size.preview = 100x50
newspaper.image.size.micro = 20x10

Basic Content Placement¶

Navigate to the openNewspaper extension and select Content Placement . Now select the Start page and make sure the dropdown menus on the far right are set to Page = Sectionpage and Pagezone = Main Column". Then create a new extra by clicking the bottom and choose an extra Section overview in the appearing box. This will lead you to a box allowing you to specify some other options, such as adding a description, controlling the number of articles displayed in the overview up to defining a custom template. Ignore these for now, save and close.

Now navigate to the Main Column of the Articlepage in the drop down menu to the right and place an extra Article Display Area . As above for the Sectionpage the checkboxes will allow you to pass the created Article Display Area to the pages below. In combination with the checkbox Show this functionality can be used to easily customize all your front end pages, while maintaining the ability to easily change every single one of them.

While we are here, take note of the checkboxes Show and Pass down . These control whether an element is passed down to the next page beneath it (or even sideways - see TSConfig options) and whether it is shown on the current page. If a descendent page inherits an extra it can be configured in the same way. This will allow you to place all your regular elements on the start page and simply configure deviations down in the page tree if you wish to do so.

Publishing Your First Article ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

It is time to publish your first article. At this point this should just give you an idea of how the application works and what the various elements (extras) are good for. Make sure you have chosen the workflow role Editor . You can change your role by using the selector on to upper right section of the TYPO3 administration interface, just next to the Clear cache button. Go to Production List and trigger the button New article . This will start the Create Article wizard. Select one of the subsections we created earlier, i.e. Utopia. Up to now we have but one Article type, so select it and hit Go .

Now you should be in the article editor. Take a look around. Note the Web Elements tab and see the various extras you can utilize in your article just as you would on pages. Give your article a tag, such as tutorial . As we haven't got any other articles yet ignore the option Related articles for now and just leave a workflow message. In the Article tab fill in the required fields and hit Send to duty editor . This will close the editor and return your to the production list.

Now change your active role to that of Duty Editor by clicking the icon on the upper right corner of the window. The Production list should now show the article you just sent for review to the Duty editor . Hover above the article and note the various icons appearing over it: Publish, Placement (only visible as Duty Editor), Preview, Edit, Trash and Show all messages . For now lets publish the article.

Now take a look at the front end. If you go to the section Utopia you should see title and teaser of the article you just published. Following the link should take you to the articlepage displaying your article.

We suggest you take some time to familiarize yourself with the article editor before you head on. Create some articles, place web elements in them and place the articles in various sections.

The Production list is a central piece of the openNewspaper application. Most actions editors perform start here. Above you published your first article. Navigate to the Production list to see it. If you can't find it that is probably due to the filter settings on the far right of the screen. Adjust your filters accordingly and familiarize yourself with this tool. As soon as you have multiple editors publishing every day you will need it.

Lets take a look on the various columns in the production list. The State tells you whether an article has been published or not. A published article will have a green background in this column. Note that the icon is a button for publishing an article or rescinding a publication. The column Article provides more information about the article, such as it's teaser, it's title, author publish date and the section in which it is appears. The last column Messages show the article history, including messages left by the editors and reviewers.

Now hover over an article and you will note various buttons appearing above it. A button for publish /rescinding, placement, article preview, editing the article, deleting it and expanding its workflow messages.

Section Overview and Article Lists """"""""""""""""""""""""""""""""""

By default article lists are semiautomatic. This means that they will automatically retrieve all articles that were placed directly (not subsections) in the section from which the users requested the article list. For example, placing a Section overview extra on the Start page and passing it down to the sections below will cause the front end to generate a list of all articles contained in the Politics- Section we created earlier.

Defining featured articles¶

Using the little arrows on the right of the article list you can assign o ffsets to an individual article. By default the articles will be listed in chronological order of their publish date. By assigning o ffsets to an article you can modify its natural order in the list. Giving an article an o ffset of +3 will cause the article to be displayed above the next three articles published after that article, but below the fourth.

Manual Article List¶

A manual article list allows you to define all the articles that appear in it. This is useful if you want to display a selection of articles from different sections. To configure a manual article list, return to the TYPO3 list view and edit the Start section under the sysfolder Newspaper->Section . Now change the Article list from s emiautomatic article list to m anual article list and save. Navigate to the Newspaper->Section list menu item and compare the Start section with another section. Note how the start section now features a little folder icon. Click the folder icon and enter the a rticle browser . This allows you to search for articles using various filter options (author, section and text). Utilizing the p lus icon you can add articles to the list you just defined. Close the a rticle browser and save your list. Navigate to your frontend and see the articles you just select appear in the list view.

Naturally you can control the order of m anual article list . Utilize the arrows to the right of the list in the backend to achieve this.

Custom Article List¶

Now let's say you wish to display a little box containing the first two articles of the Start page on every subpage of your site. Go to Content placement and place an extra Display a list of articles in the right column of your Start page. In the options set the list to start with the first article and stop at the second. Also give it a header like Featured Articles . Hit Save , refresh your front end and see the article list displayed as specified.

Article Placement¶

Navigate to the Article Placement via the production list. Hover over an article (for example Tutorial ) and use the placement button to access the placement module for this article. The article placement module first presents us with a brief summary of the article we are about to place. Then follows the articles main section selection. Utopia is specified here as we selected that section in creating the article. Click the Toggle view for automatic article lists link to edit the article lists for all sections that have semiautomatic article lists. Below there is also the manual article list for Start in case we want to feature the article there.

Now add the article to the section Politics, contained in the international resort and hit save. This will add another semiautomatic article list. Now we can modify the articles position in all these article lists. The process is explained above. Note that you have to utilize one of the buttons at the bottom of the screen to save your changes.

Control tag zones, tag categories, and control tags¶

This example should illustrate the usage of multiple control tag zones to display content corresponding to the control tags assigned to a specific article. Control tags are very useful when you want to group a lot of articles from various sections around a particular subject, for example the US elections 2012. We want to be able to a) generate an article list for this subject, and b) display specific elements for all articles of that subject.

We will create control tag zones in order to

• to display an image
• and provide information

according to the control tags assigned to the article.

First, create two control tag categories Dossier and Team. We could also do this with just one category, but it helps to start ordering your content right from the start. The dossier category will contain all tags used to group content around specific subjects. The Team category will serve as a repository for the team members and should illustrate a different use case for this feature. On the Newspaper sysfolder create two new records of the type Control tag category and name them accordingly.

Next we have to create the Control tag zones. As will be shown in a different section of this tutorial, the same Control tag zone can be used in different places on your site. Hence, we recommend to name these zones according to their assigned function as opposed to their layout. In this example we will create the control tag zones Dossier Teaser Image, Dossier List and Author.

Configure article list for control tags¶

If you haven't already done so, you will need to create a section to hold your control tags. Use the section wizard to create a section, i.e. Dossier . When you create a collection of articles for a specific subject, you may want to display all these articles in a list view. The Dossier section will serve as a dynamic page container to list articles according to their control tags . For this to work we must make sure that the TSConfig variables are set correctly and we will also have to alter the SQL query that generates the article list. Set these TSConfig parameters:

newspaper.dossier_page_id = 39 #Substitute your corresponding ID
newspaper.dossier_get_parameter = dossier

Navigate to the openNewspaper Section list module and choose the dossier list. Use the link below the update and save buttons to configure the article list. The field SQL table for listed articles should hold this SQL query.

tx_newspaper_article JOIN tx_newspaper_article_tags_mm ON tx_newspaper_article.uid = tx_newspaper_article_tags_mm.uid_local JOIN tx_newspaper_tag ON tx_newspaper_article_tags_mm.uid_foreign = tx_newspaper_tag.uid

The field below SQL Condition for listed Articles should hold this line:

tx_newspaper_tag.uid = $dossier

Make sure the name of your $dossier variable corresponds to the defined get parameter in your TSConfig.

Now we are ready to create the control tags . Use the openNewspaper control tags module to create three control tags . When first navigating to the module, us the dropdown on the upper right and choose Create dossier . Create a control tags within the Dossier category. For example US Election 2012 and one additional control tag John Doe in the Team category.

We can now configure our control tags . Use the dropdown again to switch to the Manage control tags function. Start with your US Election 2012 tag in the Dossier category. Note the tag zones you defined earlier under the Unused tag zones area. Add the d ossier Teaser Image tag zone to the Active tag zones area. A wizard will now guide you through the process of assigning an extra to your tag zone. Create an extra of the type image and upload an appropriate image. Next, add your Dossier List tag zone . Choose the extra Display a list of articles and select your Dossier section in the wizard.

For your John Doe tag use the Author zone you defined earlier and use an extra of the type Biobox .

You can use the Assign to articles function to assign your tags to multiple, existing articles. In the regular process your editors will probably use the function within the article wizard to directly assign tags while writing articles.

Navigate to the Content placement module and choose the article page and the appropriate pagezone of the section where you want your content to appear. In this example we will use the right column of the article page to place the control tag zones . Use the New extra button to create the control tag zones and choose your configured zones from the drop down. Note, that you can define a default extra in case your article doesn't feature any control tag assigned to this tag zone.

Congratulations! You just defined your first control tag zones . The image below should serve to further clarify how your content will be shown according to the tags assigned to an article.

Place the control tag zone on a page ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Using the openNewspaper Content placement module we will now select an article page and place the Dossie Image control tag zone in the right column of an article page. This will cause the image we just uploaded to be displayed on every article tagged election 2012 .

Conclusions¶

This concluded the quickstart tutorial. It's purpose is to provide a quick entry to the functions provided by the application. openNewspaper offers a wide variety of functions, which, when combined correctly, offer you a whole set of functions designed to provide a maximum amount of automation while, at the same time, retaining the possibilities to adjust functionality, layout and design at all levels. For this purpose subjects such as inheritance, templates, template sets, page zones, automatic and semi-automatic article lists, further TSConfig parameters and other subjects have to be elaborated. Please refer to the corresponding sections in this guide if you want to know more.

tx_newspaper.use_lorem¶

tx_newspaper.article_source.browser_width¶

newspaper.be.hideExtra.[extra class name]¶

newspaper.accessArticleTypes¶

newspaper.accessSources¶

newspaper.article.defaultSource¶

newspaper.articleWizard.hideControlTags¶

newspaper.baseSections¶

newspaper.baseSectionsAsStartSection¶

newspaper.defaultRole¶

newspaper.dossierWizard.showDossierUid¶

newspaper.editorMayPlace¶

newspaper.editorMayPublish¶

newspaper.hideRoleSwitchModule¶

newspaper.webmasterWizards¶

newspaper.articletype.[normalized articletype name].musthave¶

newspaper.articleTypeAsUrl¶

newspaper.articletype.[normalized articletype name].shouldhave¶

newspaper.be.dossierWizard.default.[Extra table].[field]¶

newspaper.be.extra_in_article_mode¶

newspaper.be.previewPageUid¶

newspaper.article.defaultSource¶

newspaper.horizontal_inheritance_enabled¶

newspaper.dossierWizard.mustHaveTagzones¶

newspaper.dossierWizard.shouldHaveTagzones¶

newspaper.image.basepath¶

newspaper.image.size.[name]¶

newspaper.image.format.[name].label¶

newspaper.image.format.[name].[name for size]¶

newspaper.rsync_host¶

newspaper.rsync_path¶

newspaper.rsync_user¶

newspaper.rsync_log¶

newspaper.rsync_options¶

Smarty-Templates¶

# Template-<root>-Folders:
newspaper.defaultTemplate = fileadmin/templates/newspaper

Plugins for Smarty¶

# Where you can include smarty plugins (siehe Smarty Doc)
# Added by default: fileadmin/templates/newspaper/smarty_plugins
newspaper.smarty_plugins_dirs = <kommaseparierte liste>

Dossier-Page¶

# Id of TYPO3-page, where dossiers are generated
newspaper.dossier_page_id = <page ID here>

Control Tags¶

 Control tags are of type...
# Default is 2 - TODO: Was gibt es für Types?
# newspaper.control_tag_type = <any other int greater than 2>