From 5435007e6a25bd8d365e8a3e560f40f14961d2b9 Mon Sep 17 00:00:00 2001 From: Elango Cheran Date: Sat, 27 May 2023 06:21:16 +0000 Subject: [PATCH] ICU-21697 Convert ICU Site pages to markdown for Github Pages See #1785 --- docs/demos/index.md | 74 + docs/design/index.md | 14 + docs/design/props/ppucd.md | 333 ++++ docs/design/struct/index.md | 20 + docs/design/struct/tries/bytestrie/bytetrie.h | 358 ++++ .../struct/tries/bytestrie/bytetriebuilder.h | 536 ++++++ .../struct/tries/bytestrie/bytetriedemo.cpp | 137 ++ .../struct/tries/bytestrie/bytetrieiterator.h | 199 +++ .../struct/tries/bytestrie/denseranges.h | 164 ++ .../struct/tries/bytestrie/genpname.cpp | 1451 +++++++++++++++++ docs/design/struct/tries/bytestrie/index.md | 135 ++ docs/design/struct/tries/index.md | 38 + docs/design/struct/tries/ucharstrie.md | 32 + docs/design/struct/utrie.md | 312 ++++ docs/devsetup/callgrind/index.md | 96 ++ docs/devsetup/callgrind/kcache-cumulative.png | Bin 0 -> 272694 bytes docs/devsetup/callgrind/kcache-flat.png | Bin 0 -> 259720 bytes docs/devsetup/callgrind/kcache-source.png | Bin 0 -> 237053 bytes .../cpp}/c_cpp_properties.json | 2 + docs/devsetup/cpp/index.md | 125 ++ .../vscode => devsetup/cpp}/launch.json | 0 docs/devsetup/cpp/linux.md | 178 ++ .../{ide4c/vscode => devsetup/cpp}/tasks.json | 0 .../README.md => devsetup/cpp/vscode.md} | 20 +- docs/devsetup/index.md | 14 + docs/devsetup/java/ant/Capture.png | Bin 0 -> 70840 bytes docs/devsetup/java/ant/index.md | 246 +++ .../Capture.png | Bin 0 -> 3116 bytes .../index.md | 290 ++++ docs/devsetup/java/index.md | 15 + .../java-profiling-and-monitoring-tools.md | 39 + docs/devsetup/source/gittooling.md | 87 + docs/devsetup/source/index.md | 161 ++ docs/index.md | 8 + .../processes/release/maintenance-releases.md | 47 + docs/processes/release/tasks/index.md | 1 - docs/userguide/dev/codingguidelines.md | 1 - docs/userguide/dev/contributions.md | 35 - docs/userguide/dev/editing.md | 1 - .../dev}/fuzzer_targets.md | 33 +- docs/userguide/dev/gitdev.md | 606 +++++++ docs/userguide/dev/index.md | 2 +- docs/userguide/dev/logknownissue.md | 68 + .../dev}/rules_update.md | 31 +- docs/userguide/dev/sync/custom.md | 1 - docs/userguide/dev/sync/index.md | 1 - docs/userguide/icu4j/why-use-icu4j.md | 98 ++ 47 files changed, 5950 insertions(+), 59 deletions(-) create mode 100644 docs/demos/index.md create mode 100644 docs/design/index.md create mode 100644 docs/design/props/ppucd.md create mode 100644 docs/design/struct/index.md create mode 100644 docs/design/struct/tries/bytestrie/bytetrie.h create mode 100644 docs/design/struct/tries/bytestrie/bytetriebuilder.h create mode 100644 docs/design/struct/tries/bytestrie/bytetriedemo.cpp create mode 100644 docs/design/struct/tries/bytestrie/bytetrieiterator.h create mode 100644 docs/design/struct/tries/bytestrie/denseranges.h create mode 100644 docs/design/struct/tries/bytestrie/genpname.cpp create mode 100644 docs/design/struct/tries/bytestrie/index.md create mode 100644 docs/design/struct/tries/index.md create mode 100644 docs/design/struct/tries/ucharstrie.md create mode 100644 docs/design/struct/utrie.md create mode 100644 docs/devsetup/callgrind/index.md create mode 100644 docs/devsetup/callgrind/kcache-cumulative.png create mode 100644 docs/devsetup/callgrind/kcache-flat.png create mode 100644 docs/devsetup/callgrind/kcache-source.png rename docs/{ide4c/vscode => devsetup/cpp}/c_cpp_properties.json (83%) create mode 100644 docs/devsetup/cpp/index.md rename docs/{ide4c/vscode => devsetup/cpp}/launch.json (100%) create mode 100644 docs/devsetup/cpp/linux.md rename docs/{ide4c/vscode => devsetup/cpp}/tasks.json (100%) rename docs/{ide4c/vscode/README.md => devsetup/cpp/vscode.md} (75%) create mode 100644 docs/devsetup/index.md create mode 100644 docs/devsetup/java/ant/Capture.png create mode 100644 docs/devsetup/java/ant/index.md create mode 100644 docs/devsetup/java/eclipse-setup-for-java-developers/Capture.png create mode 100644 docs/devsetup/java/eclipse-setup-for-java-developers/index.md create mode 100644 docs/devsetup/java/index.md create mode 100644 docs/devsetup/java/java-profiling-and-monitoring-tools.md create mode 100644 docs/devsetup/source/gittooling.md create mode 100644 docs/devsetup/source/index.md create mode 100644 docs/processes/release/maintenance-releases.md delete mode 100644 docs/userguide/dev/contributions.md rename docs/{processes => userguide/dev}/fuzzer_targets.md (94%) create mode 100644 docs/userguide/dev/gitdev.md create mode 100644 docs/userguide/dev/logknownissue.md rename docs/{processes => userguide/dev}/rules_update.md (97%) create mode 100644 docs/userguide/icu4j/why-use-icu4j.md diff --git a/docs/demos/index.md b/docs/demos/index.md new file mode 100644 index 00000000000..a04c04d716e --- /dev/null +++ b/docs/demos/index.md @@ -0,0 +1,74 @@ +--- +layout: default +title: Demos +nav_order: 350 +description: Demos +--- + + + +# Demos + +## ICU4C Demos + +[List of ICU Demonstrations](https://icu4c-demos.unicode.org/icu-bin/icudemos) + +## ICU4J Demos + +### Server Side Demos + +#### Web Demos + +These demos are running on the ICU server, and are implemented as Java Servlets +and JSP pages. + +* [Browse the Demos](http://demo.icu-project.org/icu4jweb/) +* [View Demo Source](https://github.com/unicode-org/icu-demos/tree/master/icu4jweb/) + +### Client Side demos + +#### To build the client side samples: + +1. Download the ICU4J source code ( see [Source Code Setup](../devsetup/source) ) +2. Run `ant jar` to build ICU4J jar +3. Run `ant jarDemos` to build the demos +4. Run `cp icu4j.jar demos/out/lib` +5. Finally, run `java -jar demos/out/lib/icu4j-demos.jar` to launch the demos + +**CalendarApp** This demo compares two calendars against each other. Choose the +two calendar types, and the display language, from the pop-up menus. Navigate by +days using the < and > buttons, or by years using the << and >> buttons. + +**Translit** This demonstration shows ICU Transliteration. The transliteration +mode chosen in the menu will be used as you type. + +**HolidayCalendarDemo** This demo displays holidays from a certain locale, +localized into the display language of your choice. Navigate by days using the < +and > buttons, or by years using the << and >> buttons. + +**RbnfDemo** This demo shows Rule Based Number Formatting. Please expand the +window to show the entire demo. A number may be entered in the top left corner, +or the navigation buttons may be used. The pop-up menus in the top right corner +will pick the rule and the variant used. + +**DetectingViewer** By opening a document using the Open file or Open URL menu +items, this demo will statistically detect the probable file encoding of a file. +Use the DetectedEncodings menu to see which encodings were detected. + +*Note:* Due to security constraints, you must use the Downloadable Demo Jar in +order to use these demos with files on your local disk. The Java Web Start +application will not have permission to read local files. + +--- + +### ICU Introduction Applets + +#### About the Applets + +This is a paper introducing ICU calendars, which has live applets throughout the +text to demonstrate various features. + +The paper is now archived, see diff --git a/docs/design/index.md b/docs/design/index.md new file mode 100644 index 00000000000..5bb0906156f --- /dev/null +++ b/docs/design/index.md @@ -0,0 +1,14 @@ +--- +layout: default +title: Design Docs +nav_order: 8000 +has_children: true +--- + + + +# Design Docs + diff --git a/docs/design/props/ppucd.md b/docs/design/props/ppucd.md new file mode 100644 index 00000000000..d1fa964f8df --- /dev/null +++ b/docs/design/props/ppucd.md @@ -0,0 +1,333 @@ +--- +layout: default +title: Preparsed UCD +parent: Design Docs +--- + + + +# Preparsed UCD + +## What + +A text file with preparsed UCD ([Unicode Character +Database](http://www.unicode.org/ucd/)) data. + +* Preparser script: + [tools/unicode/py/**preparseucd.py**](https://github.com/unicode-org/icu/blob/master/tools/unicode/py/preparseucd.py) +* ppucd.txt output: + [icu4c/source/data/unidata/**ppucd.txt**](https://github.com/unicode-org/icu/blob/master/icu4c/source/data/unidata/ppucd.txt) + ([raw text + version](https://raw.githubusercontent.com/unicode-org/icu/master/icu4c/source/data/unidata/ppucd.txt)) +* Parser for ppucd.txt: + [icu4c/source/tools/toolutil/**ppucd.h**](https://github.com/unicode-org/icu/blob/master/icu4c/source/tools/toolutil/ppucd.h) + & + [.cpp](https://github.com/unicode-org/icu/blob/master/icu4c/source/tools/toolutil/ppucd.cpp) +* genprops tool rewritten to use that: + [tools/unicode/c/**genprops**](https://github.com/unicode-org/icu/tree/master/tools/unicode/c/genprops) + +## Syntax + +``` +# Preparsed UCD generated by ICU preparseucd.py +``` + +Only whole-line comments starting with #, no inline comments. + +``` +ucd;10.0.0 +``` + +Data lines start with a type keyword. Data fields are semicolon-separated. The +number of fields per line is highly variable. + +The ucd line should be the first data line. It provides the Unicode version +number. + +``` +property;Binary;Alpha;Alphabetic +property;Enumerated;bc;Bidi_Class +``` + +Property lines define properties with a type and two or more aliases. + +``` +binary;N;No;F;False +binary;Y;Yes;T;True +value;bc;ON;Other_Neutral +``` + +Property value lines define the values of enumerated and catalog properties, +with the property short name and two or more aliases for each value. + +There is only one shared definition of the values and aliases for binary +properties. + +``` +defaults;0000..10FFFF;age=NA;bc=L;blk=NB;bpt=n;cf=;dm=;dt=None;ea=N;FC_NFKC=;gc=Cn;GCB=XX;gcm=Cn;hst=NA;InPC=NA;InSC=Other;jg=No_Joining_Group;jt=U;lb=XX;lc=;NFC_QC=Y;NFD_QC=Y;NFKC_CF=;NFKC_QC=Y;NFKD_QC=Y;nt=None;SB=XX;sc=Zzzz;scf=;scx=