SDK Directory Reference

Understanding How DotSquare is Organized

There are 3 main directories that DotSquare uses to hold all data and files. They are 51-configure, 51-content, and 51-includes. You can find more details on what is contained inside each in the directory tree below.

Directory Tree


Item
Details

51-configure/

This directory can be edited by you.

       

css/

Contains all overall styling files for the site. Your own CSS can be placed in a separate directory that you choose.

              

fonts/

Add local font files here.

              

modifiers/

Templates located in the 51-content/ directory are overridden by files in this folder.

              

temp/

Temporary CSS files merged from your header, footer, features, and pages.

              

CSS

custom_normalize.css

This styling linked in every page on you website. Overwrites ds_normalize.css in 51-includes/ directory.

              

CSS

custom_styles.css

This for your custom classes. Styling linked in every page on you website.

              

PHP

style_template.php

OPTIONAL. This is for website templates. Not commonly used.

       

data/

Contains temporary configuration JSON data for the site.

       

inc/

For custom PHP includes and template modifier files

              

modifiers/

In certain cases, a feature or header will allow a custom include within a section of the feature. The include files are contained here.

              

PHP

footer1.php

You can have multiple footer files for different page designs. This file name is the default. To add additional files, number them, footer2.php, footer3.php, etc.

              

PHP

header1.php

You can have multiple header files for different page designs. This file name is the default. To add additional files, number them, header2.php, header3.php, etc.

       

PHP

custom_files.php

This is where you specify which files from the 51-content/ directory to include on every page.

       

PHP

global_var.php

For simple standard DotSquare website configuration variables

       

PHP

init.php

The most important file. Define your API Key here and include this file on every page.

51-content/

DO NOT Alter this directory. Only replace when updating dotSquare.
This holds templates and features which are regularly updated with each release.

51-includes/

DO NOT Alter this directory. Only replace when updating dotSquare.
This has critical functions and features necessary to keep the SDK and API functioning.

.htaccess

Template for guidance.

PHP

404.php

A 404 template for you to adjust if needed.

apple-touch-icon.png

Default Touch Icon. Must not change name.

favicon.png

Default Favicon. Must not change name.

TXT Text

humans.txt

Give credit to your team.

PHP

index.php

A template homepage for you to adjust.

TXT Text

robots.txt

The default robots file.