The template must generate Instant View pages for the relevant pages on the target website to be considered perfect.
1.1. Pages with static article-like content
Tip: It may be a good idea to identify a common feature of all the IV-positive pages and add rules so that your template only applies to them. Note that these pages only need IV pages if their essential content is supported in the IV format — otherwise, see 2.3.
The template must not generate Instant View pages for any of the pages of the following types on the target website to be considered perfect.
Tip: IV pages are cached on our servers. The more time passed since an article was published, the less frequently the cached IV page will be updated. Any pages that update content in real time would subsequently display outdated IV pages to users — which is unacceptable.
Tip: While it's possible to modify interactive components of a page into simple links, the IV format was primarily designed to allow Telegram users to enjoy web content in a quick and uniform way. Interacting with websites, buying things, writing reviews, etc. are outside of the current scope for IVs.
Tip: The rule here is simple. If a part of an article is not available in the Instant View format, an IV page must not be generated. In most cases, this will happen automatically, but it is a good idea to confirm this before submitting your template for the contest. Mark any unsupported essential content using the @unsupported function. See this section for advice on handling unsupported videos.
All essential content must be presented on the Instant View page.
These properties are also essential, but not always present or supported in IV:
Important: See our Clarifications below for tips on how to best process cover images, date and time, author names and URLs, and other tricky elements.
Tip: Check that pages that feature unsupported content do not generate IV pages. In most cases, this will happen automatically, but it is a good idea to confirm this before submitting your template for the contest. Mark any unsupported essential content using the @unsupported function. See this section for advice on handling unsupported videos.
Anything that is not essential to the article in question should be removed from the Instant View page.
The resulting IV page may not contain any content not present in the original.
Tip: It is allowed to display the official channel of the website that published the article at the top of the IV page (by using the channel property). To be considered official, the channel must be named as such somewhere on the source website (doesn't have to be on the same page as the original article).
Below are some clarifications for the trickier aspects of creating perfect Instant View templates. This section will be expanded, follow @IVContest to keep in touch.
Author name is required only if it is presented in the source article in a clear way (at the top of the page, at the very end of the text, in the meta tags etc.), especially if there's a name of an actual person.
In less obvious cases, what the user sees when viewing the original article in an ordinary browser has priority over invisible meta-information. Names of actual people are always preferrable over entity names like ‘team’ or the name of the website.
It is possible to omit the author in cases where no name can be seen by a regular user opening the original article in the browser. It is possible to omit the name when there‘s no identifiable person, only the website’s ‘team’, ‘editors’, etc.
We will not accept issues based on absence of author names for articles in which no author can be easily identified by a regular viewing user.
Author links are optional. If there's a clearly identifiable author and they have a page on the target website, use that one. In more ambiguous cases, use what the regular viewing user can see in the original article or omit the link altogether.
We will not be accepting issues based on the availability of author links. The only exception is when the author link is pointing to an inappropriate page.
Tip: IV only supports one author URL per article. If there are several in the article, it's ok to choose one or omit them altogether. Neither will be accepted as a issue.
It is advisable to use a cover image when possible:
In all other cases, cover images are optional:
Sometimes, a cover is less desirable:
We will only accept issues based on absence or presence of a cover image in these cases:
Tip: Cover images can also have captions in IV, so don't lose them.
Slideshows are required only if the source article shows several photos or other media as a slideshow or gallery.
If there are several ordinary images/videos/GIFs following each other in the source, you can also convert them into a slideshow, but this is purely optional. This makes more sense in cases when images serve as additional content (e.g., a long text about a new car which is followed by ten images of the car).
We will not accept issues based on presence or absence of slideshows for ordinary images following each other in the source article.
Slideshows must not be used:
Tip: Remember that captions should be preserved for all images in the source. If you lose captions for images you‘ve put into a slideshow, it’s a valid issue. IV Slideshows support both a caption for the entire slideshows and different captions for each individual element.
Any captions present in the source article must be preserved. This includes captions for the cover image and captions for all individual elements of slideshows.
If the image has no caption, but has meaningful text in the alt attribute, you may use that text as the caption. This is optional, we will not accept issues about alt-text missing from captions.
Tip: Please don‘t include meaningless alt-text as captions (e.g., the Playstation blog always puts the name of the corresponding game in the alt attribute of all screenshots – there’s no need to reproduce that on the IV page.)
These blocks are optional. For purposes of style:
None of the above is required. We will not be accepting issues based on ‘further reading’ links of any type not being removed.
There is one exception: blocks of external links leading to ‘Partner sites’ must always be removed along with other ads.
Some articles include a link to their source. This link could be inserted at the end of the article in the format via <a href="source URL...">Website</a>
. A word with a similar meaning could be used instead of ‘via’ for websites in other languages.
We will not be accepting issues based on the availability of the source link.
Pages that display unsupported content (e.g. an interactive map widget) must not generate IVs.
Important: We will accept issues requesting to generate IVs for pages with content previously deemed unsupported if you include a link to a template that fully supports the content in question.
IV pages do not support tables, but this doesn't mean that any page containing a table layout should not generate IVs. Simple two-column tables can be rendered into lists without loss of information and legibility. Tables are sometimes used for purposes of design rather than functionally (example) – in such cases it is logical to modify their content to fit the IV format.
Three-column tables and more complex tables should be tagged as @unsupported.
Important: We will accept issues requesting to generate IVs for pages with content previously deemed unsupported if you include a link to a template that fully supports the content in question.
<iframe>
. If you do that, the IV page will not be generated due to unsupported content, but things will work out of the box when and if we support that widget.<video>
with the correct src
attribute.Some pages include unsupported widgets that are not essential for the understanding of the article. A local news site may show a weather forecast widget on their pages. A business newspaper may show a stock price ticker for the companies covered in the article. Some websites include “And what would you do?” votes at the end of some of their articles to increase user engagement.
None of these should bother you. Simply remove such non-essential widgets from the article and go ahead with generating the IV page. Warning: Make sure that you don’t add this dynamic auxiliary data to your static IV page.
We currently support SoundCloud embeds but we're planning to expand support for audio playback in IV.
For podcasts, music, or other recordings:
The date and time of publication is obligatory for news publications. It must be obtained by any means possible, including meta tags, etc.
If conflicting dates are stored in multiple places on the source page, preference should be given to the time that is visible to the ordinary user who views the page in a browser.
The IV editor‘s ’Preview‘ section will always show the date/time in UTC format, while the ’Original' section may use a different time zone. It is possible for a perfect template to display a date/time that is different from the original.
Tip: Between ‘date published’ and ‘date last edited’, choose ‘date published’ for articles.
It is allowed to display the official channel of the website that published the article on the IV page by using the channel
property:
This channel link is optional. We will not accept issues based on the absence or presence of a channel link with one exception:
If the channel property is set, the channel it is pointing to must be the official channel. To be considered official, the channel must be named as such somewhere on the source website (doesn't have to be on the same page as the original article).
A subtitle is a subordinate title of a published work or article giving additional information about its content. If such a beast is present in the original article, a <subtitle>
is required. Here's an example of a subtitle:
Few publications actually use subtitles. Somewhat more common are short summary sentences that are also shown below the title (and are called standfirst by the British). These summary sentences are usually short and are not part of the article's text. It is also required to represent them as <subtitle>
elements. Here's an example:
Many publications use a slightly different style for their lead paragraphs. Unlike subtitles and summaries, the lead paragraph is a part of the article's text. Even if the lead uses a different style from the rest of the text, it is a bad idea to present it as a <subtitle>. We will accept issues on templates that present the lead paragraph as the subtitle in IV. If the lead paragraph uses a different style, it is recommended to use bold or italic text (we will not accept issues based on the absence of such formatting).
In the example above, the lead paragraph is highlighted in bold: “TAXI giant Uber has reportedly fired over 20 workers following an internal investigation into sexual harassment allegations.”
The article then continues: “The company told staff of the layoffs on Tuesday and related claims by law firm Perkins Coie, a person close with the case told Bloomberg.” It would be acceptable to present the “TAXI giant Uber…” paragraph as bold, or italic, or plain text.