⚠️ This branch is unsuitable for use in production. You should switch to the "stable" branch for production wikis.

Snap! Project Embed

A MediaWiki extension for embedding Snap! projects

Usage

• Loading a project with Snap!'s default width and height: <snap project="project-name" user="user" />
• Loading a project with custom width and height:
• <snap project="project-name" user="user" width="width" height="height" />
• Loading a project without showing the title and author of the project (defaults to true): <snap project="project-name" user="user" width="width" taa="false" />
• Loading a project without the edit button (defaults to true): <snap project="project-name" user="user" edit="false" />
• Loading a project without the pause button (defaults to true): <snap project="project-name" user="user" pause="false" />
• Loading a project inside a HTML details tag to make it visible only after an arrow has been clicked (defaults to false): <snap project="project-name" user="user" hide="true" />

You can also use the extension like this- <snap project="project-name" user="user"></snap>. Additionally, instead of using the <snap> tag, you can also use the <snap-project> tag.

Filesystem

.
└── 📂 .github # GitHub Configuration - Safe to delete
    └── 📜 dependabot.yml # Dependabot configuration
    └── 📂 workflows # GitHub Workflows
        └── 📜 ci.yml # Continous Integration configuration
└── 📂 .phan # Phan configuration directory - Safe to delete
    └── 📜 config.php # Phan configuration file
└── 📂 i18n # Translations for extension
    └── 📜 bn.json # Bengali translation
    └── 📜 en.json # English translation
    └── 📜 eo.json # Esperanto translation
    └── 📜 it.json # Italian translation
└── 📂 includes # PHP code that power the extension
    └── 📜 EmbedSnap.php # Main extension file - The most important file of all!
└── 📜 .gitignore # Lists files that Git should ignore
└── 📜 LICENSE # License file
└── 📜 README.md # The file you are reading right now!
└── 📜 composer.json # Lists all Composer dependencies - Safe to delete
└── 📜 composer.lock # Lock file for Composer - Safe to delete
└── 📜 extension.json # Extension manifest
└── 📜 phpcs.xml # PHP CodeSniffer configuration - Safe to delete

Installation

1. Clone this repository with Git into your "Extensions" folder using the following command:

git clone https://github.com/snapwiki/SnapProjectEmbed.git

2. Update LocalSettings.php to add the following line:

wfLoadExtension( 'SnapProjectEmbed' );

3. Go to Special:Version in your wiki and look at the "Installed extensions" section. It should now list SnapProjectEmbed and its version, license and contributors.

Credits

A big thank you to mw-embedScratch contributors which was our original design inspiration.

Legal

SnapProjectEmbed - A MediaWiki extension that allows embedding Snap! projects.

Copyright (C) 2020-2024 Radman Siddiki and GrahamSH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Old Versions

The current version of Snap! Project Embed is 3.x. If you would like to use an older version, please switch to its respective branch-

• v1: v1
• v2: v2