Meta tags:
description=ICU is a mature, widely used set of C/C++ and Java libraries providing Unicode and Globalization support for software applications. The ICU User Guide provides documentation on how to use ICU.;

Headings (most frequently used words):

resource, data, resources, of, bundles, accessing, the, apis, keeping, by, management, contents, overview, icu, model, bundle, separate, small, find, best, available, fallback, mechanism, packaging, error, checking, opening, closing, format, syntax, escape, sequences, examples, making, your, own, using, xliff, for, localization, types, key, index, iterating, over, in, simple, convenience, other,

Text of the page (most frequently used words):
the (312), #resource (140), data (94), for (93), and (88), resources (67), you (63), bundle (62), that (62), icu (60), will (51), const (48), this (44), can (44), are (43), status (43), uresourcebundle (40), name (39), locale (34), bundles (33), root (31), api (31), use (30), file (30), using (29), with (29), uerrorcode (29), apis (29), not (26), from (26), language (25), xliff (24), resourcebundle (23), int32_t (22), tool (21), string (21), txt (21), more (21), source (20), package (20), index (20), all (19), table (19), genrb (19), key (19), should (18), your (17), format (16), need (15), through (15), accessing (15), version (14), code (14), have (14), type (14), char (14), used (13), usage (13), icu4c (13), also (13), null (13), there (13), files (12), java (12), order (12), default (12), examples (12), unicodestring (12), unicode (11), line (11), like (11), simple (11), example (11), same (11), region (11), return (11), error (11), other (10), option (10), would (10), want (10), some (10), only (10), access (10), already (10), binary (10), strings (10), tables (10), iteration (10), uchar (10), zones (10), opening (10), when (10), general (10), specify (9), note (9), one (9), res (9), information (9), see (9), array (9), its (9), which (9), formatting (9), command (8), case (8), they (8), trans (8), unit (8), header (8), might (8), contain (8), here (8), appropriate (8), characters (8), different (8), stored (8), items (8), resb (8), framework (8), len (8), currentzone (8), requested (8), setup (8), documentation (7), date (7), optionmessage (7), out (7), icu4j (7), encoding (7), produce (7), application (7), several (7), start (7), following (7), argument (7), empty (7), locales (7), way (7), integer (7), ures_close (7), mechanism (7), most (7), specific (7), time (6), ufortune (6), how (6), look (6), xml (6), target (6), oasis (6), names (6), open (6), translators (6), get (6), named (6), provides (6), allow (6), myapplication (6), either (6), therefore (6), found (6), structure (6), fallback (6), find (6), arrays (6), complex (6), means (6), such (6), user (6), english (6), docs (5), page (5), http (5), www (5), org (5), xliff2icuconverter (5), than (5), available (5), set (5), document (5), utf (5), does (5), own (5), ures_open (5), over (5), int (5), first (5), must (5), codes (5), value (5), point (5), alias (5), integers (5), store (5), copy (5), indexes (5), void (5), urestype (5), u_success (5), returned (5), interesting (5), stuff (5), new (5), informational (5), release (5), object (5), was (5), speaking (5), collation (5), country (5), languages (5), countries (5), keeping (5), uses (4), just (4), github (4), 2007 (4), xlf (4), unrecognized (4), needs (4), after (4), two (4), class (4), relies (4), provide (4), body (4), group (4), resname (4), urn (4), xsi (4), xmlns (4), tools (4), bit (4), call (4), specified (4), localization (4), packaging (4), takes (4), take (4), memory (4), etc (4), ascii (4), options (4), create (4), fill (4), make (4), syntax (4), about (4), escape (4), always (4), gets (4), part (4), exit (4), types (4), number (4), icuroot (4), ures_getbykey (4), below (4), result (4), iterating (4), else (4), retrieve (4), close (4), done (4), individual (4), situation (4), were (4), both (4), search (4), spanish (4), management (4), even (4), chinese (4), required (4), separate (4), regions (4), edit (3), then (3), com (3), ibm (3), dev (3), localeconverter (3), well (3), original (3), core (3), above (3), instead (3), library (3), pkgdata (3), test (3), however (3), section (3), end (3), platforms (3), them (3), en_us (3), optional (3), invariant (3), list (3), localized (3), native (3), users (3), know (3), best (3), making (3), into (3), care (3), break (3), level (3), has (3), contents (3), points (3), values (3), sequences (3), specifying (3), path (3), storing (3), binaries (3), holds (3), unnamed (3), don (3), but (3), defined (3), whole (3), including (3), versioninfo (3), pick (3), zonestrings (3), before (3), going (3), change (3), ures (3), size (3), ures_getsize (3), retrieving (3), trying (3), convenience (3), analogous (3), difference (3), objects (3), rest (3), while (3), got (3), iterator (3), fillin (3), second (3), opened (3), similar (3), parameter (3), valid (3), handle (3), closed (3), u_using_default_warning (3), keys (3), elements (3), operations (3), closing (3), everything (3), fine (3), u_zero_error (3), constructor (3), special (3), packages (3), important (3), allows (3), build (3), usually (3), particular (3), custom (3), may (3), made (3), functioning (3), model (3), presented (3), script (3), could (3), tree (3), software (3), mexico (3), convenient (3), rules (3), message (3), process (3), localizing (3), overview (3), updating (3), cldr (3), integration (3), faq (3), site (2), theme (2), jekyll (2), later (2), back (2), these (2), hst (2), trunk (2), icuhtml (2), userguide (2), nepoznata (2), opcija (2), komandnoj (2), liniji (2), upotreba (2), lokal (2), running (2), input (2), output (2), produced (2), parser (2), jdk (2), convert (2), restype (2), 17t21 (2), 08z (2), datatype (2), preserve (2), space (2), committees (2), documents (2), xsd (2), schemalocation (2), 2001 (2), xmlschema (2), instance (2), translation (2), support (2), translations (2), processed (2), specifies (2), assume (2), resulting (2), constructed (2), dat (2), archives (2), shared (2), still (2), maintenance (2), icupkg (2), packagelist (2), common (2), tmpdir (2), es_es (2), en_gb (2), windows (2), especially (2), except (2), directory (2), slash (2), uxxxx (2), write (2), destination (2), decide (2), chain (2), sr_cs (2), entries (2), serbian (2), whether (2), certain (2), program (2), probably (2), our (2), lines (2), doesn (2), invalid (2), between (2), literal (2), double (2), escaped (2), aliases (2), useful (2), duplication (2), aliased (2), vectors (2), intvector (2), integervalue (2), bin (2), import (2), since (2), sub (2), subresource1 (2), subresourcen (2), menu (2), save (2), cut (2), paste (2), errors (2), read (2), icudata (2), collationelements (2), written (2), supported (2), uversioninfo (2), gettype (2), ures_gettype (2), summarized (2), getstringex (2), indexs (2), returning (2), discussed (2), uint32_t (2), uint8_t (2), versionstringlen (2), ures_getstring (2), according (2), pointers (2), wrong (2), ubool (2), cleanup (2), ures_getnextresource (2), ures_hasnext (2), ures_resetiterator (2), though (2), reset (2), starting (2), check (2), regardless (2), ures_getbyindex (2), requires (2), arguments (2), u_missing_resource_error (2), any (2), reused (2), exist (2), mentioned (2), affect (2), u_using_fallback_warning (2), ordering (2), able (2), ways (2), accessed (2), main (2), structures (2), sections (2), previous (2), prevent (2), scope (2), function (2), report (2), rely (2), operation (2), apart (2), regular (2), warning (2), correct (2), fails (2), checking (2), converter (2), missing (2), consider (2), remote (2), server (2), situations (2), provided (2), localizable (2), comes (2), hant (2), hans (2), united (2), states (2), ireland (2), changes (2), variant (2), legacy (2), german (2), posix (2), duplicated (2), lead (2), separately (2), calls (2), structured (2), correctly (2), details (2), very (2), query (2), small (2), messages (2), icons (2), kept (2), easy (2), content (2), editing (2), product (2), home (2), git (2), profiling (2), developers (2), contributors (2), guide (2), synchronization (2), numbers (2), update (2), measureunit (2), publish (2), tests (2), tries (2), normalization (2), design (2), layout (2), rulebasednumberformat (2), calendar (2), services (2), conversion (2), link (2), 2016, inc, others, license, terms, copyright, html, top, converted, optionally, directories, being, newer, box, earlier, versions, install, xerces, sent, tells, try, deduce, iso, platform, attribute, units, converting, possible, generate, became, static, easier, installation, patching, recommended, mkdir, echo, sample, batch, compiling, packing, rolling, practice, together, good, places, course, testdata, containing, mapped, dynamically, linked, had, invoked, forward, now, ready, err, packagename_localename, followed, compile, expects, bom, full, retrieved, invoking, help, destdir, localize, leave, off, perform, steps, testtypes, averylongstring, quite, long, broken, indentation, breaks, continue, many, outside, 122, errorcodes, adding, suggest, curly, brackets, carriage, feed, control, non, unassigned, invisible, property, default_ignorable_code_point, uax, quote, quoted, u0022, x22, backslash, doubled, u005c, x5c, style, consistent, ustring, u_unescape, u00hhhhhh, uhhhh, xhh, although, omitted, backward, compatibility, reasons, strongly, encouraged, complicated, combinations, typed, unexpected, results, preventing, branch, position, integervaluen, images, byte, binarydata, filenametoimport, hold, chunk, encoded, unicodetext, require, less, fast, allowed, subname1, subnamen, description, described, uresdata, comments, extend, every, consists, digits, symbols, mainmenu, thus, accessible, bad, add, manual, splash, splash_root, gif, imported, pgpkey, a1b2c3d4e5f67890, major, minor, patch, buttonsize, simplealias, compiled, utility, currently, text, formal, definition, returns, stay, tuned, getlocale, ures_getlocale, fills, getversion, ures_getversion, member, getkey, ures_getkey, getsize, additional, getnextstring, ures_getnextunicodestring, ures_getnextstring, ures_getunicodestringbyindex, ures_getstringbyindex, ures_getunicodestringbykey, ures_getstringbykey, work, compiler, unicodestrings, vast, majority, directly, getintvector, ures_getintvector, getuint, getint, ures_getuint, ures_getint, signed, unsigned, getbinary, ures_getbinary, versionstring, getstring, considered, hasnext, resetiterator, getnext, simply, advisable, ensure, indeed, beginning, somebody, been, playing, iterated, overloads, themselves, supply, semantics, zero, range, maximum, minus, indexr, u_resource_type_mismatch, clean, parent, pass, existing, indicator, indicates, validity, retrieval, necessarily, correspond, due, organized, sorted, item, furthermore, ebcdic, distinguish, hand, analog, enumeration, ones, single, once, possession, handles, saves, frequent, reallocating, dramatically, improve, performance, reuse, share, invoke, success, leaks, allocated, sure, delete, de_at, mypackage, myresource, automatic, construction, afterwards, constructors, notable, given, passed, remarks, couple, fail, successful, performed, ures_openu, ures_opendirect, third, calling, guarantee, system, almost, certainly, frequently, construct, include, resbund, paradigm, implementation, thin, wrapper, around, generally, faster, internal, transformation, inside, present, sought, initial, went, zh_hans_cn, looked, zh_hans, finally, harmless, located, finding, what, adhere, contract, taken, mean, anything, imagine, where, japan, responds, client, japanese, essential, ensures, effort, obtain, usable, happen, discussion, pertains, collections, their, projects, think, reflected, lot, frameworks, bases, ideas, concentrated, closely, tied, naming, scheme, clear, having, completely, tag, multi, uzbek, azerbaijani, han, identified, traditional, simplified, let, contains, implementors, conforms, conventions, overriding, put, en_us_posix, differences, germany, austria, spoken, currency, parts, french, canada, side, duplicate, day, stores, commonly, development, team, branches, specialized, repeated, grouped, automatically, suitable, sometimes, exact, happier, captions, another, reduce, linking, relation, unlikely, days, month, spain, beneficial, achieved, structuring, unsuccessful, triggers, limited, gui, patterns, often, cultures, obviously, wade, recipe, disaster, translatable, managing, hence, human, readable, editable, wins, loses, depending, simplest, view, translated, doing, things, sorting, eventually, involve, experts, culture, keep, mind, designing, describes, techniques, related, local, tooling, configs, maven, monitoring, errorprone, eclipse, ant, callgrind, configuring, linux, built, skipping, known, failures, standards, wip, miscellaneous, procedure, legalities, healthy, updates, announcements, milestone, tasks, developing, fuzzer, targets, continuous, coding, guidelines, reports, preparsed, ucd, ucharstrie, bytestrie, cobol, tracing, paragraph, engine, ustream, ustdio, boundary, analysis, ignore, punctuation, customization, architecture, concepts, transform, rule, tutorial, bidi, algorithm, mappings, transforms, final, candidate, messageformat, dates, times, formattedvalue, skeletons, rounding, modes, numberformat, universal, scale, zone, timezone, classes, compression, charset, detection, stringprep, expressions, unicodeset, properties, utext, characteriterator, iterators, chars, why, service, provider, plug, ins, building, demos, glossary, info, migration, basics, internationalization, contacts, mailing, lists, downloading, copied, external, expand, skip,

Text of the page (random words):
ndle currentzone null int32_t index 0 for index 0 index ures_getsize zones index currentzone ures_getbyindex zones index currentzone status do interesting stuff here ures_close currentzone cleanup the rest accessing simple resource with an index 0 will return themselves this is useful for iterating over all the resources regardless of type c overloads the get api with resourcebundle get int32_t index uerrorcode status const iterating over resources if you don t care about the order of the resources and want simple code you can use the iteration mechanism to set up iteration over a complex resource you can simply start iterating using the uresourcebundle ures_getnextresource uresourcebundle resourcebundle uresourcebundle fillin uerrorcode status it is advisable though to reset the iterator for a resource before starting in order to ensure that the iteration will indeed start from the beginning just in case somebody else has already been playing with this resource to reset the iterator use void ures_resetiterator uresourcebundle resourcebundle api to check whether there are more resources call ubool ures_hasnext uresourcebundle resourcebundle if you have iterated through the whole resource null will be returned we already got zones resource from the accessing by key example uresourcebundle currentzone null ures_resetiterator zones while ures_hasnext zones currentzone ures_getnextresource zones currentzone status do interesting stuff here ures_close currentzone cleanup the rest c provides analogous apis resourcebundle getnext uerrorcode status void resetiterator and ubool hasnext accessing data in the simple resources in order to get to the data in the simple resources you need to use appropriate apis according to the type of a simple resource they are summarized in the tables below all the pointers returned should be considered pointers to read only data using an api on a resource of a wrong type will result in an error strings language api c const uchar ures_getstring const uresourcebundle resourcebundle int32_t len uerrorcode status c unicodestring getstring uerrorcode status const example uresourcebundle version ures_getbykey icuroot version null status if u_success status int32_t versionstringlen 0 const uchar versionstring ures_getstring version versionstringlen status ures_close version binaries language api c const uint8_t ures_getbinary const uresourcebundle resourcebundle int32_t len uerrorcode status c const uint8_t getbinary int32_t len uerrorcode status const integers signed and unsigned language api c int32_t ures_getint const uresourcebundle resourcebundle uerrorcode status uint32_t ures_getuint const uresourcebundle resourcebundle uerrorcode status c int32_t getint uerrorcode status const uint32_t getuint uerrorcode status const integer arrays language api c const int32_t ures_getintvector const uresourcebundle resourcebundle int32_t len uerrorcode status c const int32_t getintvector int32_t len uerrorcode status const convenience apis since the vast majority of data stored in resource bundles are strings icu s resource bundle framework provides a number of different convenience apis that directly access strings stored in resources they are analogous to apis already discussed with the difference that they return const uchar or unicodestring objects note the c apis that allow returning of unicodestrings only work if used in a c file trying to use them in a c file will produce a compiler error apis that allow retrieving strings by specifying a key language return type api c uchar const uchar ures_getstringbykey const uresourcebundle resb const char key int32_t len uerrorcode status c unicodestring unicodestring ures_getunicodestringbykey const uresourcebundle resb const char key uerrorcode status c unicodestring getstringex const char key uerrorcode status const apis that allow retrieving strings by specifying an index language return type api c uchar const uchar ures_getstringbyindex const uresourcebundle resb int32_t indexs int32_t len uerrorcode status c unicodestring unicodestring ures_getunicodestringbyindex const uresourcebundle resb int32_t indexs uerrorcode status c unicodestring getstringex int32_t index uerrorcode status const apis for retrieving strings through iteration language return type api c uchar const uchar ures_getnextstring uresourcebundle resourcebundle int32_t len const char key uerrorcode status c unicodestring unicodestring ures_getnextunicodestring uresourcebundle resb const char key uerrorcode status c unicodestring getnextstring uerrorcode status other apis resource bundle framework provides a number of additional apis that allow you to get more information on the resources you are using they are summarized in the following tables language api c int32_t ures_getsize uresourcebundle resourcebundle c int32_t getsize const gets the number of items in a resource simple resources always return size 1 language api c urestype ures_gettype uresourcebundle resourcebundle c urestype gettype gets the type of the resource for a list of resource types see unicode ures h language api c const char ures_getkey uresourcebundle resb c const char getkey gets the key of a named resource or null if this resource is a member of an array language api c void ures_getversion const uresourcebundle resb uversioninfo versioninfo c void getversion uversioninfo versioninfo const fills out the version structure for this resource language api c const char ures_getlocale const uresourcebundle resourcebundle uerrorcode status c const locale getlocale const returns the locale this resource is from this api is going to change so stay tuned format of resource bundles resource bundles are written in its source format before using them they must be compiled to the binary format using the genrb utility currently supported source format is a text file the format is defined in a formal definition file this is an example of a resource bundle source file comments start with a and extend to the end of the line first a locale name for the bundle is defined the whole bundle is a table every resource including the whole bundle has its name the name consists of invariant characters digits and following symbols _ root menu id mainmenu items id file name file items id open name open id save name save id exit name exit id edit name edit items id copy name copy id cut name cut id paste name paste this resource is an array thus accessible only through iteration and indexes errors invalid command bad value add more strings here read the manual splash import splash_root gif this is a binary imported file pgpkey bin a1b2c3d4e5f67890 a binary value versioninfo a table major int 1 of integers minor int 4 patch int 7 buttonsize intvector 10 20 10 20 an array of 32 bit integers will pick up data from zonestrings resource in en bundle in the icu package simplealias alias icudata en zonestrings will pick up data from collationelements resource in en bundle in the icu package collationelements alias icudata en binary format is described in the uresdata h header file resources syntax syntax of the resources that can be stored in resource bundles is specified in the following table data type format description tables name table subname1 subresource1 subnamen subresourcen tables are a complex resource that holds named resources if it is a part of an array it does not have a name at this point a resource bundle is a table access is allowed by key index and iteration arrays name array subresource1 subresourcen arrays are a complex resource that holds unnamed resources if it is a part of an array it does not have a name arrays require less memory than tables since they don t store the name of sub resources but the index and iteration access are as fast as with tables strings name string unicodetext strings are simple resources that hold a chunk of unicode encoded data if it is a part of an array it does not have a name binaries name bin binarydata name import filenametoimport binaries are used for storing binary information processed data images etc information is stored on a byte level integers name int integervalue integers are used for storing a 32 bit integer value integer vectors name intvector integervalue integervaluen integer vectors are used for storing 32 bit integer values aliases name alias locale and path to aliased resource aliases point to other resources they are useful for preventing duplication of data in resources that are not on the same branch of the fallback chain alias can also have an empty path in that case the position of the alias resource is used to find the aliased resource although specifying type for some resources can be omitted for backward compatibility reasons you are strongly encouraged to always specify the type of the resources as structure gets more complicated some combinations of resources that are not typed might produce unexpected results escape sequences string values can contain c java style escape sequences like t r n xhh uhhhh and u00hhhhhh consistent with the u_unescape c api see the ustring h api documentation a literal backslash in a string value must be doubled or escaped with x5c or u005c a literal ascii double quote in a double quoted string must be escaped with or x22 or u0022 you should also escape carriage return r and line feed n as well as control codes non characters unassigned code points and other default invisible characters see the unicode uax 44 default_ignorable_code_point property examples the way to write your resource is to start with a table that has your locale name the contents of a table are between the curly brackets root table then you can start adding resources to your bundle resources on the first level must be named and we suggest that you specify the type root table usage string usage genrb options files version int 122 errorcodes array string invalid argument string file not found the resource bundle format doesn t care about indentation and line breaks you can continue one string over many lines you need to have the line break outside of the string averylongstring string this string is quite long and therefore should be broken into several lines for more examples on syntax take a look at our resource files for locales and test data especially at the testtypes resource bundle making your own resource bundles in order to make your own resource bundle package you need to perform several steps create your root resource bundle this bundle should contain all the data for your program you are probably best off if you fill it with data in your native language create a chain of empty resource bundles for your native language and region for example if your region is sr_cs create all the entries in root in serbian and leave bundles for sr and sr_cs locales empty this way users of your package will know whether you support a certain locale or not if you already have some data to localize create more bundles with localized data decide on the name of your package you will use the package name to access your resources compile the resource bundles using the genrb tool the command line format is genrb options list of input files genrb expects that source files are in invariant encoding and uxxxx characters or utf 8 utf 16 with bom if you need to use a different encoding specify it using the encoding option you also need to specify the destination directory name for your resources using the destdir option this destination name needs to be the same as the package name full list of options can be retrieved by invoking genrb help you can also output java class files you will need to specify the write java option followed by an optional encoding for the resulting java file default encoding is ascii uxxxx you will also have to specify the resource bundle name using the bundle name argument after using genrb you will end up with files of name packagename_localename res for example if you had root txt en txt en_us txt es txt and you invoked genrb using the following command line genrb d myapplication root txt en txt en_us txt es txt you will end up with myapplication root res myapplication en res etc the forward slash can be a back slash on some platforms like windows these files are now ready to use and you can open them using ures_open myapplication en_us err however you might want to have only one file containing all the data in that case you need to use the package data tool it can produce either a memory mapped file or a dynamically linked library for more information on how to use package data tool see the appropriate section rolling out your own data takes some practice especially if you want to package it all together you might want to take a look at how we package data good places to start except of course icu s own data are source test testdata directory also here is a sample windows batch file that does compiling and packing of several resources genrb d myapplication root txt en txt en_gb txt fr txt es txt es_es txt echo root res en res en_gb res fr res es res es_es res packagelist txt mkdir tmpdir pkgdata p myapplication t tmpdir m common packagelist txt it is also possible to use the icupkg tool instead of pkgdata to generate dat data archives the icupkg tool became available in icu4c 3 6 if you need the data in a shared or static library you still need to use the pkgdata tool for easier maintenance packaging installation and application patching it s recommended that you use dat data archives using xliff for localization icu provides tool that allow for converting resource bundles to and from xliff format files in xliff format can contain translations of resources in that case more than one resulting resource bundle will be constructed to produce a xliff file from a resource bundle use the x option of genrb tool from icu4c assume that we want to convert a simple resource bundle to the xliff format root usage usage ufortune v l locale optionmessage unrecognized command line option to get a xliff file we need to call genrb like this genrb x l en root txt option x tells genrb to produce xliff file option l specifies the language of the resource if the language is not specified genrb will try to deduce the language from the resource name en zh sh if the resource name is not an iso language code root default language for the platform will be used language will be a source attribute for all the translation units xliff file produced from the resource above will be named root xlf and will look like this xml version 1 0 encoding utf 8 xliff version 1 1 xmlns urn oasis names tc xliff document 1 1 xmlns xsi http www w3 org 2001 xmlschema instance xsi schemalocation urn oasis names tc xliff document 1 1 http www oasis open org committees xliff documents xliff core 1 1 xsd file xml space preserve source language en datatype x icu resource bundle original root txt date 2007 08 17t21 17 08z header tool tool id genrb 3 3 icu 3 8 tool name genrb header body group id root restype x icu table...