From 7b284eb13fd95dd2a96b6cbb8a5be2ac808d2ae0 Mon Sep 17 00:00:00 2001 From: jem Date: Fri, 25 May 2018 17:15:46 +0200 Subject: [PATCH 1/3] Added include doc --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 03cd9d1..46d38e1 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,17 @@ You can (if you're logged in) upload files, including images, using the **Upload ![Smeagol](http://vignette3.wikia.nocookie.net/lotr/images/e/e1/Gollum_Render.png/revision/latest?cb=20141218075509) +## Includes +You can include pages into the current page youre working on. To do so, you can add a include link: + +`&[:indent-heading s/Num :indent-list s/Num](relative or absolute uri s/Str)` + +Parameters semantics: + * uri: The page to include. At the moment only pages of the current wiki are allowed. A page called "PageToBeIncluded" will result in a uri "PageToBeIncluded.md". + * indent-heading: You can indent headings of included page to adjust the included content to your surrounding structure. Indents 0-9 are supported. + * indent-list: In Same manner you can indent lists of included page to adjust the included content to your surrounding structure. Indents 0-9 are supported. + Security warning: At the moment there is no check against directory traversal attack. So include feature may expose files outside of your wiki. + ## Advertisement If you like what you see here, I am available for work on open source Clojure projects. From 7e5b3d74dac2e0c675dcec024c544a6f36a2cbb0 Mon Sep 17 00:00:00 2001 From: jem Date: Fri, 25 May 2018 17:19:33 +0200 Subject: [PATCH 2/3] spelling & format fixes for README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46d38e1..2dfc62b 100644 --- a/README.md +++ b/README.md @@ -99,14 +99,15 @@ You can (if you're logged in) upload files, including images, using the **Upload ![Smeagol](http://vignette3.wikia.nocookie.net/lotr/images/e/e1/Gollum_Render.png/revision/latest?cb=20141218075509) ## Includes -You can include pages into the current page youre working on. To do so, you can add a include link: +You can include pages into the current page you're working on. To do so, you can add a include link: `&[:indent-heading s/Num :indent-list s/Num](relative or absolute uri s/Str)` Parameters semantics: - * uri: The page to include. At the moment only pages of the current wiki are allowed. A page called "PageToBeIncluded" will result in a uri "PageToBeIncluded.md". + * uri: The page to include. At the moment only pages from the current wiki are allowed. A page called "PageToBeIncluded" will result in a uri "PageToBeIncluded.md". * indent-heading: You can indent headings of included page to adjust the included content to your surrounding structure. Indents 0-9 are supported. * indent-list: In Same manner you can indent lists of included page to adjust the included content to your surrounding structure. Indents 0-9 are supported. + Security warning: At the moment there is no check against directory traversal attack. So include feature may expose files outside of your wiki. ## Advertisement From 77d77ed3343ccfd65f57576728b1c2e1af69a082 Mon Sep 17 00:00:00 2001 From: jem Date: Fri, 25 May 2018 17:21:32 +0200 Subject: [PATCH 3/3] minor doc add in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2dfc62b..6cc0691 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ Parameters semantics: * indent-heading: You can indent headings of included page to adjust the included content to your surrounding structure. Indents 0-9 are supported. * indent-list: In Same manner you can indent lists of included page to adjust the included content to your surrounding structure. Indents 0-9 are supported. - Security warning: At the moment there is no check against directory traversal attack. So include feature may expose files outside of your wiki. + Security warning: At the moment there is no check against directory traversal attack. So include feature may expose files outside of your wiki content-dir. ## Advertisement If you like what you see here, I am available for work on open source Clojure projects.