From 249629d8c2644219ebd90fcf6205b61e70ca230d Mon Sep 17 00:00:00 2001 From: <> Date: Mon, 14 Oct 2024 08:18:53 +0000 Subject: [PATCH] Deployed 3dda495 with MkDocs version: 1.6.1 --- contribute/CONTRIBUTING/index.html | 19 +++++++------ roadmap/changelog/index.html | 43 +++++++++++++++++++++++++++++ search/search_index.json | 2 +- sitemap.xml | 16 +++++------ sitemap.xml.gz | Bin 281 -> 282 bytes 5 files changed, 62 insertions(+), 18 deletions(-) diff --git a/contribute/CONTRIBUTING/index.html b/contribute/CONTRIBUTING/index.html index 2023346..9ade480 100644 --- a/contribute/CONTRIBUTING/index.html +++ b/contribute/CONTRIBUTING/index.html @@ -881,15 +881,16 @@
module\ -├── core.cljs <--- entry point -├── db.cljs <--- schema, validation -├── views.cljs <--- reagent views -├── events.cljs <--- event handlers -├── subs.cljs <--- subscription handlers -├── handlers.cljs <--- helper functions for db transformations -├── effects.cljs <--- effect handlers -├── styles.css <--- styles -└── README.md <--- documentation +├── core.cljs <--- entry point +├── db.cljs <--- schema, validation +├── views.cljs <--- reagent views +├── events.cljs <--- event handlers +├── subs.cljs <--- subscription handlers +├── handlers.cljs <--- helper functions for db transformations +├── effects.cljs <--- effect handlers +├── hierarchy.cljs <--- multimethods and hierarchies +├── styles.css <--- styles +└── README.md <--- documentation
Added
+Removed
+Changed
+Fixed
+Added
History tree
Maintain all user actions and travel through time, without ever losing your undo/redo stack.
Interactive SHELL
Evaluate Clojure and Javascript code on the embedded REPL to generate shapes, or even extend the editor on the fly.
SMIL animations
Create and edit SMIL animations, an extension of SVG allowing to animating SVG elements.
Powered by SVG
Educational-driven exposing the specification and rendering on an SVG canvas.
Accessibility testing
Built-in tools that help you evaluate the accessibility of your creations.
Open Source
Distributed under the terms of the AGPL-3.0 license.
Thank you for your interest in actively participating in the project's development! Please read the Contributor Covenant Code of Conduct and the Contributor License Agreement first.
The project is written in ClojureScript - a compiler for Clojure that targets JavaScript, and is based on re-frame - a framework for building Modern Web Apps in ClojureScript. You should probably take a look at their exceptional documentation first.
"},{"location":"contribute/CONTRIBUTING/#style-guide","title":"Style Guide","text":"We try to follow the Clojure Style Guide as much as possible.
An additional resource about how to name Clojure functions by Stuart Sierra.
In addition to the idiomatic names, we use the following conventions
\ne -> event\nel, els -> element, elements\nattr, attrs -> attribute, attributes\nprop, props -> property, properties\nw, h -> width, height\nt -> time\nh, m, s, ms -> hours, minutes, seconds, milliseconds\n
We also use the following namespace aliases
\nv -> views\ne -> events\nh -> handlers\ns -> subs\nfx -> effects\n
If the namespace belongs to a dedicated module, we use module.v
.
Main structure
\nsrc\\\n\u251c\u2500\u2500 renderer\\ <--- Renderer Process\n\u251c\u2500\u2500 electron\\ <--- Main Process & Preload script\n\u251c\u2500\u2500 lang\\ <--- Translation files\n\u2514\u2500\u2500 worker\\ <--- Web Workers\n
We are trying to split our code under renderer into relatively independent modules, following re-frame's app structure suggestions with some minor additions.
\nmodule\\\n\u251c\u2500\u2500 core.cljs <--- entry point\n\u251c\u2500\u2500 db.cljs <--- schema, validation\n\u251c\u2500\u2500 views.cljs <--- reagent views\n\u251c\u2500\u2500 events.cljs <--- event handlers\n\u251c\u2500\u2500 subs.cljs <--- subscription handlers\n\u251c\u2500\u2500 handlers.cljs <--- helper functions for db transformations\n\u251c\u2500\u2500 effects.cljs <--- effect handlers\n\u251c\u2500\u2500 styles.css <--- styles\n\u2514\u2500\u2500 README.md <--- documentation\n"},{"location":"contribute/CONTRIBUTING/#re-frame-recommendations","title":"Re-frame recommendations","text":"
Avoid chaining events to create new ones. Always prefer composing pure functions that directly transform the db. That is the whole purpose of handlers
namespace.
Use interceptors sparingly. Although they look (and probably are) ingenious, it is hard to write and reason with them. Doing things explicitly, is usually easier to grasp and maintain.
Always use auto-qualified keywords (e.g. ::copy
) for subscriptions, events and effects. You can use as-alias
to require those namespaces without evaluating the registrations multiple times.
We use malli to describe the shape of our app db and selectively validate incoming data (e.g. file loading). We also use this spec to generate default values. You can optionally enable full db validation on dev mode (see renderer.dev
namespace).
Function inline schemas are used selectively on critical namespaces, like renderer.utils.bounds
. Instrumentation is enabled by default on dev environment only.
Ctrl+Shift+I Toggle devtools\nCtrl+Shift+X Toggle 10x\nCtrl+R Reload app\n
"},{"location":"contribute/cla/","title":"Contributor License Agreement","text":"This Contributor License Agreement (\u201cCLA\u201d) applies to any contribution that you make to any product or project managed by us (the \u201cproject\u201d), and sets out the intellectual property rights you grant to us in the contributed materials. The term \u201cus\u201d shall mean Konstantinos Kaloutas. The term \u201cyou\u201d shall mean the person or entity identified below. If you agree to be bound by these terms, fill in the information requested below and sign the CLA where indicated below. Read this agreement carefully before signing. These terms and conditions constitute a binding legal agreement.
You agree to notify us if you become aware of any circumstance which would make any of the foregoing representations
This document is a modified version of Oracle Contributor Agreement \u2013 version 1.7.1 Licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
"},{"location":"contribute/translate/","title":"Translate","text":"Coming soon!
"},{"location":"docs/shortcuts/","title":"Shortcuts","text":"Command Shortcut Undo CTRL + Z Redo CTRL + Y, CTRL + SHIFT + Z New document CTRL + N Toggle grid # Raise elements PAGE UP Lower element PAGE DOWN Raise element to top HOME Lower element to top END Pan to active page and set zoom to default 1 Fit active page to canvas 2 Fill active page to canvas 3 Pan MIDDLE CLICK + MOUSE MOVE Zoom in/out CTRL + SCROLL, ALT + SCROLL Zoom in = Zoom Out - Toggle element tree CTRL + T Toggle element properties CTRL + P Toggle menu CTRL + L Convert elements to path CTRL + SHIFT + P Copy elements CTRL + C Cut elements CTRL + X Paste elements CTRL + V Paste elements in place CTRL + ALT + V Paste element styles CTRL + SHIFT + V Duplicate elements CTRL + D Delete elements DEL , SHIFT + DEL , BACKSPACE Select all elements CTRL + A Deselect all elements ESC Select same type CTRL+ SHIFT + A Exclude CTRL + E Unite CTRL + U Intersect CTRL + I Subtract CTRL + S Divide CTRL + / Move elements up \u2191 Move elements down \u2193 Move elements left \u2190 Move elements right \u2192 Select tool C Edit tool E Zoom tool Z Circle tool C Rect tool R Line tool L Text tool T Fill tool F Cancel action ESC Close window ALT + F4"},{"location":"get-studio/build-from-source/","title":"Build from source","text":"git clone https://github.com/repath-project/repath-studio.git\n
cd studio\n
npm install && npm run build\n
npm run dist\n
"},{"location":"get-studio/download/","title":"Download","text":"Warning
This project is in alpha stage!
Select your operating system
See all releases
"},{"location":"roadmap/changelog/","title":"Changelog","text":""},{"location":"roadmap/changelog/#043-2024-09-23","title":"0.4.3 (2024-09-23)","text":"Added
Removed
Changed
Fixed
Added
Changed
Added
Removed
Changed
:id
instead of :key
to avoid shadowingFixed
Added
Changed
Fixed
Added
Removed
Changed
Fixed
Removed
Added
Removed
Changed
Fixed
Added
Removed
Changed
Fixed
Added
Changed
Fixed
Fixed
Added
Changed
Fixed
Added
Changed
Fixed
Added
Changed
Fixed
Fixed
Added
Changed
Fixed
Changed
Fixed
Added
Removed
Changed
Fixed
Too many fixes to list.
"},{"location":"roadmap/changelog/#013-2022-05-09","title":"0.1.3 (2022-05-09)","text":"Added
Changed
Removed
Fixed
Added
Changed
Fixed
Added
Removed
Changed
Fixed
Added
History tree
Maintain all user actions and travel through time, without ever losing your undo/redo stack.
Interactive SHELL
Evaluate Clojure and Javascript code on the embedded REPL to generate shapes, or even extend the editor on the fly.
SMIL animations
Create and edit SMIL animations, an extension of SVG allowing to animating SVG elements.
Powered by SVG
Educational-driven exposing the specification and rendering on an SVG canvas.
Accessibility testing
Built-in tools that help you evaluate the accessibility of your creations.
Open Source
Distributed under the terms of the AGPL-3.0 license.
Thank you for your interest in actively participating in the project's development! Please read the Contributor Covenant Code of Conduct and the Contributor License Agreement first.
The project is written in ClojureScript - a compiler for Clojure that targets JavaScript, and is based on re-frame - a framework for building Modern Web Apps in ClojureScript. You should probably take a look at their exceptional documentation first.
"},{"location":"contribute/CONTRIBUTING/#style-guide","title":"Style Guide","text":"We try to follow the Clojure Style Guide as much as possible.
An additional resource about how to name Clojure functions by Stuart Sierra.
In addition to the idiomatic names, we use the following conventions
\ne -> event\nel, els -> element, elements\nattr, attrs -> attribute, attributes\nprop, props -> property, properties\nw, h -> width, height\nt -> time\nh, m, s, ms -> hours, minutes, seconds, milliseconds\n
We also use the following namespace aliases
\nv -> views\ne -> events\nh -> handlers\ns -> subs\nfx -> effects\n
If the namespace belongs to a dedicated module, we use module.v
.
Main structure
\nsrc\\\n\u251c\u2500\u2500 renderer\\ <--- Renderer Process\n\u251c\u2500\u2500 electron\\ <--- Main Process & Preload script\n\u251c\u2500\u2500 lang\\ <--- Translation files\n\u2514\u2500\u2500 worker\\ <--- Web Workers\n
We are trying to split our code under renderer into relatively independent modules, following re-frame's app structure suggestions with some minor additions.
\nmodule\\\n\u251c\u2500\u2500 core.cljs <--- entry point\n\u251c\u2500\u2500 db.cljs <--- schema, validation\n\u251c\u2500\u2500 views.cljs <--- reagent views\n\u251c\u2500\u2500 events.cljs <--- event handlers\n\u251c\u2500\u2500 subs.cljs <--- subscription handlers\n\u251c\u2500\u2500 handlers.cljs <--- helper functions for db transformations\n\u251c\u2500\u2500 effects.cljs <--- effect handlers\n\u251c\u2500\u2500 hierarchy.cljs <--- multimethods and hierarchies\n\u251c\u2500\u2500 styles.css <--- styles\n\u2514\u2500\u2500 README.md <--- documentation\n"},{"location":"contribute/CONTRIBUTING/#re-frame-recommendations","title":"Re-frame recommendations","text":"
Avoid chaining events to create new ones. Always prefer composing pure functions that directly transform the db. That is the whole purpose of handlers
namespace.
Use interceptors sparingly. Although they look (and probably are) ingenious, it is hard to write and reason with them. Doing things explicitly, is usually easier to grasp and maintain.
Always use auto-qualified keywords (e.g. ::copy
) for subscriptions, events and effects. You can use as-alias
to require those namespaces without evaluating the registrations multiple times.
We use malli to describe the shape of our app db and selectively validate incoming data (e.g. file loading). We also use this spec to generate default values. You can optionally enable full db validation on dev mode (see renderer.dev
namespace).
Function inline schemas are used selectively on critical namespaces, like renderer.utils.bounds
. Instrumentation is enabled by default on dev environment only.
Ctrl+Shift+I Toggle devtools\nCtrl+Shift+X Toggle 10x\nCtrl+R Reload app\n
"},{"location":"contribute/cla/","title":"Contributor License Agreement","text":"This Contributor License Agreement (\u201cCLA\u201d) applies to any contribution that you make to any product or project managed by us (the \u201cproject\u201d), and sets out the intellectual property rights you grant to us in the contributed materials. The term \u201cus\u201d shall mean Konstantinos Kaloutas. The term \u201cyou\u201d shall mean the person or entity identified below. If you agree to be bound by these terms, fill in the information requested below and sign the CLA where indicated below. Read this agreement carefully before signing. These terms and conditions constitute a binding legal agreement.
You agree to notify us if you become aware of any circumstance which would make any of the foregoing representations
This document is a modified version of Oracle Contributor Agreement \u2013 version 1.7.1 Licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
"},{"location":"contribute/translate/","title":"Translate","text":"Coming soon!
"},{"location":"docs/shortcuts/","title":"Shortcuts","text":"Command Shortcut Undo CTRL + Z Redo CTRL + Y, CTRL + SHIFT + Z New document CTRL + N Toggle grid # Raise elements PAGE UP Lower element PAGE DOWN Raise element to top HOME Lower element to top END Pan to active page and set zoom to default 1 Fit active page to canvas 2 Fill active page to canvas 3 Pan MIDDLE CLICK + MOUSE MOVE Zoom in/out CTRL + SCROLL, ALT + SCROLL Zoom in = Zoom Out - Toggle element tree CTRL + T Toggle element properties CTRL + P Toggle menu CTRL + L Convert elements to path CTRL + SHIFT + P Copy elements CTRL + C Cut elements CTRL + X Paste elements CTRL + V Paste elements in place CTRL + ALT + V Paste element styles CTRL + SHIFT + V Duplicate elements CTRL + D Delete elements DEL , SHIFT + DEL , BACKSPACE Select all elements CTRL + A Deselect all elements ESC Select same type CTRL+ SHIFT + A Exclude CTRL + E Unite CTRL + U Intersect CTRL + I Subtract CTRL + S Divide CTRL + / Move elements up \u2191 Move elements down \u2193 Move elements left \u2190 Move elements right \u2192 Select tool C Edit tool E Zoom tool Z Circle tool C Rect tool R Line tool L Text tool T Fill tool F Cancel action ESC Close window ALT + F4"},{"location":"get-studio/build-from-source/","title":"Build from source","text":"git clone https://github.com/repath-project/repath-studio.git\n
cd studio\n
npm install && npm run build\n
npm run dist\n
"},{"location":"get-studio/download/","title":"Download","text":"Warning
This project is in alpha stage!
Select your operating system
See all releases
"},{"location":"roadmap/changelog/","title":"Changelog","text":""},{"location":"roadmap/changelog/#044-2024-10-14","title":"0.4.4 (2024-10-14)","text":"Added
Removed
Changed
Fixed
Added
Removed
Changed
Fixed
Added
Changed
Added
Removed
Changed
:id
instead of :key
to avoid shadowingFixed
Added
Changed
Fixed
Added
Removed
Changed
Fixed
Removed
Added
Removed
Changed
Fixed
Added
Removed
Changed
Fixed
Added
Changed
Fixed
Fixed
Added
Changed
Fixed
Added
Changed
Fixed
Added
Changed
Fixed
Fixed
Added
Changed
Fixed
Changed
Fixed
Added
Removed
Changed
Fixed
Too many fixes to list.
"},{"location":"roadmap/changelog/#013-2022-05-09","title":"0.1.3 (2022-05-09)","text":"Added
Changed
Removed
Fixed
Added
Changed
Fixed
Added
Removed
Changed
Fixed
Added