Xatframe: Difference between revisions

From xat wiki
mNo edit summary
No edit summary
Line 8: Line 8:


<translate><!--T:5--> The library provides a list of user-submitted xatframes that are free to use by the community.</translate>
<translate><!--T:5--> The library provides a list of user-submitted xatframes that are free to use by the community.</translate>
<translate>=== Submitting a xatframe === <!--T:15--></translate>
<translate><!--T:16--> You can [<tvar|link1>https://forum.xat.com/submissions/xatframe-submissions/?do=form</> submit a xatframe] so that it will appear on the [<tvar|link2>https://xat.com/chats#!library</> xatframe library] ([[<tvar|1>Special:MyLanguage/Forum</>|forum]] account required).</translate> <translate><!--T:17--> Your xatframe must follow the rules listed on the forum and below in order to be approved.</translate>


<translate>=== Adding a xatframe to your group === <!--T:6--></translate>
<translate>=== Adding a xatframe to your group === <!--T:6--></translate>


[[File:Xatframes.png|thumb|<translate><!--T:7--> '''Figure 1''': Adding a xatframe to your group</translate>]]
<translate><!--T:8--> 1. Go to the [<tvar|link1>https://xat.com/chats#!library</> xatframe library]. '''(Figure 1)'''</translate>
 
<translate><!--T:8--> 1. Go to the [<tvar|link1>https://xat.com/chats#!library</> xatframe library].</translate>


<translate><!--T:9--> 2. Click “copy” on any xatframe.  '''(Figure 1)'''</translate>
<translate><!--T:9--> 2. Click “copy” on any xatframe.  '''(Figure 2)'''</translate>


<translate><!--T:10--> 3. Then, hover over "group" at the top right of your group, click "customize" and enter your group password.</translate> <translate><!--T:11--> Alternatively, visit the [<tvar|link>https://xat.com/chats#!editgroup</> edit group] page.</translate>
<translate><!--T:10--> 3. Then, hover over "group" at the top right of your group, click "customize" and enter your group password.</translate> <translate><!--T:11--> Alternatively, visit the [<tvar|link>https://xat.com/chats#!editgroup</> edit group] page.</translate>


<translate><!--T:12--> 4. Add the URL to the "xatframe" field on the appearance tab. '''(Figure 1)'''</translate>
<translate><!--T:12--> 4. Add the URL to the "xatframe" field on the appearance tab. '''(Figure 3)'''</translate>


<translate><!--T:13--> 5. Save changes and the xatframe will be live on your group.</translate>
<translate><!--T:13--> 5. Save changes and the xatframe will be live on your group.</translate>
Line 25: Line 27:
<translate><!--T:14--> '''Note:''' You must also use an outer background when using a xatframe so that there is a fallback if users have xatframes disabled.</translate>
<translate><!--T:14--> '''Note:''' You must also use an outer background when using a xatframe so that there is a fallback if users have xatframes disabled.</translate>


<translate>=== Submitting a xatframe === <!--T:15--></translate>
<gallery mode="packed-overlay" heights=200px>
 
File:Xatframe library.png|thumb|<translate>Figure 1: xatframe library</translate>
<translate><!--T:16--> You can [<tvar|link1>https://forum.xat.com/submissions/xatframe-submissions/?do=form</> submit a xatframe] so that it will appear on the [<tvar|link2>https://xat.com/chats#!library</> xatframe library] ([[<tvar|1>Special:MyLanguage/Forum</>|forum]] account required).</translate> <translate><!--T:17--> Your xatframe must follow the rules listed on the forum and below in order to be approved.</translate>  
File:Xatframe copy.png|thumb|<translate>Figure 2: Copy a xatframe</translate>
File:Xatframe field.png|thumb|<translate>Figure 3: xatframe field on the appearance tab</translate>
</gallery>


<translate>== Making your own xatframe == <!--T:18--></translate>
<translate>== Making your own xatframe == <!--T:18--></translate>
Line 38: Line 42:


<translate>== Settings == <!--T:24--></translate>
<translate>== Settings == <!--T:24--></translate>
[[File:Xatframe settings.png|thumb|<translate><!--T:25--> '''Figure 2''': xatframe setting options</translate>]]
[[File:Xatframe settings.png|thumb|<translate><!--T:25--> '''Figure 4''': xatframe setting options</translate>]]


<translate><!--T:26--> You can disable or enable xatframes through an automatic pop-up window or by hovering over "group" at the top right of a group and clicking "xatframe".</translate> <translate><!--T:27--> You can do this for all groups (global), the current group or both. '''(Figure 2)'''</translate>
<translate><!--T:26--> You can disable or enable xatframes through an automatic pop-up window or by hovering over "group" at the top right of a group and clicking "xatframe".</translate> <translate><!--T:27--> You can do this for all groups (global), the current group or both. '''(Figure 4)'''</translate>


<translate><!--T:28--> Changes will not take effect until you refresh the page.</translate>
<translate><!--T:28--> Changes will not take effect until you refresh the page.</translate>

Revision as of 06:49, 21 June 2020

To further customize the outer background of your group, you can provide a link to an HTML document that will be embedded via iframe (known as a "xatframe") behind your chat. Within the embedded page, you can use any combination of HTML/CSS/JavaScript that you like including animations, generated content, etc.

This replaces the custom CSS styling that was used on Flash chats.

Library

The library provides a list of user-submitted xatframes that are free to use by the community.

Submitting a xatframe

You can submit a xatframe so that it will appear on the xatframe library (forum account required). Your xatframe must follow the rules listed on the forum and below in order to be approved.

Adding a xatframe to your group

1. Go to the xatframe library. (Figure 1)

2. Click “copy” on any xatframe. (Figure 2)

3. Then, hover over "group" at the top right of your group, click "customize" and enter your group password. Alternatively, visit the edit group page.

4. Add the URL to the "xatframe" field on the appearance tab. (Figure 3)

5. Save changes and the xatframe will be live on your group.

Note: You must also use an outer background when using a xatframe so that there is a fallback if users have xatframes disabled.

Making your own xatframe

If you want to create your own xatframe, you will first need to have somewhere to host it. For this, we recommend you use https://github.io as it is easy to set up and is already pre-unblocked. If you wish to use your own domain, you will need to have it unblocked by making a ticket.

For more information on setting up GitHub pages, you can visit their website.

Once you have a webpage set up, you can combine HTML/CSS/JavaScript code to create your design and then use it on your chat, or submit it to the xatframe library.

Settings

Figure 4: xatframe setting options

You can disable or enable xatframes through an automatic pop-up window or by hovering over "group" at the top right of a group and clicking "xatframe". You can do this for all groups (global), the current group or both. (Figure 4)

Changes will not take effect until you refresh the page.

Rules

You must ensure the xatframe you use complies with the rules below, even if taken from a third party.

Note: xat reserves the right to change these rules without notice.

IMPORTANT: Failure to follow these rules may result in your chat group being deleted or permanently delisted and having all of its media removed. xat may also apply a block to your account, depending on the offence.

  • Must be suitable for viewing by all ages.
  • No IP trackers or content that can be used to track IP addresses.
  • Do not store any cookies etc. without permission.
  • No chats to be embedded in an iframe.
  • Do not use animations that may be intrusive to the chatting experience.
  • Flashing images should not be used.
  • Do not use malicious code of any kind (e.g. with mouse clicks or key presses).
  • No commercial adverts or content of that nature.