From 6be21214b0267c18d203bef0c44768804e25bb0b Mon Sep 17 00:00:00 2001 From: jem Date: Tue, 15 May 2018 18:50:54 +0200 Subject: [PATCH] start with some thinking about the problem ... --- doc/include.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 doc/include.md diff --git a/doc/include.md b/doc/include.md new file mode 100644 index 0000000..8614fc9 --- /dev/null +++ b/doc/include.md @@ -0,0 +1,14 @@ +# Include Feature +## Requirements +The user can include page title, abstract or the whole content in a given page. Headings and enumerations can be indented by a given include-level. + +## Thoughts & Questions +* Which include syntax should be used? + * page include can be definde alongsite of image includes - sth. like `#[indent-level](relative or absolute url)` +* Which kind of urls should we accept for page includes? + * relative local urls (we will need some care to prohibit directory traversal ...) + * absolute github / gitlab / gitblit urls without authentication. +* Which metadata can be used for title / abstract ? + * MultiMarcdown-Metadata is supported by clj-markdown :-) +* How can we test page includes? + * we will need a content resolver component for testing and at least one for production resolving.