Skip to content

Commit 03e6d12

Browse files
pwsegpwseg
authored
Update page.md
HTML table -> Markdown
1 parent d7286c4 commit 03e6d12

File tree

1 file changed

+11
-68
lines changed

1 file changed

+11
-68
lines changed

‎src/connections/spec/page.md

Lines changed: 11 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -83,71 +83,14 @@ You should **only use reserved properties for their intended meaning**.
8383

8484
Reserved properties Segment has standardized:
8585

86-
<table>
87-
<tr>
88-
<td>**Property**</td>
89-
<td>**Type**</td>
90-
<td>**Description**</td>
91-
</tr>
92-
<tr>
93-
<td>`name`</td>
94-
<td>String</td>
95-
<td>Name of the page.
96-
97-
This is reserved for future use.
98-
99-
</td>
100-
</tr>
101-
<tr>
102-
<td>`path`</td>
103-
<td>String</td>
104-
<td>Path portion of the URL of the page.
105-
106-
107-
Equivalent to [`canonical path`](https://github.com/segmentio/analytics.js/blob/master/analytics.js#L6499-L6503) which defaults to [`location.pathname`](https://developer.mozilla.org/en-US/docs/Web/API/Location) from the DOM API.
108-
</td>
109-
</tr>
110-
<tr>
111-
<td>`referrer` </td>
112-
<td>String</td>
113-
<td>Full URL of the previous page.
114-
115-
116-
Equivalent to [`document.referrer`](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer) from the DOM API.</td>
117-
</tr>
118-
<tr>
119-
<td>`search`</td>
120-
<td>String</td>
121-
<td>Query string portion of the URL of the page.
122-
123-
124-
Equivalent to [`location.search`](https://developer.mozilla.org/en-US/docs/Web/API/Location) from the DOM API.</td>
125-
</tr>
126-
<tr>
127-
<td>`title`</td>
128-
<td>String</td>
129-
<td>Title of the page.
130-
131-
132-
Equivalent to [`document.title`](https://developer.mozilla.org/en-US/docs/Web/API/Document/title) from the DOM API.</td>
133-
</tr>
134-
<tr>
135-
<td>`url`</td>
136-
<td>String</td>
137-
<td>Full URL of the page.
138-
139-
140-
First we look for the canonical url. If the canonical url is not provided, we use [`location.href`](https://developer.mozilla.org/en-US/docs/Web/API/Location) from the DOM API.</td>
141-
</tr>
142-
<tr>
143-
<td>`keywords`</td>
144-
<td>Array[String]</td>
145-
<td>A list/array of keywords describing the content of the page.
146-
147-
148-
The keywords would most likely be the same as, or similar to, the keywords you would find in an html [meta](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#Attributes) tag for SEO purposes. This property is mainly used by content publishers that rely heavily on pageview tracking. This is not automatically collected.
149-
</td>
150-
</tr>
151-
</table>
152-
153-
**Note:** In [analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/), Segment automatically send the following properties: `title`, `path`, `url`, `referrer`, and `search`.
86+
| property | type | description |
87+
| ---------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
88+
| `name` | String | Name of the page. Reserved for future use. |
89+
| `path` | String | Path portion of the page's URL. Equivalent to [`canonical path`](https://github.com/segmentio/analytics.js/blob/master/analytics.js#L6499-L6503) which defaults to [`location.pathname`](https://developer.mozilla.org/en-US/docs/Web/API/Location) from the DOM API. |
90+
| `referrer` | String | Previous page's full URL. Equivalent to [`document.referrer`](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer) from the DOM API. |
91+
| `search` | String | Query string portion of the page's URL. Equivalent to [`location.search`](https://developer.mozilla.org/en-US/docs/Web/API/Location) from the DOM API. |
92+
| `title` | String | Page's title. Equivalent to [`document.title`](https://developer.mozilla.org/en-US/docs/Web/API/Document/title) from the DOM API. |
93+
| `url` | String | Page's full URL. Segment first looks for the canonical URL. If the canonical URL is not provided, Segment uses [`location.href`](https://developer.mozilla.org/en-US/docs/Web/API/Location) from the DOM API. |
94+
| `keywords` | Array [String] | A list/array of keywords describing the page's content. The keywords would most likely be the same as, or similar to, the keywords you would find in an HTML [meta](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#Attributes) tag for SEO purposes. This property is mainly used by content publishers that rely heavily on pageview tracking. This is not automatically collected. |
95+
96+
**Note:** In [analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/), Segment automatically sends the following properties: `title`, `path`, `url`, `referrer`, and `search`.

0 commit comments

Comments
 (0)