Updated for Sparkle 2.8

Auf Deutsch

En Français

In Italiano

Publishing and exporting

‍Publishing is the step of website construction that transforms your Sparkle layouts into a world-viewable website, comprised of HTML, CSS, images and Javascript.

‍You can publish your site either when you’re done building it, or for a live test. You initiate publishing via the “Publish website…” option in the File menu or through the "Publish" icon in the toolbar.

‍On first publish you will have to set up a location. Click on the “Setup…” button to get started.

‍A publishing location stores all settings so that updating the site is a single click away. Sparkle also uses the location information to only publish actually changed files.

‍Where to publish

‍To publish your site to the web you will need to have a hosting plan with a web hosting company. This isn’t included in Sparkle. We generally recommend any of the top sites listed on this ReviewSignal page.

‍Sparkle can:

  • ‍• Publish to the web, Sparkle will transfer files to your web host with its built-in ftp client;
  • ‍• Export to disk, Sparkle will generate the files on disk, you will need to transfer files on your own using a third party tool, such as Cyberduck, FileZilla or Transmit.

‍The initial screen reflects this.

‍Export to disk

‍Exporting to disk is straightforward, you are requested to pick a folder and name the location. Additionally the text encoding option lets you choose how non-ASCII characters are represented in the web page code. It conservatively defaults to ASCII text, which makes the page source somewhat larger but is compatible with all web servers. You can set it to UTF-8 for a more compact page source if you know the server is compatible (the browser will otherwise show incorrect characters). This setting is auto-detected when Sparkle publishes directly to the web.

‍By default Sparkle produces high performance HTML that works when uploaded to a web server. If you intend to load the HTML files directly in the browser from the local disk you will need to set the code generation option to “Offline compatible”.

‍Publish to the web

‍Publishing to the web is more complex, but while it has some upfront annoyance, once it’s done you can subsequently publish updates with a few clicks.

‍While referencing your web host’s settings, either in an email or in the section of their web portal that discusses FTP and domain management, fill in the setup screen:

‍Sparkle needs the web address because it will check that the FTP space it connects to corresponds to the web address you want. This helps autodetect a number of settings that ensure Sparkle works with the widest variety of web hosts and servers.

‍Your web host will provide the server address and user name and password. They might also suggest a preferred protocol.

‍A higher number of connections generally corresponds to a fast transfer speed, though will also need a faster connection for the higher number of connections. Some web hosts limit the number of connections, in some cases blocking any further connection for some time, and note that this counts for all apps you might have open on your Mac. For example if your web host only allows a single connection and you already have an FTP app open, Sparkle might not be able to connect.

‍Setup completion

‍If the connection succeeds and your web host is set up in a way that Sparkle can auto-detect, after a few seconds you will see the location save screen, signaling setup completion.

‍Intermediate step

‍In some cases Sparkle can’t figure out how your web host is set up, so you need to assist it.

‍Before the setup completion screen, Sparkle will show the filesystem of your web server, and you will need to locate the folder where the website needs to be published at the requested address. This varies on a host-by-host basis.

‍Publishing updates

‍When you make changes and want to update the website, click on the Publish toolbar icon and click on the Publish button for each location you want to update.

‍A notification will inform you of the publish completion if you have switched away from Sparkle.

‍Publishing performance

‍Sparkle’s goal when publishing is the performance of the published website. This has informed some choices that make the publishing process slower than what would be intuitive, but the end goal is a speedy experience for the site visitor.

‍For example:

  • ‍• during publishing Sparkle will use image compression algorithms that favor higher compression (and smaller file sizes), at the expense of compression time;
  • ‍• the main html file for each page, and the corresponding javascript and css files, are all re-generated every time the site is published, this is designed to work with server and browser caches.

‍In order to avoid re-compressing the images every time you publish, Sparkle associates a disk cache with each publish location, you can manually clear it from the Sparkle preferences window, but more importantly re-using the same publish location is what ensures publishing is fast and only transfers changed files.

‍Here you should enter the website address, including subfolder path

‍The FTP server name is communicated by your web host

‍The FTP username is communicated by your web host

‍The FTP password is communicated by your web host

‍Number of connections to the server

‍The protocol generally works with auto-detection, but you can manually set it based on your web host’s suggestions if Sparkle has trouble connecting

Please report any shortcoming in this documentation and we’ll fix it as soon as possible!

Copyright © 2019 River SRL 

IT06208340486 — REA FI-609716

This site uses cookies. Some are essential to make our site work; others help us improve the user experience and display third party content. By using the site, you agree to our site sending these cookies. Read our privacy policy to learn more or opt out.