NotariumҚұжаттама
Құжаттама нұсқасы: latest
KZ

Алғашқы жазба

Орнатудан өтіп, редакторға да келіп жеттіңіз. Енді алғашқы жазбаны құрып, дискіде не болып жатқанын көрейік: Notarium-да жазба — бөтен дерекқордағы жол емес, өз қалтаңыздағы кәдімгі .md-файл. Жазғаныңыздың бәрі кез келген редакторда ашылатын әрі Notarium-ның өзінен де ұзақ өмір сүретін түсінікті Markdown-мәтін болып жатады.

Сол жақтағы файлдар ағашы

Сол жақта — кеңістігіңіздегі қалталар мен жазбалардың ағашы. Ол /data/spaces ішіндегі файлдық құрылымды дәлме-дәл қайталайды: ағаштағы қалта — дискідегі қалта, жазба — сол қалтадағы файл. Ағаш ондаған мың жазбаға есептелген әрі қалталардың мазмұнын аша бастаған сайын жүктеп отырады.

Негізгі әрекеттер де осында: жазба не қалта құру, орнында атын өзгерту, тінтуірмен басқа қалтаға сүйреп апару. Маңызды бір тұс: бар жазбаның қалтасын не тақырыбын өзгерту дубликат жасамайды, файлдың өзін жылжытады.

Бос қалталар — толыққанды

Соңғы жазбасын алып тастаса да, қалта жоғалып кетпейді. Құрылымды алдын ала дайындай беруге болады.

Тақырып — бұл бірінші жол

Notarium-да бөлек «Title» өрісі жоқ. Жазбаның тақырыбы — оның басындағы # H1, яғни құжаттың бірінші жолы. Оны да қалғанының бәрі секілді тікелей мәтіннің ішінде түзетесіз. Жаңа жазба тақырып тұрған жерге қойылған курсормен бірге # жолында ашылады — тек тере бастаңыз.

Егер басында # H1 болмаса, тақырып бірінші бос емес прозалық жол болады — жедел жазба «Untitled»-ден құралған дерекқорға айналмайды. Ал егер құжат құрылымдық блокпен (код, тізім, дәйексөз, кесте, H2 және одан төмен деңгейдегі тақырып) ашылса әрі тақырып әсте берілмесе — жазба тақырыпсыз сақталмайды: осылайша кодтың бірінші жолы тақырыпқа үнсіз сіңіп кетпейді.

Тақырып файл атауын, іздеуді, графты және тарихты бір-бірімен байланыстырады — сондықтан бір-бірінен ажырап кететін «өріс + дене» орнына бір ғана өңдеу беті бар.

Жазу режимдері

Notarium әрқашан шикі Markdown-ды түзетеді — жалғыз шындық көзі. Түзету барысында осы мәтіннің қалай көрінетінін жазу режимі анықтайды (Settings → Appearance ішіндегі жеке баптау):

  • Source (әдепкі) — шикі Markdown сол күйінде: моноширинді қаріп, синтаксис бояуы. #, **, []() маркерлері кәдімгі мәтін болып көрінеді. Дереккөзбен тікелей жұмыс істейтіндерге.
  • WYSIWYM — «нені көрсең, соны меңзейсің»: мәтін стильденген (тақырыптар ірірек, жартылай қалыңы қалың болып, дәйексөздер фонмен), бірақ Markdown-маркерлері экранда бәсеңдетілген күйде қалады. Жол ұзындығы өзгермейді, сондықтан курсор «секірмейді».

Екі режим де дәл сол жолды түзетеді әрі оны байт-байтпен бірдей сақтайды — режимді ауыстыру файл мазмұнын өзгертпейді.

Режимдерден бөлек, жоғарғы панельдегі Preview түймесі жұмыс істейді: ол кез келген сәтте жазбаның түпкілікті HTML-рендерін сақтамай көрсетеді. Ұзын мәтіндер үшін жазу көмекшілері бар: Focus (белсенді сөйлемнен/жолдан/абзацтан басқасының бәрін күңгірттейді) және Typewriter (курсоры бар жолды ортада ұстап тұрады).

Жазбалар арасындағы байланыстар

Мәтіннің ішінде wiki-link-тер жұмыс істейді: [[жазба тақырыбы]] немесе [[тақырып|белгі]]. Басу қолданбаның ішіндегі жазбаға өткізеді. Ондай тақырыпты жазба болмаса, Notarium оны құруды ұсынады — ал ол жасалғанша байланыс графында қуыс «елес» түйін болып ілініп тұрады.

Сақтау және дискіде не болатыны

Сақтау — Ctrl/Cmd+Enter арқылы. Дискіге қайта экрандаусыз әрі қайта нормаламай таза Markdown кетеді: тергеніңіз тап-тұйнақтай. Notarium файл атауын тақырыптан шығарады (кириллицаны транслитерациялап, kebab-case), сондықтан файл қолданбадан тыс жерде де оқылады.

Файлдың басына шағын frontmatter түседі, оның ішінде — notarium-id кілті: жазбаның тұрақты 12-таңбалы идентификаторы. Дәл сол — жол да, файл атауы да емес — жазбаның шынайы бірегейлігі болып қызмет етеді: атын өзгерту мен қалталар арасында жылжыту сілтемелерді үзбейді әрі нұсқалар тарихын жоғалтпайды, өйткені журнал notarium-id бойынша жүргізіледі.

Сырттан түзету — қалыпты режим

.md-файлды басқа редакторда түзеттіңіз бе, әлде git-тен тарттыңыз ба — Notarium өзгерістерді келесі сканерлеуде қабылдап алады. Файлдар шындық көзі болып қала береді; индекс жай ғана соларға сай қайта құрастырылады.

Әрбір сақтау ревизиялар тарихына түседі: жазба күйінің шығу тегі көрсетілген толық снапшоты — кім және қалай түзеткені (сіз, сыртқы редактор немесе агент). Кез келген нұсқаны қарауға, салыстыруға және кері қайтаруға болады.

Әрі қарай