Meta tags:
description=Explore the possibilities of the crowdin.yml configuration file;

Headings (most frequently used words):

file, configuration, files, options, and, for, import, pull, request, on, structure, languages, source, export, uploading, to, specified, strings, vcs, integrations, labels, escape, project, this, page, writing, simple, api, credentials, from, environment, variables, general, placeholders, usage, of, wildcards, renaming, translations, ignoring, directories, excluding, target, multilingual, spreadsheet, saving, directory, server, path, with, type, changed, update, custom, segmentation, adding, language, mapping, using, one, cli, example, configurations, xml, other, java, properties, format, title, commit, message, assignee, reviewer, scheme, constants, quotes, special, characters, csv, gettext, android,

Text of the page (most frequently used words):
the (156), crowdin (92), file (83), files (67), source (57), for (56), txt (49), you (46), configuration (46), and (43), #translation (41), yml (36), section (36), titled (35), locale (31), use (31), translations (29), your (27), can (26), strings (26), original_file_name (25), example (23), with (23), project (22), directory (22), request (22), api (20), two_letters_code (20), language (20), pull (20), are (19), labels (18), structure (18), import (17), folder (17), will (16), default (16), options (16), name (15), path (15), cli (14), vcs (14), custom (14), languages (14), parameter (14), that (14), values (13), xml (13), integrations (13), from (13), export (13), context (12), csv (12), directories (12), message (12), true (11), contains (11), single (11), upload (11), properties (11), type (11), app (11), ignore (11), apps (11), this (10), parameters (10), one (10), all (10), server (10), escape (10), segmentation (10), optional (10), column (10), wildcards (10), base_path (9), token (9), scheme (9), mapping (9), should (9), credentials (9), following (9), set (9), option (9), specified (9), changed (9), content (8), com (8), api_token (8), project_id (8), android (8), identifier (8), used (8), when (8), uploading (8), placeholders (8), new (8), github (8), not (8), commit (8), text (8), quote (8), value (8), file_name (8), preserve_hierarchy (8), priority (8), menu (8), access (7), only (7), whether (7), variables (7), them (7), using (7), other (7), any (7), emails (7), specify (7), into (7), title (7), acceptable (7), defines (7), preserve (7), target (7), test (7), overview (7), https (6), base_url (6), personal (6), source_phrase (6), environment (6), like (6), need (6), have (6), special (6), resources (6), json (6), added (6), pull_request_reviewers (6), bitbucket (6), skip (6), false (6), update (6), usage (6), processing (6), android_code (5), projectid (5), integration (5), enterprise (5), also (5), names (5), character (5), add (5), user (5), numeric (5), gitlab (5), assignee (5), supported (5), additional (5), characters (5), backslash (5), format (5), html (5), texts (5), machine (5), note (5), update_option (5), xlsx (5), dest (5), ignoring (5), page (4), columns (4), configurations (4), another (4), own (4), during (4), adding (4), reviewer (4), append_commit_message (4), resulting (4), store (4), exported (4), java (4), specific (4), bool (4), description (4), array (4), where (4), rules (4), saving (4), none (4), string (4), multilingual (4), spreadsheet (4), translated (4), excluding (4), renaming (4), 123_test (4), 123 (4), code (4), general (4), high (4), low (4), organization (4), writing (4), simple (4), studio (4), plugin (4), select (4), podcast (4), sdk (4), based (4), editor (4), modules (4), res (3), first_line_contains_header (3), split (3), command (3), contain (3), cases (3), both (3), without (3), changes (3), about (3), named (3), represented (3), still (3), codes (3), projects (3), allows (3), limitations (3), uploaded (3), won (3), remove (3), azure (3), repos (3), managed (3), pull_request_assignees (3), replace (3), include (3), fix (3), commit_message (3), looks (3), once (3), each (3), time (3), same (3), security (3), per (3), content_segmentation (3), sample1 (3), translate_content (3), translate_attributes (3), sample (3), translate (3), pre (3), three_letters_code (3), validations (3), conf (3), file_extension (3), don (3), bar (3), foo (3), skipped (3), information (3), xls (3), constants (3), help (3), local (3), _en (3), pattern (3), including (3), matches (3), patterns (3), crowdin_base_path (3), tools (3), panel (3), please (2), before (2), languages_mapping (2), zh_ch (2), gettext (2), max_length (2), define (2), specifies (2), line (2), imported (2), via (2), look (2), doesn (2), required (2), directly (2), there (2), two (2), separate (2), make (2), work (2), read (2), more (2), let (2), say (2), label (2), initial (2), next (2), existing (2), uuid (2), user_id2 (2), user_id1 (2), self (2), login2 (2), login1 (2), particular (2), users (2), tag (2), want (2), caution (2), filename (2), languagename (2), setting (2), build (2), pull_request_labels (2), pull_request_title (2), tool (2), escape_special_characters (2), escape_quotes (2), escaped (2), containing (2), quotes (2), customize (2), process (2), types (2), long (2), smaller (2), segments (2), front (2), matter (2), markdown (2), xliff (2), enabled (2), handled (2), experimental (2), learning (2), technology (2), translatable (2), stored (2), attribute (2), nodes (2), parent (2), node (2), translatable_elements (2), element (2), defined (2), while (2), tags (2), attributes (2), srx (2), update_without_changes (2), update_as_unapproved (2), works (2), multiple (2), original_path (2), above (2), follows (2), shared (2), root (2), such (2), multicolumn (2), ukrainian (2), appropriate (2), export_languages (2), some (2), excluded_target_languages (2), workflow (2), paramètres (2), lokalisierung (2), translation_replace (2), crowdin_test (2), iso (2), 639 (2), extension (2), original (2), bundle (2), recursively (2), asterisk (2), has (2), base_url_env (2), base_path_env (2), crowdin_personal_token (2), api_token_env (2), crowdin_project_id (2), project_id_env (2), folder1 (2), visual (2), console (2), client (2), 简体中文 (2), türkçe (2), español (2), português (2), portugal (2), français (2), dansk (2), deutsch (2), english (2), auto (2), light (2), dark (2), theme (2), spotify (2), apple (2), youtube (2), linkedin (2), twitter (2), localization (2), webhook (2), post (2), profile (2), settings (2), crowdsource (2), view (2), publishing (2), developer (2), portal (2), thank, feedback, submit, enter, comment, submitting, was, helpful, copy, edit, lc_messages, data, first, headers, alternatively, may, download, terminal, window, result, downloading, since, pass, necessary, mostly, kind, situation, however, placeholder, override, etc, often, software, map, recognizable, except, labeled, syncs, guid2, guid1, username2, username1, uuid2, uuid1, review, assign, longer, automatically, intermediate, builds, insert, instead, appended, below, equivalent, syncing, many, trigger, runs, expected, these, merged, main, branch, through, commits, uses, l10n, updates, require, meaning, difference, header, reasons, few, docx, dita, idml, mediawiki, sample2, item, xpaths, dom, taken, account, importing, attr, placed, inside, custom_segmentation, key, automatic, those, they, exist, depending, lost, useful, typo, fixes, minor, supports, feature, adds, support, typically, must, different, detect, correctly, created, hierarchy, flatten, max, length, limit, comments, but, filled, source_or_translation, identifiers, form, ident3, ident2, ident1, french, spanish, mexico, available, shouldn, exclude, templates, config, case, erased, replaced, respectively, renamed, strings_en, rename, parts, after, archive, putting, slash, beginning, hans, zh_hk, osx_locale, lproj, osx_code, uk_ua, locale_with_underscore, ukr, take, put, escapes, metacharacter, matchesany, behaves, exactly, sets, regexp, negation, question, mark, subdirectories, always, includes, sub, given, doubled, anything, ends, about_us, messages, here, provided, standard, known, globbing, easier, mixed, prioritized, crowdin_base_url, could, load, variable, filter, preserved, flattened, base, url, relative, owner, least, manager, permissions, typical, similar, fields, filters, instructions, already, describes, manage, head, preferences, valid, ensure, fill, out, needed, cross, platform, various, locations, corresponding, shopify, automating, screenshot, management, mobile, guides, authorizing, oauth, understanding, scopes, addresses, domains, flutter, website, ios, action, skills, dev, mcp, query, croql, graphql, themes, pseudolocalization, events, capabilities, step, external, check, spellchecker, auth, guard, alignment, generator, processors, prompt, provider, chat, modal, asset, right, reports, promoting, releasing, monetization, interface, installation, descriptor, serverless, quick, start, cancel, ctrl, search, community, blog, docs,

Text of the page (random words):
l chat ai modules overview custom ai ai prompt provider ai request processors file processing modules overview custom file format custom bundle generator file pre import processing file post import processing file pre export processing file post export processing translation alignment processing other api auth guard custom spellchecker external qa check webhook workflow step type capabilities in context webhook events pseudolocalization editor themes api overview crowdin api file based crowdin api string based enterprise api file based enterprise api string based graphql api crowdin query language croql crowdin mcp server language codes dev tools overview crowdin skills new configuration file console client cli github action visual studio code plugin android studio plugin android sdk ios sdk website js sdk flutter sdk security ip addresses and domains understanding scopes authorizing oauth apps guides mobile apps localization automating screenshot management shopify apps localization x twitter linkedin youtube github apple podcast spotify podcast select theme dark light auto select language english deutsch dansk français português portugal español türkçe 简体中文 on this page overview configuration file structure writing a simple configuration file api credentials from environment variables general configuration placeholders usage of wildcards renaming translations file ignoring files and directories excluding target languages for source files export languages multilingual spreadsheet saving directory structure on server uploading files to specified path with specified type changed strings update custom segmentation import options xml files import options other files import options export options java properties file format configuration file for vcs integrations pull request title and labels commit message pull request assignee pull request reviewer adding labels to source strings language mapping using one configuration file for vcs integrations and cli example configurations on this page overview configuration file structure writing a simple configuration file api credentials from environment variables general configuration placeholders usage of wildcards renaming translations file ignoring files and directories excluding target languages for source files export languages multilingual spreadsheet saving directory structure on server uploading files to specified path with specified type changed strings update custom segmentation import options xml files import options other files import options export options java properties file format configuration file for vcs integrations pull request title and labels commit message pull request assignee pull request reviewer adding labels to source strings language mapping using one configuration file for vcs integrations and cli example configurations configuration file the various crowdin tools use a crowdin yml configuration file that specifies the resources to be managed including the files to be uploaded to crowdin and the locations of the corresponding translations vcs integrations github gitlab bitbucket azure repos console client cli cross platform command line tool visual studio code plugin android studio plugin configuration file structure section titled configuration file structure a valid crowdin yml configuration file has the following structure so please ensure that you fill out all the needed information head of the file with project credentials preferences and access information one files array element that describes a set of source and translation files you will manage required fields in the files array source that defines filters for the source files and translation with instructions on where to store the translated files or where to look for translations you already have if you want to upload them while setting up the cli writing a simple configuration file section titled writing a simple configuration file a typical configuration file looks similar to the following crowdin yml project_id projectid api_token personal access token base_path base_url https api crowdin com preserve_hierarchy true files source locale en folder1 0 2 txt translation locale two_letters_code folder1 original_file_name name description project_id crowdin project numeric id api_token crowdin personal access token the token owner should have at least manager permissions in the project base_path optional path to your project directory on a local machine relative to the crowdin yml configuration file base_url optional crowdin api base url optional for crowdin com for crowdin enterprise use the https organization name api crowdin com preserve_hierarchy optional if set to true the directory structure will be preserved on the server if set to false the directory structure will be flattened source filter for the source files wildcards are supported translation path to store the translated files wildcards are supported api credentials from environment variables section titled api credentials from environment variables you could load the api credentials from an environment variable for example crowdin yml project_id_env crowdin_project_id api_token_env crowdin_personal_token base_path_env crowdin_base_path base_url_env crowdin_base_url if mixed api_token and project_id are prioritized crowdin yml project_id_env crowdin_project_id low priority api_token_env crowdin_personal_token low priority base_path_env crowdin_base_path low priority base_url_env crowdin_base_path low priority project_id projectid high priority api_token personal access token high priority base_path high priority base_url https api crowdin com high priority general configuration section titled general configuration the sample configuration provided above has source and translation attributes containing standard wildcards also known as globbing patterns to make it easier to work with multiple files here are patterns you can use asterisk matches any character in the file or directory name if you specify json it will include all files like messages json about_us json and anything that ends with json doubled asterisk matches any string recursively including subdirectories note that you can use in both the source and translation patterns when you use in the translation pattern it always includes a sub path from the source for a given file for example you can use source en po to recursively upload all po files to crowdin the translation pattern will be two_letters_code original_file_name question mark matches any single character set matchesany single character in a set behaves exactly like character sets in regexp including set negation a z backslash escapes the next metacharacter placeholders section titled placeholders crowdin cli allows to use the following placeholders to put appropriate variables into the resulting file name name description original_file_name original file name original_path take parent folder names in the crowdin project to build file path in the resulting bundle file_extension original file extension file_name file name without extension language language name e g ukrainian two_letters_code language code iso 639 1 e g uk three_letters_code language code iso 639 2 t e g ukr locale locale e g uk ua locale_with_underscore locale e g uk_ua android_code android locale identifier used to name values directories osx_code os x locale identifier used to name lproj directories osx_locale os x locale used to name translation resources e g uk zh hans zh_hk you can also define the path for files in the resulting archive by putting a slash at the beginning of the pattern usage of wildcards section titled usage of wildcards structure of files and directories on the local machine directory base_path directory folder 1 xml 1 txt 123 txt 123_test txt a txt a1 txt crowdin test txt crowdin_test txt 1 xml 1 txt 123 txt 123_test txt a txt a1 txt crowdin test txt crowdin_test txt 3 txt example 1 usage of wildcards in the source path crowdin yml files source 0 9 txt upload a1 txt folder a1 txt translation two_letters_code _ original_file_name source txt upload crowdin test txt folder crowdin test txt translation two_letters_code _ original_file_name source 0 2 txt upload 3 txt folder 3 txt a txt folder a txt ignore 1 txt folder 1 txt translation two_letters_code _ original_file_name example 2 usage of wildcards for ignoring files crowdin yml files source upload all files that the base_path contains translation two_letters_code _ original_file_name ignore two_letters_code _ original_file_name ignore the translated files txt ignore 1 txt a txt folder 1 txt folder a txt 0 9 txt ignore 1 txt folder 1 txt txt ignore crowdin test txt folder crowdin test txt 0 9 0 9 0 9 txt ignore 123 txt folder 123 txt 0 9 _ txt ignore 123_test txt folder 123_test txt renaming translations file section titled renaming translations file if you need to rename a file with translations or replace parts of the path after export you can use the translation_replace parameter for example if the file is named strings_en po it can be renamed to strings po or you can replace folder names in the translation path crowdin yml files source locale _en po translation locale original_file_name _ two_letters_code translation_replace _en de locale de lokalisierung fr locale fr paramètres in this case _en will be erased from the file name and the folder names de locale and fr locale will be replaced with de lokalisierung and fr paramètres respectively ignoring files and directories section titled ignoring files and directories from time to time there are files and directories you don t need to translate in crowdin in such cases local per file rules can be added to the config file in your project crowdin yml files source properties translation file_name _ two_letters_code file_extension ignore test file properties example properties source locale en po translation locale two_letters_code original_file_name ignore locale en templates locale en workflow you can also use wildcards to ignore files excluding target languages for source files section titled excluding target languages for source files by default the source files are available for translation into all target languages of the project if some source files shouldn t be translated into specific target languages you can exclude them with the help of the parameter excluded_target_languages configuration file example crowdin yml files source resources en json translation resources two_letters_code original_file_name excluded_target_languages uk fr export languages section titled export languages by default all the languages are exported if you need to export some specific languages use the export_languages parameter to specify them crowdin yml export_languages uk ja multilingual spreadsheet section titled multilingual spreadsheet if a csv or xls xlsx file contains the translations for all target languages you should specify appropriate language codes in the scheme csv file example identifier source_phrase context ukrainian spanish mexico french ident1 source 1 context 1 ident2 source 2 context 2 ident3 source 3 context 3 configuration file example crowdin yml files source multicolumn csv translation multicolumn csv first_line_contains_header true scheme identifier source_phrase context uk es mx fr if your csv or xls xlsx file contains columns that should be skipped on import use none for such columns in the scheme for example crowdin yml scheme identifier source_phrase context uk none es mx none fr scheme constants section titled scheme constants to form the scheme for your csv or xls xlsx file use the following constants identifier column contains string identifiers source_phrase column contains source strings source_or_translation column contains source strings but the same column will be filled with translations when the file is exported when uploading existing translations the values from this column will be used as translations translation column contains translations context column contains comments or context information for the source strings max_length column contains max length limit values for the translations of the strings labels column contains labels for the source strings none column that will be skipped on import saving directory structure on server section titled saving directory structure on server you can use the preserve_hierarchy option to preserve or flatten the directory structure of your source files in the crowdin project example of the configuration file using the preserve_hierarchy option crowdin yml preserve_hierarchy true files source locale en po translation locale two_letters_code original_file_name let s say the file folder structure on your machine looks like this directory locale directory en directory emails directory app foo po bar po if you don t use the preserve_hierarchy true option in your configuration file at all or use it with the false value all shared directories will be skipped and the file structure in crowdin will be represented as follows directory root foo po bar po note for vcs integrations the default value of the preserve hierarchy option is true the false value works only if your source files have a shared root directory using the preserve_hierarchy true option the file structure in crowdin will be represented as follows directory locale directory en directory app foo po bar po the directories that don t contain any files for translation won t be created in crowdin i e as the emails directory in the example above uploading files to specified path with specified type section titled uploading files to specified path with specified type this feature adds support for two optional parameters in the yml file section dest and type it s typically used for projects where the uploaded name must be different so that crowdin can detect the type correctly the dest parameter allows you to specify a file name in crowdin it works for multiple files at once and supports the following placeholders original_file_name original_path file_extension file_name caution if you use the dest parameter the configuration file should include the preserve_hierarchy parameter with the true value example of the configuration file with both parameters crowdin yml files source conf txt dest conf file_name properties translation conf two_letters_code file_name properties type properties source app txt dest app file_name xml translation res values android_code original_file_name type android changed strings update section titled changed strings update you can use the update_option parameter to preserve translations for changed strings during the file update if it is not set translations for changed strings will be lost useful for typo fixes and minor changes in source strings depending on the value update_option is used to preserve translations and preserve remove validations of changed strings during file update acceptable values update_as_unapproved preserve translations of changed strings and remove...