Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 7.85 KB

README.md

File metadata and controls

71 lines (43 loc) · 7.85 KB
Raw

IMPORTANT NOTE!! 2021-02-24, after node.js was upgraded from version 12.16.3 to the most recent stable version 14.16.0 the run time error appeared in line #140 of code tw_builder.js during execution of the longest string html_tw_build_cmd:

child_process.execSync(html_tw_build_cmd, {stdio: 'inherit',timeout: 0});

For this reason node.js was downgraded to the last workable version 12.16.3. After that the code works well as it was before.

Project TW Farm based on TW5 Farm technology

TW5 Farm is a method of centralized multi-wiki support on the Internet.

Conceptually, technology comprises the following phases:

  • Preparing a separate wiki by means of Tiddlywiki by a group of authors on their own local computers.
  • When creating the content, the authors synchronize the wiki folder through, for instance, the Google Drive cloud.
  • For each wiki, the editor pre-creates a wiki repository on Github, from which then each wiki is published on the Internet using Github Pages.

An excellent feature of the TW5 Farm technology is the function of automated collection of information on all wikis included in the collection and presentation in a separate central wiki. The central wiki for this collection called TW Farm is located at https://protw.github.io/.

To provide this feature, each wiki contains a standardized $:/boa/logo tiddler (a separate article is referred in Tiddlywiki as a tiddler). This tiddler contains the information needed to represent the wiki in the catalog outside.

IMPORTANT! In order to facilitate creation of a new wiki in the TW Farm one can download a ready-to-use wiki template from https://github.com/protw/templ

The core of the technology is the tw_builder script. The first version of the script was written by means of a high-level programming language - Octave. Then the second version was re-written using Javascript. The editor runs this script on own computer. The script updates the wiki information in the Github repository, updates the wiki collection information, prepares and executes the process of publishing on the Internet.

The script code, additional resources, and description of the technology are available at https://github.com/protw/twfarm. The technology description wiki is available at https://protw.github.io/twfarm (in Ukrainian).

For a full-fledged work, the author must be able to write texts in Tiddlywiki and also install on own computer:

The editor in order to run the tw_builder.m script, in addition to the above list, has to install on own computer Octave sofware and the function library fangq/jsonlab to process JSON data. Though for running the second version of the script Octave software is no loger needed.

At any case the editor has to install at own local computer

  • version control software - git and
  • the environment for running Javascript code - node.js.

Вікі-ферма на базі технології TW5 Farm

TW5 Farm - це метод централізованої підтримки декількох вікі у мережі інтернет.

Концептуально технологія розкладається на такі фази:

  • Підготовка окремої вікі інструментами Tiddlywiki групою авторів на власних локальних комп'ютерах.
  • Під час створення змісту автори синхронізують фолдер вікі через хмарний Гугл Диск.
  • Для кожної вікі редактор попередньо створює репозитарій вікі на сервісі Github, з якого потім відбувається опублікування в інтернеті з допомогою сервісу Github Pages.

Чудовою властивістю технології TW5 Farm є функція автоматизованого збирання інформації про всі вікі, що включені до колекції, та представлення в окремій центральній вікі. Приклад такого центрального каталогу для колекції вікі під назвою TW Farm (вікі-ферма) доступний за адресою https://protw.github.io/.

Для забезпечення цієї функції кожна вікі містить стандартизований тідлер $:/boa/logo (так в Tiddlywiki називають окремі статті), в якому міститься інформація, необхідна для представлення вікі у каталогу назовні.

ВАЖЛИВО! Задля полегшення створення нової вікі на вікі-фермі TW Farm, можна завантажити готовий для використання шаблон вікі звідси https://github.com/protw/templ

Ядром технології є скрипт tw_builder. Перша версія скрипта написана мовою програмування високого рівня Octave. Згодом друга версія скрипта була переписана на Javascript. Редактор запускає цей скрипт на своєму комп'ютері. Скрипт оновлює інформацію про вікі в репозитарії Github, оновлює інформацію про колекцію вікі, готує і проводить процес публікування в інтернеті.

Код скрипта, додаткові ресурси і опис технології у вигляді окремої вікі розташовані за адресою https://github.com/protw/twfarm. Вікі з описом технології оприлюднена за адресою https://protw.github.io/twfarm (українською).

Для повноцінної роботи автор має вміти писати тексти у Tiddlywiki, а також встановити на своєму комп'ютері:

Редактору для запуску першої версії скрипта tw_builder.m додатково до вищезазначеного списку треба встановити на своєму комп'ютері Octave, а також бібліотеку функцій fangq/jsonlab для роботи з даними формату JSON. Хоча для запуску другої версії скрипта програмне забезпечення Octave не потрібно.

У будь-якому випадку редактору необхідно встановити

  • програмне забезпечення з контролю версій - git і
  • середовище для запуску коду Javascript - node.js.