Browse Source

Add Site Settings guide, rearrange files

master
Skylar Ittner 1 year ago
parent
commit
e5a78f91ae

+ 51
- 0
docs/Guide/Site Settings.md View File

@@ -0,0 +1,51 @@
# Website Settings

<div class="aspect-16x9"><iframe width="560" height="315" sandbox="allow-same-origin allow-scripts" src="https://video.netsyms.com/videos/embed/062be6b9-c980-4027-a2b6-0125e13f71e0" frameborder="0" allowfullscreen></iframe></div>

## Opening the Settings

To access the settings page for a website, log in to SiteWriter, open the <i class="fas fa-sitemap"></i> Sites page, find the website in the list, and click the <i class="fas fa-cog"></i> Settings button.

## Settings Cards

The website settings are broken up into different cards. Each card contains a different category of settings. To save the settings, scroll all the way to the bottom of the page and press <i class="fas fa-save"></i> Save.

### Site Info

<img src="../../images/screenshots/settings_siteinfo.png" alt="Card with input boxes labled Title and URL" />

The Site Info settings card allows you to set the website title and URL. The title is shown in several places on the website.

<p style="clear:both;"></p>

### Theme

This card allows you to choose a theme for your website. Some themes have multiple sub-themes, called color styles. Click the Preview button on a theme or color style to see your website in that theme.

<img src="../../images/screenshots/settings_theme.png" alt="Theme selection card" />

### Company Info

<img src="../../images/screenshots/settings_companyinfo.png" alt="Card with text boxes labeled Name, Phone, Address, and Email" />

The Company Info card allows you to set the company name, phone number, address, and email address. This information will be placed on the website in a suitable location, such as the bottom of the page or near a contact form.

### Social Links

If your company has public pages on various social media platforms, place links to those pages here. Website visitors will be shown icons corresponding to those platforms, and can click on them to be taken to your social media page. For example, if you have a Facebook page and YouTube channel, visitors will see a <i class="fab fa-facebook"></i> and a <i class="fab fa-youtube"></i> on your site, and can click on them to go to your Facebook page and YouTube channel respectively.

### Analytics

<img src="../../images/screenshots/settings_analytics.png" alt="Card with option to enable or disable built-in analytics" />

If you do not wish to track users with the built-in SiteWriter analytics, you can disable that here. This does not affect third-party services, such as Google Analytics or Matomo.

### Extra Code

<img src="../../images/screenshots/settings_extracode.png" alt="Card with text box for adding extra HTML code to the site header" />

If you need to add code for third-party services, you can copy and paste it into this box. It will be inserted in every page on your website. This is useful for enabling services such as Google Analytics, or inserting extra metadata tags. If you aren't familiar with HTML code, be careful, as you can easily make your website appear broken to visitors using this tool. If something does break, try removing the contents of the Extra code text box, saving the settings, and reloading the website.

### Site Footer Links

This card allows you to add web links to the bottom of your website. The title is shown to visitors, and they will be taken to the link when they click the title.

+ 9
- 0
docs/Self-Hosting and Development/Installing.md View File

@@ -0,0 +1,9 @@
# Installing

0. Install AccountHub
1. Copy `settings.template.php` to `settings.php`
2. Import `database.sql` into your database server
3. Edit `settings.php` and fill in your DB info
4. Set the URL of the install
7. Run `composer install` (or `composer.phar install`) to install dependency libraries
9. From a web browser, visit `http://apps/url` (or whatever your setup is). If you did everything right, you should see a login screen.

docs/System Requirements.md → docs/Self-Hosting and Development/System Requirements.md View File

@@ -14,8 +14,6 @@ The Business Apps are very lightweight on server resources. The minimum support
* Ubuntu
* Debian
* PHP
* 7.0
* 7.1
* 7.2
* Database
* MySQL 5.7+

docs/Theme Development.md → docs/Self-Hosting and Development/Theme Development.md View File


+ 0
- 117
docs/images/docs-icon.svg View File

@@ -1,117 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->

<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="512"
height="512"
viewBox="0 0 511.99999 511.99999"
id="svg2"
version="1.1"
inkscape:version="0.91 r13725"
sodipodi:docname="docs-icon.svg"
inkscape:export-filename="/home/skylar/Documents/Assets/Graphics/docs-icon.png"
inkscape:export-xdpi="45"
inkscape:export-ydpi="45">
<defs
id="defs4" />
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="0.98994949"
inkscape:cx="52.220574"
inkscape:cy="225.3771"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false"
units="px"
inkscape:window-width="1920"
inkscape:window-height="1023"
inkscape:window-x="107"
inkscape:window-y="1024"
inkscape:window-maximized="1" />
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(0,-540.36219)">
<rect
y="593.73596"
x="56"
height="50"
width="400"
id="rect4187"
style="fill:#00b0ff;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
<rect
style="fill:#9e9e9e;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4150"
width="380"
height="50"
x="76"
y="683.25037" />
<rect
style="fill:#9e9e9e;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4154"
width="380"
height="50"
x="76"
y="953.25037" />
<g
id="g4162"
style="fill:#bdbdbd">
<rect
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4148"
width="320"
height="50"
x="136"
y="773.25037" />
<circle
r="12.5"
cy="798.25037"
cx="101.19038"
id="path4160"
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
</g>
<g
transform="translate(40,90.000002)"
id="g4162-3"
style="fill:#bdbdbd">
<rect
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1"
id="rect4148-6"
width="280"
height="50"
x="136"
y="773.25037" />
<circle
r="12.5"
cy="798.25037"
cx="101.19038"
id="path4160-7"
style="fill:#bdbdbd;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:5, 5;stroke-dashoffset:0;stroke-opacity:1" />
</g>
</g>
</svg>

+ 0
- 104
docs/images/logo.svg View File

@@ -1,104 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="512"
height="512"
viewBox="0 0 511.99999 511.99999"
id="svg2"
version="1.1"
inkscape:version="0.91 r13725"
sodipodi:docname="logo.svg"
inkscape:export-filename="/home/skylar/Documents/Projects/Assets/SiteWriter/logo_512.png"
inkscape:export-xdpi="90"
inkscape:export-ydpi="90">
<sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1440"
inkscape:window-height="842"
id="namedview14"
showgrid="false"
inkscape:zoom="0.65186406"
inkscape:cx="-263.8452"
inkscape:cy="164.6375"
inkscape:window-x="1024"
inkscape:window-y="156"
inkscape:window-maximized="1"
inkscape:current-layer="svg2" />
<defs
id="defs4" />
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<rect
style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:20;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:0.74509804"
id="rect4726-3"
width="512"
height="512"
x="0"
y="0"
rx="50"
ry="50" />
<path
id="rect4149"
d="m 151.84815,105.55999 c 0,0 208.08221,4e-4 208.08221,4e-4 8.87969,2e-5 17.47765,5.42434 19.32647,12.34724 0,0 68.50606,256.52161 68.50606,256.52161 4.65095,17.41553 -3.3789,32.03897 -18.20921,32.01073 0,0 -347.207046,-0.66126 -347.207046,-0.66126 -14.762494,-0.0281 -22.747362,-14.64569 -18.112131,-32.00219 0,0 68.337707,-255.88862 68.337707,-255.88862 1.84592,-6.91197 10.42061,-12.32792 19.27594,-12.32791 0,0 0,0 0,0"
style="opacity:1;fill:#03a9f4;fill-opacity:1;stroke:none;stroke-width:1;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
inkscape:connector-curvature="0" />
<g
transform="matrix(5.9992735,-11.249026,11.249026,5.999273,-1609.4403,-1737.4273)"
id="g2030"
style="display:inline;stroke-width:1.91200209" />
<rect
ry="11.220414"
rx="11.220414"
y="237.21503"
x="150.21944"
height="18.934093"
width="211.56111"
id="rect5279"
style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
<rect
style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
id="rect5281"
width="245.31049"
height="21.954561"
x="133.34476"
y="287.24475"
rx="13.010355"
ry="13.010355" />
<rect
style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
id="rect5277"
width="188.55019"
height="16.874683"
x="161.7249"
y="189.24477"
rx="10"
ry="10" />
<path
style="opacity:1;fill:#3f51b5;fill-opacity:1;stroke:#ffffff;stroke-width:5;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 413.40083,100.4255 c -6.25994,-3.614167 -12.82305,-3.883777 -14.71576,-0.605517 L 267.15452,327.63761 c -0.1189,0.20593 -0.21483,0.42009 -0.29174,0.64289 -2.61136,2.10628 3.51508,29.26281 7.21558,31.3993 3.70042,2.13644 30.28348,-6.13458 30.80284,-9.44936 0.1545,-0.17801 0.28948,-0.3696 0.40838,-0.57554 L 436.82014,121.83727 c 1.8927,-3.27826 -1.62235,-8.82729 -7.88226,-12.44145 l -15.53706,-8.97032 z"
id="rect4549"
inkscape:connector-curvature="0" />
</svg>

BIN
docs/images/screenshots/settings_analytics.png View File


BIN
docs/images/screenshots/settings_companyinfo.png View File


BIN
docs/images/screenshots/settings_extracode.png View File


BIN
docs/images/screenshots/settings_siteinfo.png View File


BIN
docs/images/screenshots/settings_theme.png View File


+ 1
- 3
docs/index.md View File

@@ -1,8 +1,6 @@
# SiteWriter

SiteWriter is an easy-to-use website design system.

## Features
# Features

* __Simple Editor__
* Create awesome websites with zero coding or design experience.

+ 25
- 0
docs/media.css View File

@@ -0,0 +1,25 @@
.md-content img {
box-shadow: 0 1px 4px rgba(0,0,0,0.4);
margin: 10px;
float: right;
}

.md-content img.no-shadow {
box-shadow: none;
}

.md-content .aspect-16x9 {
position: relative;
width: 100%;
height: 0;
padding-bottom: 56.25%;
box-shadow: 0 1px 10px rgba(0,0,0,0.5);
}

.md-content .aspect-16x9 iframe {
position: absolute;
width: 100%;
height: 100%;
left: 0;
top: 0;
}

+ 9
- 4
mkdocs.yml View File

@@ -1,18 +1,23 @@
site_name: SiteWriter Docs
theme:
name: 'material'
logo: 'images/logo.svg'
favicon: 'images/docs-icon.svg'
logo: 'https://static.netsyms.net/images/products/sitewriter/logo.svg'
favicon: 'https://static.netsyms.net/images/netsyms/documentation/docs-icon.svg'
font: false
feature:
tabs: false
palette:
primary: 'light-blue'
accent: 'light-blue'
extra_javascript:
- track.js
- 'https://static.netsyms.net/fontawesome/5.3.1/js/all.min.js'
- 'https://docs.netsyms.com/track.js'
extra_css:
- 'https://docs.netsyms.com/font.css'
- 'https://docs.netsyms.com/media.css'
site_author: Netsyms Technologies
repo_name: 'Business/SiteWriter'
repo_url: 'https://source.netsyms.com/Business/SiteWriter'
copyright: Copyright &copy; 2018 Netsyms Technologies. All rights reserved. Copying is allowed for instructional purposes (such as creating an internal user help document) as long as credit is given and this copyright notice is included. For other purposes, or if you are selling a product containing copied material, please <a href="https://netsyms.com/contact" target="_BLANK">contact us</a> for permission.
copyright: <br /><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://docs.netsyms.com/cc-by-sa88x31.png" /></a><br />Copyright &copy; 2018 Netsyms Technologies. Some rights reserved.<br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
markdown_extensions:
- codehilite

Loading…
Cancel
Save