From dd4b7d598908a6d90583109bc855c71c1cce0757 Mon Sep 17 00:00:00 2001 From: daisy-jump <88658844+daisy-jump@users.noreply.github.com> Date: Thu, 12 Jun 2025 16:38:42 +0100 Subject: [PATCH] alphabetizing, i had to sing every time. --- src/pages/SupportLifecycles.md | 2 +- .../{01.global.mdx => 01.global.md} | 104 ++++---- usync/01.uSync/40.reference/01.config.md | 241 +++++++++--------- 3 files changed, 172 insertions(+), 175 deletions(-) rename tm/05.reference/{01.global.mdx => 01.global.md} (98%) diff --git a/src/pages/SupportLifecycles.md b/src/pages/SupportLifecycles.md index 87bb191..7486107 100644 --- a/src/pages/SupportLifecycles.md +++ b/src/pages/SupportLifecycles.md @@ -23,7 +23,7 @@ From release, to the end of standard support, we will fix any bugs, and issue up 10 | 16th June 2022 | LTS | 16th June 2024 | 16th June 2025 13 | 14th December 2023 | LTS | 14th December 2025 | 14th December 2026 15 | 14th November 2024 | STS | 12th June 2025 | 14th November 2025 -16 | 12th June 2025 | STS | 12th March 2026 | 12th June 2026 +16 | 12th June 2025 | STS | 27th November 2027 | 12th June 2026 ### Upcoming Releases | Version | Release Date | Type | End of Standard Support | End-of-Life diff --git a/tm/05.reference/01.global.mdx b/tm/05.reference/01.global.md similarity index 98% rename from tm/05.reference/01.global.mdx rename to tm/05.reference/01.global.md index d6d49b6..a92f7d7 100644 --- a/tm/05.reference/01.global.mdx +++ b/tm/05.reference/01.global.md @@ -29,20 +29,20 @@ overriding the default setting. ```json { "Translation": { - "backgroundCheck": true, + "autoTranslate": true, + "autoTranslatePublishOnly": false, "backgroundApproval": false, - "scheduleCheckPeriod": 180, - "includeEmpty": false, + "backgroundCheck": true, "batchSize": 25, - "history": true, + "CheckLinksOnLoopback": false, "fixup": false, - "returnToPending": false, + "hideLicenceTab": false, + "history": true, + "includeEmpty": false, "relationType": "relateDocumentOnCopy", + "returnToPending": false, + "scheduleCheckPeriod": 180, "UniqueNestedIds": true, - "CheckLinksOnLoopback": false, - "autoTranslate": true, - "autoTranslatePublishOnly": false, - "hideLicenceTab": false, "links": { "inline": true, "pickers": false, @@ -51,7 +51,7 @@ overriding the default setting. "pending": "", "approved": "", "submitted": "", - "received": "" + "received": "", "disabled": false, "subject": "Translations : [{job}] - {eventName}", }, @@ -59,9 +59,9 @@ overriding the default setting. "mappers": { "inline":{ "tags": "img,a", - "attributes": "title,alt" + "attributes": "title,alt", "strict": true, - } + }, "text":{ "text": "string.Empty", } @@ -71,35 +71,35 @@ overriding the default setting. ``` -### backgroundCheck -Periodically checks the status of submitted [Jobs](fundementals/job) automatically. +### autoTranslate +Saves the changes that have been made in *Pending*. ```json - "Translation": { - "backgroundCheck": true, +"Translation": { + "autoTranslate": true, } ``` -### BackgroundApproval -Allows the approval process to run in the background (so you don't have to sit around and watch it happen). +### autoTranslatePublishOnly +Only published items are put into the pending queue ```json - "Translation": { - "backgroundApproval": false +"Translation": { + "autoTranslatePublishOnly": false, } ``` -### scheduleCheckPeriod -The number specifies how often the background check occurs. +### BackgroundApproval +Allows the approval process to run in the background (so you don't have to sit around and watch it happen). ```json -"Translation": { - "scheduleCheckPeriod": 180, + "Translation": { + "backgroundApproval": false } ``` -### includeEmpty -Include nodes with no translatable text in jobs. +### backgroundCheck +Periodically checks the status of submitted [Jobs](fundementals/job) automatically. ```json -"Translation": { - "includeEmpty": false, + "Translation": { + "backgroundCheck": true, } ``` @@ -111,11 +111,11 @@ Number of items to process in a batch (if you are experiencing timeouts, try low } ``` -### history -Shows the history tab on a job. This allows you to see events. This setting is on by default +### CheckLinksOnLoopback +Toggle whether or not links within content are checked on translations that are using variants. By default, links are only checked on translations between two different sitenodes. ```json "Translation": { - "history": true, + "CheckLinksOnLoopback": false, } ``` @@ -127,59 +127,59 @@ Turns on debugging in interface by default, so you can delete the things you can } ``` -### returnToPending -Put translated content back into the pending queue if a job is cancelled. May cause conflicts. This setting is off by default. +### hideLicenceTab +Hide the licence tab from the UI. This setting is useful if you dont want anyone to see the licence key. ```json "Translation": { - "returnToPending": false, + "hideLicenceTab": false, } ``` -### relationType -Default Umbraco relation used to link pages across languages. +### history +Shows the history tab on a job. This allows you to see events. This setting is on by default ```json "Translation": { - "relationType": "relateDocumentOnCopy", + "history": true, } ``` -### UniqueNestedIds -Ensures that block and nested items get unique internal IDs when tranlated into other languages. By default these IDS are seperate, but depending on your set up you may want them to remain the same. +### includeEmpty +Include nodes with no translatable text in jobs. ```json "Translation": { - "UniqueNestedIds": true, + "includeEmpty": false, } ``` -### CheckLinksOnLoopback -Toggle whether or not links within content are checked on translations that are using variants. By default, links are only checked on translations between two different sitenodes. +### relationType +Default Umbraco relation used to link pages across languages. ```json "Translation": { - "CheckLinksOnLoopback": false, + "relationType": "relateDocumentOnCopy", } ``` -### autoTranslate -Saves the changes that have been made in *Pending*. +### returnToPending +Put translated content back into the pending queue if a job is cancelled. May cause conflicts. This setting is off by default. ```json "Translation": { - "autoTranslate": true, + "returnToPending": false, } ``` -### autoTranslatePublishOnly -Only published items are put into the pending queue +### scheduleCheckPeriod +The number specifies how often the background check occurs. ```json "Translation": { - "autoTranslatePublishOnly": false, + "scheduleCheckPeriod": 180, } ``` -### hideLicenceTab -Hide the licence tab from the UI. This setting is useful if you dont want anyone to see the licence key. +### UniqueNestedIds +Ensures that block and nested items get unique internal IDs when tranlated into other languages. By default these IDS are seperate, but depending on your set up you may want them to remain the same. ```json "Translation": { - "hideLicenceTab": false, + "UniqueNestedIds": true, } ``` diff --git a/usync/01.uSync/40.reference/01.config.md b/usync/01.uSync/40.reference/01.config.md index 7f81dc9..14cc6ee 100644 --- a/usync/01.uSync/40.reference/01.config.md +++ b/usync/01.uSync/40.reference/01.config.md @@ -12,46 +12,46 @@ The majority of these settings will have default values that do not need to be c { "uSync": { "Settings": { - "Folders": ["uSync/root","uSync/v16"], - "IsRootSite": false, - "LockRoot": false, - "LockRootTypes": "", - "DefaultSet": "Default", - "ImportAtStartup": "None", - "ExportAtStartup": "None", - "ExportOnSave": "All", - "UiEnabledGroups": "All", - "ReportDebug": false, "AddOnPing": true, - "FailOnMissingParent": false, - "FailOnDuplicates": false, + "BackgroundNotifications": false, "CacheFolderKeys": true, - "ShowVersionCheckWarning": true, "CustomMappings": {}, - "EnableHistory": true, - "HistoryFolder": "uSync/history", "DefaultExtension": ".config", - "ImportOnFirstBoot": false, + "DefaultSet": "Default", + "DisableDashboard": false, + "EnableHistory": true, + "ExportAtStartup": "None", + "ExportOnSave": "All", + "FailOnDuplicates": false, + "FailOnMissingParent": false, "FirstBootGroup": "all", + "Folders": ["uSync/root","uSync/v16"], "HideAddOns": false, - "DisableDashboard": false, - "BackgroundNotifications": false, + "HistoryFolder": "uSync/history", + "ImportAtStartup": "None", + "ImportOnFirstBoot": false, + "IsRootSite": false, + "LockRoot": false, + "LockRootTypes": "", + "ReportDebug": false, + "ShowVersionCheckWarning": true, + "UiEnabledGroups": "All", }, "Sets": { "Default": { + "DisabledHandlers": [], "Enabled": true, + "Handlers": {}, "HandlerGroups": [], - "DisabledHandlers": [], "HandlerDefaults": { - "Enabled": true, "Actions": [], - "UseFlatStructure": true, - "GuidNames": false, + "Enabled": true, "FailOnMissingParent": false, "Group": "", - "Settings": {} - }, - "Handlers": {} + "GuidNames": false, + "Settings": {}, + "UseFlatStructure": true + } } } } @@ -60,37 +60,47 @@ The majority of these settings will have default values that do not need to be c ## uSync:Settings -### Folders -Collection of folders uSync looks in when performing imports. uSync merges these folders together, for more info look at [uSync Roots](../guides/syncRoot). +### AddOnPing + +Ping the jumoo.co.uk website to check for addons and updates. ```json "Settings": { - "Folders": ["uSync/root/","uSync/v16"], + "AddOnPing": true, } ``` -### IsRootSite -Sets this site to be the root site (so it will save into "uSync/root/"). +### BackgroundNotifications + +Run all notifications on background thread to speed up import processing, see [Background Notifications](../guides/background) ```json "Settings": { - "IsRootSite": false, + "BackgroundNotifications": false, } ``` -### LockRoot -When locked, you can't make changes to anything that is in the root. +### CacheFolderKeys + +Use a cache for the names and keys of folders during import. This increases import speeds. ```json "Settings": { - "LockRoot": false, + "CacheFolderKeys": true, } ``` -### LockRootTypes -Lock specific types at root so they can't be changed in child sites. +### CustomMappings + +Custom item mappings for 3rd party or custom property editors. +```json +"Settings": { + "CustomMappings": {}, + } +``` -Specific types such as: document, media, member, dictionary-item, macro, template, document-type, media-type, data-type, member-type, member-group, relation-type forms-form, forms-prevalue, forms-datasource, and language. +### DefaultExtension +Default file extension for the uSync files. ```json "Settings": { - "LockRootTypes": "", + "DefaultExtension": ".config", } ``` @@ -103,12 +113,20 @@ Name of the handler set used by default. } ``` -### ImportAtStartup - -Handler groups used when importing items at startup. +### DisableDashboard +Disable the default dashboard (so people can't accidentally press the buttons). ```json "Settings": { - "ImportAtStartup": "None", + "DisableDashboard": false, + } +``` + +### EnableHistory + +Enable viewing the import and export history in the uSync dashboard. +```json +"Settings": { + "EnableHistory": true, } ``` @@ -130,30 +148,11 @@ Handler groups whose items will be exported when changes are saved in Umbraco. } ``` -### UiEnabledGroups - -Handler groups that show in the uSync dashboard. -```json -"Settings": { - "UiEnabledGroups": "All", - } -``` - -### ReportDebug - -Create a report while producing an export (debugging only). -```json -"Settings": { - "ReportDebug": false, - } -``` - -### AddOnPing - -Ping the jumoo.co.uk website to check for addons and updates. +### FailOnDuplicates +Fail if a duplicate file of same type and key is detected during the import process. ```json "Settings": { - "AddOnPing": true, + "FailOnDuplicates": false, } ``` @@ -166,104 +165,105 @@ Should an import fail if the parent of an item is missing. } ``` -### FailOnDuplicates -Fail if a duplicate file of same type and key is detected during the import process. +### FirstBootGroup +Handler group(s) to run on first boot. Default is All (i.e full import) ```json "Settings": { - "FailOnDuplicates": false, + "FirstBootGroup": "all", } ``` -### CacheFolderKeys - -Use a cache for the names and keys of folders during import. This increases import speeds. +### Folders +Collection of folders uSync looks in when performing imports. uSync merges these folders together, for more info look at [uSync Roots](../guides/syncRoot). ```json "Settings": { - "CacheFolderKeys": true, + "Folders": ["uSync/root/","uSync/v16"], } ``` -### ShowVersionCheckWarning - -Display the warning box if the current import is from an older version of uSync. +### HideAddOns +List of addon (tabs) you don't want to show inside uSync dashboard. ```json "Settings": { - "ShowVersionCheckWarning": true, + "HideAddOns": false, } ``` -### CustomMappings - -Custom item mappings for 3rd party or custom property editors. +### HistoryFolder +Location of the history folder. ```json "Settings": { - "CustomMappings": {}, + "HistoryFolder": "uSync/history", } ``` -### EnableHistory - -Enable viewing the import and export history in the uSync dashboard. +### ImportAtStartup + +Handler groups used when importing items at startup. ```json "Settings": { - "EnableHistory": true, + "ImportAtStartup": "None", } ``` -### HistoryFolder -Location of the history folder. +### ImportOnFirstBoot +Import the uSync folder on the first boot. ```json "Settings": { - "HistoryFolder": "uSync/history", + "ImportOnFirstBoot": false, } ``` -### DefaultExtension -Default file extension for the uSync files. +### IsRootSite +Sets this site to be the root site (so it will save into "uSync/root/"). ```json "Settings": { - "DefaultExtension": ".config", + "IsRootSite": false, } ``` -### ImportOnFirstBoot -Import the uSync folder on the first boot. +### LockRoot +When locked, you can't make changes to anything that is in the root. ```json "Settings": { - "ImportOnFirstBoot": false, + "LockRoot": false, } ``` -### FirstBootGroup -Handler group(s) to run on first boot. Default is All (i.e full import) +### LockRootTypes +Lock specific types at root so they can't be changed in child sites. + +Specific types such as: document, media, member, dictionary-item, macro, template, document-type, media-type, data-type, member-type, member-group, relation-type forms-form, forms-prevalue, forms-datasource, and language. ```json "Settings": { - "FirstBootGroup": "all", + "LockRootTypes": "", } ``` -### HideAddOns -List of addon (tabs) you don't want to show inside uSync dashboard. +### ReportDebug + +Create a report while producing an export (debugging only). ```json "Settings": { - "HideAddOns": false, + "ReportDebug": false, } ``` -### DisableDashboard -Disable the default dashboard (so people can't accidentally press the buttons). +### ShowVersionCheckWarning + +Display the warning box if the current import is from an older version of uSync. ```json "Settings": { - "DisableDashboard": false, + "ShowVersionCheckWarning": true, } ``` -### BackgroundNotifications - -Run all notifications on background thread to speed up import processing, see [Background Notifications](../guides/background) +### UiEnabledGroups + +Handler groups that show in the uSync dashboard. ```json "Settings": { - "BackgroundNotifications": false, + "UiEnabledGroups": "All", } ``` @@ -296,6 +296,9 @@ Members and groups ## uSync:Sets +### DisabledHandlers + +List of handlers to disable for this set. ### Enabled @@ -305,29 +308,16 @@ Turn on the handler set. List of handler groups to include in this set. -### DisabledHandlers - -List of handlers to disable for this set. - ## uSync:Sets:HandlerDefaults Default settings for the handler, these values can be overridden for individual handlers. - -### Enabled - -Enable or disable the handler. - ### Actions List of actions for which the handler is valid. -### UseFlatStructure - - Use a flat file structure for the file produced by the handler. - -### GuidNames - -Should uSync use the guid of an item as its file name. This ensures there are no clashes in names, but makes it harder to manually read what settings are in a folder. +### Enabled + +Enable or disable the handler. ### FailOnMissingParent @@ -337,12 +327,19 @@ Should an import fail if the parent of an item is missing. Override the group used for a handler. +### GuidNames + +Should uSync use the guid of an item as its file name. This ensures there are no clashes in names, but makes it harder to manually read what settings are in a folder. + ### Settings Specific settings for each handler, this will override the defaults. +### UseFlatStructure + + Use a flat file structure for the file produced by the handler. -### Action Values +## Action Values Actions values determine which 'actions' a handler fires for. The handler action value can be a combination of any of the actions below. ### Report