Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
install:fonts [2023/03/10 09:36] – [Check metamodel settings] alzinstall:fonts [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
-====== How to install the correct fonts ======+====== How to install the correct fonts (until Stages 7.9.6.1) ======
  
-===== No asian charsets required =====+This section describes the configuration to create PDF files and process visualizations according to the charset required. 
 + 
 + 
 +=====  No asian charsets required  =====
  
 If no asian charsets are required - the additional installation of fonts is not required. If no asian charsets are required - the additional installation of fonts is not required.
 +
  
 ==== Define configuration properties ==== ==== Define configuration properties ====
  
 **Windows server OS:** \\ **Windows server OS:** \\
-Open file <Stages Installation Directory>\stages\conf\config.xml and check the poperties section on top for the following properties and values. Please add or modify the properties below according to your installation parameters:+Open file <Stages Installation Directory>\stages\conf\config.xml and check the properties section on top for the following properties and values. Please add or modify the properties below according to your installation parameters:
  
 //<property name="pdf.font.list" value="//<Stages Installation Directory>\//stages\tomcat\webapps\stages\fonts\SourceSansPro-Regular.ttf"/>\\ //<property name="pdf.font.list" value="//<Stages Installation Directory>\//stages\tomcat\webapps\stages\fonts\SourceSansPro-Regular.ttf"/>\\
Line 24: Line 28:
  
 This is an example on how to check the correct font families to be defined in the unified configuration metamodel.\\ This is an example on how to check the correct font families to be defined in the unified configuration metamodel.\\
-If you use different metamodels - the path of the files to check will be different.+If you use different metamodels - or older versions of the Unified Configuration Metamodel - the path of the files to check will be different.
  
-Open all *.css files specified in the following paths:+Open all *.css files specified in the paths below and check for the following font family definition:\\ 
 +//font-family: 'Source Sans Pro'//
  
 **Windows server OS:** \\ **Windows server OS:** \\
Line 33: Line 38:
 /opt/stages/data-cache/generated/model/unified_configuration/pdf/1.0/*.css /opt/stages/data-cache/generated/model/unified_configuration/pdf/1.0/*.css
  
-Check each .css file for the following font family definition: //font-family: 'Source Sans Pro'//+Make sure the scriptconfig.js specified in the paths below is up to date and contains:\\ 
 +//var FONTNAME = availableFontFamilies.getConfiguredFont(); // \\ 
 +\\ 
 +**Windows server OS:** \\ 
 +<Stages Installation Directory>\stages\data-cache\generated\model\unified_configuration\diagram\trunk\configs\scriptconfig.js\\ 
 +**Linux server OS:** \\ 
 +/opt/stages/data-cache/generated/model/unified_configuration/diagram/trunk/configs/scriptconfig.js
  
-Please note: This is a temporary fix only - every update of the Stages configuration would revoke your changes. So we strongly suggest to also fix this in your metamodel file (.mm). If you need further help to do so - please contact your Stages product consultant or the Stages support team at Method Park.+Please note: This is a temporary fix only - every update of the Stages configuration would revoke your changes. So we strongly suggest to also fix this in your metamodel file (.mm). If you need further help to do so - please contact your Stages Product Consultant or the Stages Support team at Method Park.
  
  
Line 46: Line 57:
 ===== Asian charsets required ===== ===== Asian charsets required =====
  
-To use asian charsets - an additional font is required that supports the charset required. Method Park only provides one font that supports most asian charsets: SourceHanSans+To use asian charsets - an additional font is required that supports the charset required. Method Park only provides one font that supports most asian charsets: Source Han Sans
  
 Known Limitations: Known Limitations:
  
-  * SourceHanSans doesn't work with the Temurin openJDK v8. If you want to use this font - another Java JDK is required. +  * Source Han Sans doesn't work with the Temurin openJDK v8. If you want to use this font - another Java JDK is required. 
-  * The alignment of text and/or the line spacing might be incorrect.+  * The alignment of text and/or the line spacing with Source Han Sans might be incorrect.
  
 We strongly suggest to install your own font - only supportig your required charset. If you do so - please adopt the font properties in the following sections according to your font requirements. We strongly suggest to install your own font - only supportig your required charset. If you do so - please adopt the font properties in the following sections according to your font requirements.
  
  
-==== Installation of required font ====+==== Install required font ====
  
-Please download the font SourceHanSans to the following folder on your Stages server:\\+Please download font Source Han Sans to the following folder on your Stages server:\\
 **<Stages installation path>/conf/fonts** \\ **<Stages installation path>/conf/fonts** \\
 \\ \\
-Font download source:\\ +Font download source: **Source Han Sans ** ([[https://scripts.sil.org/ofl|SIL OPEN FONT LICENSE]])\\
-**Source Han Sans ** ([[https://scripts.sil.org/ofl|SIL OPEN FONT LICENSE]])\\+
 [[https://www.methodpark.de/downloads/stages/SourceHanSans-Regular.ttf|https://www.methodpark.de/downloads/stages/SourceHanSans-Regular.ttf]] [[https://www.methodpark.de/downloads/stages/SourceHanSans-Regular.ttf|https://www.methodpark.de/downloads/stages/SourceHanSans-Regular.ttf]]
  
Line 71: Line 81:
 Open file <Stages Installation Directory>\stages\conf\config.xml and check the poperties section on top for the following properties and values. Please add or modify the properties below according to your installation parameters: Open file <Stages Installation Directory>\stages\conf\config.xml and check the poperties section on top for the following properties and values. Please add or modify the properties below according to your installation parameters:
  
-//<property name="pdf.font.list" value="// <Stages Installation Directory>//\stages\tomcat\webapps\stages\fonts\SourceHanSans-Regular.ttf"/>\\+//<property name="pdf.font.list" value="// <Stages Installation Directory>//\stages\conf\fonts\SourceHanSans-Regular.ttf"/>\\
 <property name="diagram.font" value="Source Han Sans:SourceHanSans-Regular.ttf"/>// <property name="diagram.font" value="Source Han Sans:SourceHanSans-Regular.ttf"/>//
  
Line 78: Line 88:
 Please add or modify the properties below according to your installation parameters: Please add or modify the properties below according to your installation parameters:
  
-//<property name="pdf.font.list" value="/opt/stages/tomcat/webapps/stages/fonts/SourceHanSans-Regular.ttf"/>\\ +//<property name="pdf.font.list" value="/opt/stages/conf/fonts/SourceHanSans-Regular.ttf"/>\\ 
-<property name="diagram.font" value="Source Sans Pro:SourceHanSans-Regular.ttf"/>//+<property name="diagram.font" value="Source Han Sans:SourceHanSans-Regular.ttf"/>//
  
  
 ==== Check metamodel settings ==== ==== Check metamodel settings ====
  
-This is an example on how to check the correct font families to be defined in the unified configuration metamodel.\\ +This is an example on how to check the correct font families to be defined in the Unified Configuration Metamodel.\\ 
-If you use different metamodels - the path of the files to check will be different.+If you use different metamodels - or older versions of the Unified Configuration Metamodel - the path of the files to check will be different.
  
-Open all *.css files specified in the following paths:+Open all *.css files specified in the paths below and check for the following font family definition:\\ 
 +//font-family: 'Source Han Sans'//
  
 **Windows server OS:** \\ **Windows server OS:** \\
Line 94: Line 105:
 /opt/stages/data-cache/generated/model/unified_configuration/pdf/1.0/*.css /opt/stages/data-cache/generated/model/unified_configuration/pdf/1.0/*.css
  
-Check each .css file for the following font family definition: //font-family: 'Source Han Sans'//+Make sure the scriptconfig.js specified in the paths below is up to date and contains:\\ 
 +//var FONTNAME = availableFontFamilies.getConfiguredFont(); // \\ 
 +\\ 
 +**Windows server OS:** \\ 
 +<Stages Installation Directory>\stages\data-cache\generated\model\unified_configuration\diagram\trunk\configs\scriptconfig.js\\ 
 +**Linux server OS:** \\ 
 +/opt/stages/data-cache/generated/model/unified_configuration/diagram/trunk/configs/scriptconfig.js
  
-Please note: This is a temporary fix only - every update of the Stages configuration would revoke your changes. So we strongly suggest to also fix this in your metamodel file (.mm). If you need further help to do so - please contact your Stages product consultant or the Stages support team at Method Park.+Please note: This is a temporary fix only - every update of the Stages configuration would revoke your changes. So we strongly suggest to also fix this in your metamodel file (.mm). If you need further help to do so - please contact your Stages Product Consultant or the Stages Support team at Method Park.