From dbc5f7253ffd602305a9e4f05cd5b4b31e68c797 Mon Sep 17 00:00:00 2001 From: Stefan Zermatten Date: Mon, 5 Sep 2022 14:36:39 +0200 Subject: [PATCH] Finished basic docs --- app/imports/parser/functions.js | 4 +- app/imports/server/publications/docs.js | 1 + app/imports/ui/pages/Documentation.vue | 4 +- app/imports/ui/pages/FunctionReference.vue | 56 +++++++++++++++ app/imports/ui/router.js | 11 ++- app/imports/ui/styles/markdown.css | 25 ++++++- app/private/docs/FunctionReference.vue | 49 ------------- app/private/docs/computed-fields.md | 77 +++++++++++++++++++++ app/private/docs/dependency-loops.md | 31 +++++++++ app/private/docs/docs.md | 1 + app/private/docs/inline-calculations.md | 9 +++ app/private/docs/tags.md | 12 ++++ app/public/images/docs/dependency-loop.png | Bin 0 -> 33443 bytes 13 files changed, 224 insertions(+), 56 deletions(-) create mode 100644 app/imports/ui/pages/FunctionReference.vue delete mode 100644 app/private/docs/FunctionReference.vue create mode 100644 app/public/images/docs/dependency-loop.png diff --git a/app/imports/parser/functions.js b/app/imports/parser/functions.js index b0d16561..90a7e8df 100644 --- a/app/imports/parser/functions.js +++ b/app/imports/parser/functions.js @@ -112,10 +112,10 @@ export default { } }, 'resolve': { - comment: 'Forces the given calcultion to resolve into a number', + comment: 'Forces the given calcultion to resolve into a number, even in calculations where it would usually keep the unknown values as is', examples: [ {input: 'resolve(someUndefinedVariable + 3 + 4)', result: '7'}, - {input: 'resolve(3d6)', result: '2'}, + {input: 'resolve(1d6)', result: '4'}, ], arguments: ['parseNode'], fn: function resolveFn(node){ diff --git a/app/imports/server/publications/docs.js b/app/imports/server/publications/docs.js index 0844676c..b887a081 100644 --- a/app/imports/server/publications/docs.js +++ b/app/imports/server/publications/docs.js @@ -4,6 +4,7 @@ import { propsByDocsPath } from '/imports/constants/PROPERTIES.js'; // Manual doc paths const docPaths = [ 'computed-fields', + 'inline-calculations', 'dependency-loops', 'docs', 'tags', diff --git a/app/imports/ui/pages/Documentation.vue b/app/imports/ui/pages/Documentation.vue index 8bb7fcf4..8a0acb10 100644 --- a/app/imports/ui/pages/Documentation.vue +++ b/app/imports/ui/pages/Documentation.vue @@ -1,5 +1,5 @@