From f3f0d4354776e778e1938e3309c5f8d68e6a49fb Mon Sep 17 00:00:00 2001 From: Daemmon Date: Wed, 26 Aug 2020 07:31:35 -0400 Subject: [PATCH] Update documentation (#1917) * Update config.yml * Update config.yml * Update config.yml * fix spacin in comment * fix urls in documentation --- config/alchemy/config.yml | 20 ++++++++++++++----- .../alchemy/install/files/alchemy.en.yml | 4 ++-- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/config/alchemy/config.yml b/config/alchemy/config.yml index a62397ebcd..001f7a91d0 100644 --- a/config/alchemy/config.yml +++ b/config/alchemy/config.yml @@ -62,17 +62,27 @@ items_per_page: 15 # === Picture rendering settings # -# Alchemy uses Dragonfly to render images. Use {size: "XXXxYYY", crop: BOOLEAN [true]} to resize images. +# Alchemy uses Dragonfly to render images. Settings for image rendering are specific to elements and are defined in elements.yml # -# See http://markevans.github.com/dragonfly for further infos. +# Example: +# - name: some_element +# contents: +# - name: some_picture +# type: EssencePicture +# settings: +# hint: true +# crop: true # turns on image cropping +# size: '500x500' # image will be cropped to this size # -# ==== Options: +# See http://markevans.github.com/dragonfly for further info. +# +# ==== Global Options: # # output_image_jpg_quality [Integer] # If image gets rendered as JPG this is the quality setting for it. (Default 85) -# preprocess_image_resize [String] # Use this option to resize images to that value. Downsizing example: '1000x1000>' (Default nil) +# preprocess_image_resize [String] # Use this option to resize images to the given size when they are uploaded to the image library. Downsizing example: '1000x1000>' (Default nil) # image_output_format [String] # The global image output format setting. (Default +original+) # -# NOTE: You can always override the output format in the options of your Essence. I.E. {format: 'gif'} +# NOTE: You can always override the output format in the settings of your Essence in elements.yml, I.E. {format: 'gif'} # output_image_jpg_quality: 85 preprocess_image_resize: diff --git a/lib/generators/alchemy/install/files/alchemy.en.yml b/lib/generators/alchemy/install/files/alchemy.en.yml index 4591517bb7..a325f62f8a 100644 --- a/lib/generators/alchemy/install/files/alchemy.en.yml +++ b/lib/generators/alchemy/install/files/alchemy.en.yml @@ -18,7 +18,7 @@ en: # Default texts for new contents created default_content_texts: article_headline: "Welcome to your first Alchemy CMS page" - article_text: '

How to get started.

First of all you should read about Alchemy and its architecture in the guidelines.

The most important things to know about Alchemy are elements and page layouts.

Elements:

With Alchemy you can split pages into content parts, elements. These elements can be defined out of several base content types: essences. The basic essences are:

Elements get defined in a YAML file config/alchemy/elements.yml

Read more about elements and how to define them in the guidelines.

Page types:

You can define several types of pages, called page layouts. You can assign elements to page layouts and control how elements and the page of a certain layout behave.

Page layouts get defined in a YAML file config/alchemy/page_layouts.yml

Read more about defining page layouts in the guidelines.

' + article_text: '

How to get started.

First of all you should read about Alchemy and its architecture in the guidelines.

The most important things to know about Alchemy are elements and page layouts.

Elements:

With Alchemy you can split pages into content parts, elements. These elements can be defined out of several base content types: essences. The basic essences are:

Elements get defined in a YAML file config/alchemy/elements.yml

Read more about elements and how to define them in the guidelines.

Page types:

You can define several types of pages, called page layouts. You can assign elements to page layouts and control how elements and the page of a certain layout behave.

Page layouts get defined in a YAML file config/alchemy/page_layouts.yml

Read more about defining page layouts in the guidelines.

' # Hint texts for elements element_hints: @@ -28,4 +28,4 @@ en: content_hints: headline: "This is a single line of unformatable Text" picture: "Pictures are stored in the library. You can assign a picture multiple times throughout your site. Alchemy has an image cropper build right in." - text: "This is a rich text block powered by TinyMCE editor. You can change the configuration of the editor. See http://guides.alchemy-cms.com/stable/customize_tinymce.html" + text: "This is a rich text block powered by TinyMCE editor. You can change the configuration of the editor. See http://guides.alchemy-cms.com/customize_tinymce.html"