The tool is intended to build a combined tree based on a collection of JSON files. This allow user to see the visual representation of structure and see all properties and values possible. This is especially useful for JSON documents with no schema defined. As a bonus it allows to save comments for every node of the tree which could be a way to describe the structure.
Please look at the "SchemaGenerator" branch to try Schema generation feature. It's under development now.
English Short manual:
- Push "Collect database" button to show root folder of the MetaUI repository. It'll search all files marked before to parse. A tree and a examples table is generated. It may take a couple of minutes.
- Database collected can be saved (binary serializer format) with "Save database" button to avoid regenerating it next time. There are 2 files saved - .metalib database and .metalib.tree tree.
- "Samples tree" contains a tree to select keywerd needed and dsiplay samples with double-click on a tree element.
- Examples table can be filtered by schema version (got from "contentVersion" field) and a search phrase. Filter is applied to a current grid view so filters can be applied sequentially. Filtering can be slow on huge amount of data so may take some time.
- Filters applied are shown in the text field below the grid.
- Version filter always reset grid content on new value applied. Be aware the string filters will be reset.
- To reset the filtering double-click on the tree item again to clear the search textbox and press Enter. Version filter set to "Any" does the same.
- Double click on grid cell text opens it for editing (to select/copy string needed). Changes won't be saved.
- Use Readjust button to adjust grid rows height (70% of grid control height) if needed (will be reset to auto-height on next grid refill).
- Single column height can be auto-adjusted with double-click on row header as well.
- Following actions works in tree:
- double-click - show examples for the selected node in the grid
- Delete - delete node
- Ctrl-C - copy node name to clipboard
- Following shotcuts works in description:
- double-click - edit the description text
- Ctrl-Enter - save text
- Following shotcuts works in grid:
- double-click - open file in editor
- Descriptions edited are saved to file on program close.
Tech. notes:
- Only the first file name for every unique example is displayed in grid by default (otherwise there'll be hundreds of files for some fields). Can be switched by "Collect all fileNames" setting.
- UI critical controls are inactive on long operations.
- It's possible to re-format json-queries to place starting brackets ("[,{") on the next line (I personally prefer this way). Works on database creation time. Can be enabled by "Reformat JSON" setting.
==== Russian Краткая инструкция:
- Кнопкой "Collect database" указываем корневую папку с JSONC файлами. По "Ок" программа ищет все *.jsonc файлы и парсит их, выгребая ключевые слова. Строится дерево и к нему библиотека значений (примеров). Это может занять немало времени (30 минут на полный комплект).
- Собранную базу можно сохранить (в формате binary serializer), чтобы не генерить опять по "Save database". Сохраняются 2 файла - .kineticLib с базой примеров и .kineticLib.tree с деревом.
- Во вкладке "Schema tree" можно в дереве выбрать интересующее ключевое слово и по двойному клику на нем справа в гриде появится табличка с найденными на него примерами.
- Табличку можно отфильтровать фильтрами сверху - по версии (из поля "contentVersion") и по ключевой фразе. Фильтр накладывается при нажатии ENTER в текстовом поле. Фильтруется текущее содержимое грида, так что можно последовательно наложить несколько фильтров. Наложенные фильтры заносятся в текстовое поле под табличкой.
- Наложенные фильтры заносятся в текстовое поле под табличкой.
- Фильтр по версии всегда пересоздает содержимое таблицы при изменении версии. Текстовые фильтры при этом сбрасываются.
- Для сброса фильтра можно очистить строку поиска или сделать двойной клик на элемент в дереве.
- Двойным кликом в гриде можно открыть файл, в котором найден этот пример. Пример будет выделен, если это возможно.
- Высота колонок таблицы может быть поправлена до 70% от высоты таблицы кнопкой "Adjust rows".
- Высота конкретной колонки может поправлена до 70% от высоты таблицы двойным кликом на заголовок столбца.
- В дереве работают следующие действия:
- двойной клик - вывести примеры для выбранного элемента в таблицу
- Delete - удалить элемент
- Ctrl-C - скопировать название элемента в буфер обмена
- В поле описания работают следующие действия:
- двойной клик - радактировать текст описания
- Ctrl-Enter - сохранить текст
- В таблице работают следующие действия:
- двойной клик - открыть файл в редакторе
- Отредактированные описания сохраняются в файл при закрытии программы.
Особенности работы:
- По-умолчанию в поле "File Name" сохраняется имя только первого файла для каждого уникального ключевого поля (иначе к некоторым полям будет по сотне и более файлов). Включается настройкой "Collect all fileNames".
- На время всех длительных операций все критичные контролы на UI дезактивируются.
- Предусмотрена возможность переформатировать json-выражения для выставления верхних/нижних скобок на один уровень в отдельную строку (по-умолчанию верхние скобки остаются на строке объекта). Включается настройкой "Reformat JSON".