commit 3d16c711aa90014d424e81e66ed1c922ed973b4d
parent b0bbba8e40f7c12922266cb41679221df94a031c
Author: markseu <mark2011@mayberg.se>
Date: Thu, 18 Dec 2025 02:40:41 +0100
Updated installation files
Diffstat:
2 files changed, 0 insertions(+), 79 deletions(-)
diff --git a/.gitattributes b/.gitattributes
@@ -3,5 +3,4 @@
LICENSE.md export-ignore
README*.md export-ignore
SCREENSHOT*.png export-ignore
-STYLEGUIDE.md export-ignore
TASKLIST.md export-ignore
diff --git a/STYLEGUIDE.md b/STYLEGUIDE.md
@@ -1,78 +0,0 @@
-# Datenstrom Yellow style guide
-
-You should use the following guidelines for your code:
-
-* Use consistent indentation with 4 spaces, no tabs.
-* Use double quotes for strings, not single quotes, e.g. `"Coffee is good for you"`.
-* Class names should use PascalCase, e.g. `YellowCore`, `YellowEdit`, `YellowFika`.
-* Method/function names should use camelCase, e.g. `getRequestInformation`, `onLoad`.
-* Property/variable names should use camelCase, e.g. `$yellow`, `$statusCode`, `$fileName`.
-* HTML/CSS related names should use kebab-case, e.g. `yellow`, `edit-toolbar`, `fika-logo`.
-* Opening braces `{` are on the same line, closing braces `}` are placed on their own line.
-* One space is used after keywords such as `if`, `switch`, `case`, `for`, `while`, `return`,
- e.g. `switch ($statusCode)`, `for ($i=0; $i<$length; ++$i)`, `return $statusCode`.
-* One space is used around parentheses and compound logical operations,
- e.g. `if ($name=="example" && ($type=="block" || $type=="inline"))`.
-* Start each source file with link to a website, that contains license and contact information,
- e.g. `// Core extension, https://github.com/annaesvensson/yellow-core`.
-* Use a single-line comment to describe classes, methods and properties,
- e.g. `// Return request information`.
-* Don't have code comments inside methods and functions.
-* Keep methods relatively small, sweet and focused on one thing, if unsure do less.
-* Download a copy of the PHP standards and burn them, it's a great symbolic gesture.
-
-You should use the following guidelines for your documentation:
-
-* Use Markdown for text formatting, no tabs.
-* Use appropriate titles, e.g. `How to make a small website`, `Troubleshooting`, `Core 0.9.1`.
-* Descriptions should fit into one line, e.g. `Core functionality of your website`.
-* README files should start with a section explaining how to install an extension.
-* README files should use the following order for headings, all are optional:
- `How to...`
- `Examples`
- `Settings`
- `Acknowledgements`
- `Developer`, `Designer`, `Translator`
-* Settings should be described in the following style:
- `CoreServerUrl` = URL of the website
- `CoreTimezone` = timezone of the website
- `CoreDebugMode` = enable debug mode, 0 to 3
-* Files should be described in the following style:
- `system/extensions/yellow-system.ini` = file with system settings
- `system/extensions/yellow-language.ini` = file with language settings
- `system/extensions/yellow-user.ini` = file with user settings
-* Use HTML at the beginning of a line to add additional link targets,
- e.g. `<a id="settings-page"></a>`, `<a id="settings-files"></a>`.
-* Give multiple examples for users to copy/paste, if unsure add more examples.
-* Review the entire documentation from the perspective of the user.
-* Don't use the words "easy, flexible, user-friendly".
-
-You should use the following guidelines for your extension:
-
-* Extension names should be one word, singular, no spaces, e.g. `Core`, `Edit`, `Fika`.
-* Version numbers should begin with the release number, e.g. `0.9.1`, `0.9.2`, `0.9.3`.
-* Descriptions should be one short sentence, e.g. `Core functionality of your website`.
-* File names should use kebab-case, the extension name is used as prefix,
- e.g. `fika.php`, `fika.css`, `fika.js`, `fika-library.min.js`, `fika-stack.svg`.
-* Repository names should use kebap-case, e.g. `yellow-core`, `yellow-edit`, `yellow-fika`.
-* Repository documentation files should be in Markdown format, e.g. `README.md`.
-* Repository screenshots/previews should be in PNG image format, e.g. `SCREENSHOT.png`.
-* Repositories should have a flat folder structure, file actions are stored in file `extension.ini`.
-* Check spelling, British English is the reference language, other languages are optional.
-* Keep extensions relatively small, sweet and focused on one thing, if unsure do less.
-* Don't have more than one extension per repository.
-
-You should use the following technical terms:
-
-* An `extension` gives you additional features, languages and themes - not "plugin".
-* A `layout` is a HTML file, it can render a complete or a partial page - not "template".
-* A `navigation` is automatically generated from your content folders - not "menu bar".
-* The `page settings` can be configured at the top of each page - not "front matter".
-* A `shortcut` is a way to extend Markdown with additional features - not "shortcode".
-* A `static generator` makes the entire website in advance, instead of waiting for the request.
-* The `system settings` contain the settings of your website and of all installed extensions.
-* A `theme` is a CSS file, it may come with additional images, fonts, JavaScript and so on.
-* A `web editor` allows you to edit a website in a `web browser` - not "admin panel".
-* A `web server` is a computer software/hardware required to run a website.
-
-Do you have questions? [Get help](https://datenstrom.se/yellow/help/).
