# VSY

VSY stands for Versatile Site Summary Syndication. Its file extension is .vsy. VSY is used to create a summary for sites updates, which can be read by feeds. It has simple syntax, yet powerful and extensible functionality in a small file size.

## Criteria

- simple, yet extensible
- channel information
- item information
- custom information

# Sections

A VSY file is divided into sections marked by headers (which are not case sensitive). All sections are optional. If a file begins with no headers, it is implied to begin in the Channel section. A section type can appear multiple times in the same file.

VSY files may have a [[VSY]] header at the first bytes of the file. This is recommended in order for programs to instantly recognize it as a VSY file. This header is not counted as a section.

The [[Channel]] section holds the information for your channel.

The [[Items]] section holds the information for each item you want to propagate from your site.

# Properties of Data

Data rows holds one or more data fields or values. The first value in a data row is the name of a property. Subsequent fields or values in the row provide additional arguments to this property.

For example, the following is the file property, followed by the URL:

=f=https://ieants.cc/


# Channel Properties

## 'f'

The 'f' property means file, and is followed by a field that refers to a URL of your channel or VSY file.

Ex.
^f^https://ieants.cc/

## 't'

The 't' property means title of your channel, syndication, or organization.

Ex.
^t^VSY Title

## 'desc'

The 'desc' property means desription of your channel.

Ex.
^desc^This is a description of my channel

## 'cr'

The 'cr' property means copyright.

Ex.
^cr^© 2022 ieants.cc . All rights reserved.

## 'db'

The 'db' property means date of the last build. Prefered format is compliant to [RFC 822] (https://www.w3.org/Protocols/rfc822/#z28).

Ex.
^db^Mon, 06 Sep 2010 00:01:00 +0000

## 'dp'

The 'dp' property means date of the last publication. Prefered format is compliant to [RFC 822] (https://www.w3.org/Protocols/rfc822/#z28).

Ex.
^dp^Wed, 02 Mar 2022 02:44:53 GMT

## 'ttl'

The 'ttl' property means time to live. How long to cache this channel before refresh. Measured in minutes.

Ex. one day
^ttl^1440

## 'lang'

The 'lang' property means language of the channel. See [W3C Language codes] (https://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes) and [RSS-Specific Language Codes] (https://www.rssboard.org/rss-language-codes#table).

Ex.
^lang^en-us

## 'a'

The 'a' property means author of the channel.

Ex.
^a^Xay Voong

## 'p'

The 'p' property means publisher of the channel.

Ex.
^p^ieants.cc

# Items Properties

Data rows in the items section hold the items of your feed. The general layout is a file row, followed by additional rows that describe a file, including title, description, and publication date. That means a file row signals the beginning of a new item subsection.

## 'f'

The 'f' property means file, and is followed by a field that refers to a URL of an item.

Ex.
^f^https://ieants.cc/smf/index.php?topic=203.msg3069#msg3069

## 't'

The 't' property means title of the item.

Ex.
^t^Re: Versatile Separated Values (VSV)

## 'desc'

The 'desc' property means desription or summary of the item.

Ex.
^desc^Official VSV webpage @ https://ieants.cc/code/vsv/

## 'dp'

The 'dp' property means the item's date of publication. Prefered format is compliant to [RFC 822] (https://www.w3.org/Protocols/rfc822/#z28).

Ex.
^dp^Thu, 10 Mar 2022 21:59:43 GMT

## 'guid'

The 'guid' property is a string that uniquely identifies the item.

Ex.
^guid^https://ieants.cc/smf/index.php?topic=203.msg3069#msg3069

Ex.
^guid^7bd204c6-1655-4c27-aeee-53f933c5395f

## 'a'

The 'a' property means author of the item.

Ex.
^a^Xay Voong

## 'com'

The 'com' property refers to a link for the reader to input comments about the item.

Ex.
^com^https://ieants.cc/smf/index.php?action=post;topic=203.0

## 'cat'

The 'cat' property means the categories to which the item belongs. Multiple categories can be provided on the same row. Separate additional categories with the delimiter.

Ex.
^cat^VSV^VSY

# Custom Properties

The 'var' property sets any custom properties not already defined in the VSY specifications. It can be used by vendors or users to basically create any property they want, including nonstandard, extraneous, or emergent data.

The first value is the variable name. Subseqent values are the desired text or data.

Custom properties can go in the channel or items section, and extends the channel or item.

Ex.
[[Channel]]
^var^email^admin@mysite.com
^var^content^The Sunset Explorers share tips, techniques and recommendations for great hikes and adventures around the United States. Listen on\nApple Podcasts.
^var^encf^http://example.com/podcasts/everything/AllAboutEverythingEpisode4.mp3
^var^encd^498537
^var^enctype^audio/mpeg

# Full Example

Compare VSY to other formats. VSV is more easily legible and processed by humans and computers alike, at a fraction of the file size.

Ex.
[[VSY]]

[[Channel]]
^f^http://www.example.com/main.html
^t^VSY Title
^desc^This is a description of the channel
^cr^copyright
^db^Mon, 06 Sep 2010 00:01:00 +0000
^dp^Sun, 05 Sep 2010 00:01:00 +0000
^ttl^1800
^lang^en-us
^a^Author Info
^p^publisher
^var^type^serial
^var^email^admin@mysite.com
^var^content^The Sunset Explorers share tips, techniques and recommendations for great hikes and adventures around the United States. Listen on\nApple Podcasts.
^var^encf^http://example.com/podcasts/everything/AllAboutEverythingEpisode4.mp3
^var^encd^498537
^var^enctype^audio/mpeg


[[Items]]
^f^http://www.example.com/item1.html
^t^VSY Item 1
^desc^This is a description of the item 1
^dp^Mon, 06 Sep 2010 00:01:00 +0000
^d^1079
^guid^7bd204c6-1655-4c27-aeee-53f933c5395f

^f^http://www.example.com/item2.html
^t^VSY Item 2
^desc^This is a description of the item 2
^dp^Mon, 06 Sep 2010 00:01:00 +0000
^d^1079
^guid^bb2b2367-d163-4eec-80f1-5b3476611b17

Ex.
[VSY of the most recent posts at ieants.cc forums] (https://ieants.cc/smf/index.php?action=.xml;type=vsy)

This is a production, operational VSY file. You can use its link at the VSY reader, below, to see the latest posts at [ieants.cc forums] (https://ieants.cc/smf/) in realtime.

# VSY Reader

You can try this [VSY feed reader] (https://ieants.cc/reader/). This reader accepts VSY and RSS formats.