Skip to content
Sscuttlizr is a theme for SemanticScuttle 0.98.5. It includes Bootstrap and Font-Awesome, is completely responsive, and includes most of HTML5 Boilerplate hooks and features
PHP JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data/templates/sscuttlizr
www
LICENSE
README.md

README.md

sscuttlizr

About

Sscuttlizr is a theme for SemanticScuttle 0.98.5. It includes Modernizr, Bootstrap and Font-Awesome, is completely responsive, and includes most of HTML5 Boilerplate hooks and features. It is visually based on SemanticScuttle's default theme, but is slightly different in some opinionated details.

This theme has been tested on the version 0.98.5 of SemanticScuttle.

Theme features

  • Completely responsive
  • Uses latest Bootstrap & Font-Awesome
  • HTML5 feature-detection with latest Modernizr
  • Latest jQuery, loaded from CDN, with local fallback (HTTPS compatible)
  • Replace some HTML tags & attributes with HTML5 equivalents (example: placeholder attribute)
  • Use of Bootstrap components (Alert, Grid, Navbar, Forms)
  • Use of Font-Awesome icons
  • Hooks from HTML5Boilerplate: Apache server config (via .htaccess), ChromeFrame, crossdomain.xml
  • Optional support for Piwik Analytics
  • Optional support for sharing with Wallabag (previously named Poche)
  • Optional support for shortening with Yourls
  • Optional support for Jappix chat

Installation

  1. Unzip theme and template
  2. Copy all the content of the "www" & "data" folders to their respective places in your SemanticScuttle installation
  3. Open config.php, and insert the following inside the PHP code:
$theme = 'sscuttlizr';

Optionnal .htaccess

Sscuttlizr includes a .htaccess file, which is the Apache configuration file optimized for HTML5 Boilerplate (v2.0.0). This file can only be used if you have Apache as a web server. This file is needed for some features, including ChromeFrame.

See details about H5BP's .htaccess.

In addition to H5BP's server config, the file also includes the specific rules for SemanticScuttle (that are used for clean URLs).

The content of this file is quite opinionated; you can choose not to include it (and keep SemanticScuttle's original .htaccess file), or to customize it the way you want.

Optionnal crossdomain.xml

Sscuttlizr includes a restrictive crossdomain.xml file.

The content of this file is quite opinionated; you can choose not to include it, or to customize it the way you want.

Optionnal QR-Codes

This theme adds the possibility to generate on-demand QR-Codes for each bookmark. This feature does not rely on any QR service; it generates the QR codes by itself. This feature uses Jerome Etienne's QR-Code plugin for jQuery.

The Qr-Codes are drawn in a canvas, but should be drawn in HTML tables in browser that don't support canvas. The detection of support for canvas is made with Modernizr.

By default, this functionality is disabled. To enable it, open your config.php file, and insert the following inside the PHP code:

$enableQrCodes = true;

Optionnal support for Piwik Analytics

Sscuttlizr has support for Piwik Analytics if you need it.

You must have a functional Piwik installation to use this feature.

By default, this functionality is disabled. To enable it, open your config.php file, and insert the following inside the PHP code:

// Set your Piwik Analytics ID here (a number)
// Between quotes !!!
$piwikAnalyticsSiteId = '1';

// set the URL your Piwik installation, without protocol
// example: if your Piwik is at https://my-piwik.org/stats/ ,
// then, enter: my-piwik.org/stats
// No Trailing slash !!!
$piwikAnalyticsUrl = 'your.piwik.com';

Notes: Do not enter any http:// or https:// in the URL, and enter your Piwik site ID between quotes.

You can also enable the "noscript" image:

// Enables the <noscript> image tag
$piwikAnalyticsNoScript = true;

And if you enable the "noscript" and your Piwik installation is served with HTTPS, you can force HTTPS for the "noscript" image:

// If the <noscript> image tag is enabled, force the serve of the image only through HTTPS
$piwikAnalyticsNoScriptHttps = true;

Optionnal support for Wallabag (previously named Poche)

Sscuttlizr has support for Wallabag as a bookmark sharing tool.

You must have a functional Wallabag installation to use this feature.

By default, this functionality is disabled. To enable it, open your config.php file, and insert the following inside the PHP code:

// The Poche URL. No Trailing slash !!!
$wallabagUrl = 'https://my-wallabag.com/readitlater';

Notes: No trailing slash at the end of the URL !!

Optionnal support for Yourls

Sscuttlizr has support for Yourls as a URL shortener.

You must have a functional Yourls installation to use this feature.

By default, this functionality is disabled. To enable it, open your config.php file, and insert the following inside the PHP code:

// The Yourls URL.
// Be sure to insert the final script of the API (here: yourls-api.php)
$yourlsUrl = 'https://my-yourls.com/yourls-api.php';

// The Yourls signature token
$yourlsApiKey = 'a1b2c3d4e5';

Notes: Be sure to enter the Yourls API path (e.g. yourls-api.php)

Optionnal support for JappixMini

Sscuttlizr has support for Jappix as a chat tool.

You must have a functional Jappix installation to use this feature.

By default, this functionality is disabled. To enable it, open your config.php file, and insert the following inside the PHP code:

// Enable the service
// default: false
$enableJappix = true;

// Enable JappixMini only for logged users
// default: false
$jappixEnableForLogged = true;

// Enable JappixMini only for logged admins
// default: false
$jappixEnableForAdmin = true;

//The Jappix server's URL. No trailing slash !!! And no final /php !
// default: "https://static.jappix.com"
$jappixUrl = "https://static.jappix.com";

// Define the lang for Jappix
// Choose one of the following:
// ar bg cs de en eo es et fa fr he hu id it ja la lb
// mn nl oc pl pt-br pt ru sk sv tr uk zh-cn zh-tw
// default: "en"
$jappixLang = 'fr';

// Define the resource (as in 'What kind of resource is talking to Jappix?').
// Choose any string you want.
// default: "SemanticScuttle"
$jappixResource = "SemanticScuttle";

// Define the the domain for your connection
// default: "anonymous.jappix.com"
$jappixDomain = "anonymous.jappix.com";

// Use the option below to disable anonymous mode
// default: false
$jappixAuth = true;

// With $jappixAuth to true, you can enable login with user and password
// On Jappix and Jabber in general, a login is like an email: user@domain.com
// Here, the user part is defined below,
// and the domain part is defined by $jappixDomain
// default: ""
$jappixUser = "dave";
// default: ""
$jappixPassword = "secret";

// Auto-connect? Should work in anonymous or logged modes
// default: false
$jappixAutoConnect = true;

// Define your Jappix Nickname
// if not defined or if equals to "", a random nickname will be chosen
// default: ""
$jappixNickName = "davZ";

// Animate JappixMini?
// Note that the animation only occurs if $jappixAutoConnect equals false
// and if $jappixGroupChats is an empty array or is not defined.
// default: false
$jappixAnimate = true;

// Define JappixMini title
// default: 'Chat'
$jappixTitle = 'Chat';

// Define the error URL (URL of the link that will be displayed if connection fails
// If not defined, it defaults to 'https://mini.jappix.com/issues'
// default: "https://mini.jappix.com/issues"
$jappixErrorLink = 'https://mini.jappix.com/issues';

// Disable JappixMini on mobile devices?
// default: false
$jappixDisableMobile = true;

// Group chats to join at launch (you must provide an array of strings here)
// default: array()
$jappixGroupChats = array("support@muc.jappix.org");

Notes:

  • No trailing slash at the end of the URL !!
  • If you want to enable an anonymous mode, just set:
$jappixAuth = false;

Credits

Thanks to

License

This theme is licensed under MIT License.

Stats

Bitdeli Badge

You can’t perform that action at this time.