1
0
mirror of https://github.com/typemill/typemill.git synced 2025-07-30 19:00:32 +02:00

Version 1.1.6 User Role, Fieldsets and Refactoring

This commit is contained in:
Sebastian
2018-05-22 23:03:27 +02:00
parent aefb9709cb
commit e346625e32
32 changed files with 1073 additions and 657 deletions

View File

@@ -1,6 +1,6 @@
# Settings
As of Version 1.1.3 you can edit all settings in the new authoring panel of TYPEMILL. Just login to your typemill installation and go to settings. There you can edit:
As of Version 1.1.3 you can edit all settings in the new authoring panel of TYPEMILL. Just visit the url `yourwebsite.com/tm/login` and go to settings after the login. There you can edit:
* The system (basic settings).
* Themes (choose themes and configure it).
@@ -17,4 +17,5 @@ There are some settings that are not available via the author panel. Most of the
displayErrorDetails: true
````
Don't forget to set it back to `false` before you deploy the website live. It is not secure to show the world your internal errors and many hosters will turn off all public error reports by default.
Don't forget to set it back to `false` before you deploy the website live. It is not secure to show the world your internal errors and many hosters will turn off all public error reports by default.

View File

@@ -3,7 +3,7 @@
After you have setup your TYPEMILL website, you can login to the author panel. The login url is
````
https://yourwebsite.net/tm-author/login
https://yourwebsite.net/tm/login
````
You can also use the url `https://yourwebsite.net/setup` that redirects to the login screen.
@@ -15,4 +15,5 @@ In the **settings area** of the author panel you can:
* Activate and configure **plugins**.
* Manage **users**.
the **content area** of the author-panel is not ready yet, but it is on it's way and will be published in near future. Then you can create and manage all the content of your website online. For time being you have to create your content offline e.g. with a markdown editor and upload your content files with a FTP software.
the **content area** of the author-panel is not ready yet, but it is on it's way and will be published in near future. Then you can create and manage all the content of your website online. For time being you have to create your content offline e.g. with a markdown editor and upload your content files with a FTP software.

View File

@@ -0,0 +1,21 @@
# Lost Your Password?
TYPEMILL does not provide a password recovery, but there are two ways to create a new password.
## Is there another admin?
If there is another user with admin rights, then contact him. He can delete your user, create a new one and tell you the new password. Change the password immediately after login.
## No other admin?
If you are the only admin user, then please follow these steps:
* Connect to your website (e.g. via FTP).
* Go to the folder `/settings` and backup the file `settings.yaml`.
* Then delete the file `settings.yaml` on your server.
* Go to `yoursite.com/setup`.
* Fill out the form. This will create a new admin user and a fresh settings-file.
* Upload your old settings-file, so your old settings are active again.
* If not done before e.g. via FTP, delete the old admin-user in the user management now.
It might look a bit uncomfortable but it makes sure, that you are the owner of the website.

View File

@@ -66,4 +66,35 @@ forms:
TYPEMILL will use these definitions and generate input fields for the author panel on the fly, so that the user can edit the values and customize the theme. If you have defined settings with the same name as the field name (e.g. `chapter`), then the input field in the author panel will automatically be prefilled with your settings from the YAML-file.
If you read the YAML-definition for input fields carefully, then you will notice that the definitions are pretty similar HTML: You simply define types and attributes like input-type, labels and placeholders. Nearly all valid field-types and field attributes are supported. You can find a detailed list in the [documentation for plugins](/plugin-developers/documentation/field-overview).
If you have a lot of fields, you can even group some fields together in a fieldset like this:
````
forms:
fields:
chapter:
type: text
label: chapter
placeholder: Add Name for Chapter
required: true
MyFirstfieldset:
type: fieldset
legend: Last Modified
fields:
modified:
type: checkbox
label: Activate Last Modified
description: Show last modified date at the end of each page?
modifiedText:
type: text
label: Last Modified Text
placeholder: Last Updated
````
The fields `modified` and `modifiedText` will then be grouped in a fieldset with the legend `Last Modified`.
If you read the YAML-definition for input fields carefully, then you will notice that the definitions are pretty similar to HTML: You simply define types and attributes like input-type, labels and placeholders. Nearly all valid field-types and field attributes are supported. You can find a detailed list in the [documentation for plugins](/plugin-developers/documentation/field-overview).

View File

@@ -47,6 +47,7 @@ TYPEMILL accepts the following field type definitions:
* textarea
* tel
* url
* fieldset
A simple field definition looks like this:
@@ -174,6 +175,38 @@ SimpleCheckbox:
description: Please check me
````
## Using Fieldsets
If you have a lot of fields, you can group them togeter with a fieldset like this:
````
forms:
fields:
chapter:
type: text
label: chapter
placeholder: Add Name for Chapter
required: true
MyFirstfieldset:
type: fieldset
legend: Last Modified
fields:
modified:
type: checkbox
label: Activate Last Modified
description: Show last modified date at the end of each page?
modifiedText:
type: text
label: Last Modified Text
placeholder: Last Updated
````
The fields `modified` and `modifiedText` will then be grouped in a fieldset with the legend `Last Modified`.
## Example for a complete yaml configuration
To sum it up, this is a complete example of a yaml configuration file for a plugin with the meta-description, a default value and a field definition for user input:
@@ -201,3 +234,4 @@ forms:
block: Block
classic: Classic
````