There are a few lower-level files and settings that you, as a developer, should be aware of. These files all reside in the website's file space and are easily accessible via FTP, using your account credentials. For more information on accessing the Sitemason® FTP server, see this support forum post.
When you log in to your FTP account, you will see a "www" folder, which contains the files associated with "www.example.com." If your website is housed as "dev.example.com" (with the host name being "dev"), then you would want to access the "dev" folder. Either way, inside the appropriate folder you'll find a few important files and folders:
.sitemason: this is a folder containing the Sitemason Development Library and its supporting files. Inside this folder there are two files and one folder:
- config.json: this file defines the locations of your Site Templates (a "production" template and an optional "development" template), as well as your Tool Template Sets. There are also settings used by the Development Library, which will be discussed in the next section. Config.json is the only file that you will typically need to alter.
- SMLibPHP: this is a folder containing the Sitemason Development Library. It is versioned, so you can install multiple versions into your account or even multiple copies of the same version, though only one Development Library is active at any given time. There is typically no need to alter anything in this folder.
- templateLoader.php: this is a special file required by the Sitemason web server. You should not alter this file.
smTemplate: this folder contains the Boilerplate template - the example Site Template that gets loaded into all new accounts. The main file of the Boilerplate template is called "myTemplate.php" (which you will note is referenced in config.json). You are encouraged to play around with the Site Template. Learn from it, expand it, delete pieces, use it as is, or scrap it altogether - it is simply there to provide a working example.
smToolTemplateSets: this folder contains the smDefault Tool Template Set (and you will note that this is also referenced in config.json). You are encouraged to alter and use this Tool Template Set however you see fit.
Altering Library Versions
The Sitemason® Development Library gets updated from time to time. Since each website has its own copy of the Development Library, updating the library simply involves creating a copy of the library in the website's .sitemason/SMDevLib folder. For Development Library version 6.0.1 for www.mydomain.com, the entire folder would be called:
Once the library exists in your website's file space, you can activate it by changing the "developmentLibraryVersion" setting in config.json. In this case, the value should be simply "6.0.1"
Development vs. Production Mode
When you look at config.json, you'll notice that the templatePaths parameter has both "development" and "production" settings. The values both should be the path (relative to the host folder, normally "www") to the Site Template.
These two settings can point to the same template, or they can point to different templates. The template that is used depends on how you call your website.
- http://www.mydomain.com - uses the production template
- http://www.mydomain.com.sitemason.com - uses the development template, if one is defined, otherwise it falls-back to the production template.
A typical scenario where you would want to use the development template is when you are re-developing a website or testing out changes. Simply make a copy of your template, reference it as the development template in config.json, then call your website using the .sitemason.com address, which will call your development template, leaving your production template in place and answering for standard URLs.