Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include feature #35

Merged

Conversation

jerger
Copy link
Contributor

@jerger jerger commented May 22, 2018

Here you find my proposal for a markdown include feature (as discussed in #34 :-).

You will be able to include other markdown pages with
&[:indent-heading s/Num :indent-list s/Num](relative or absolute url s/Str)

Defined indents will increase the indention of headings or lists, so you will be able to include the same page on different pages with varying indention levels. Some more thoughts and decisions you will find in doc/include.md

At the moment Include works only in the same wiki via file system. Later on we can think of inter wiki links or github file urls for enhanced includes.

I've added two aditional libraries:
1.) plumatic schema - in order to describe introduced data structure. Maybe spec would also be a good choice.
2.) stuart sieras component in order to inject configuration and behavior for testing (specially test with uri resolving). I like spring in the java world and component in functional world helps to break up static dependency (cycles) in same way.

I think security will be a point left to implement - it may be possible to traverse more directories than intended at the moment. But first of all I'm interested in your feedback and thoughts :-)

@simon-brooke
Copy link
Collaborator

I think this is an excellent suggestion! I will pull, merge, and play with it tonight.

It allows considerably more flexibility of layout and with a little thought could go somewhere towards MediaWiki-style templates - possibly using Selmer-like markup?

@jerger
Copy link
Contributor Author

jerger commented May 23, 2018

Yea mediawiki templates seem to go in a similar direction.

Regarding selmer - I like yogthos frameworks and use selmer a lot myself :-). But I think it's worth to stick in Markdown-Style (in terms of stay simple) to keep the markdown-wiki advantage on the one hand and not to introduce to much complexity in parsing and expression evaluation on the other hand (if you talk about the full selmer power). If you just talk about a different include-notation I'm completely open to your proposal :-)

@simon-brooke simon-brooke merged commit e4b82f9 into journeyman-cc:master May 24, 2018
@simon-brooke
Copy link
Collaborator

Aye. I've merged this, and will push a new minor release in a few moments (this and i18n). However, I would like you, if you would, to pull develop (later today so I have time to merge the new master into it and push - version should be '1.0.2-SNAPSHOT', include documentation of your new 'Include' feature into the user documentation, and give me a pull request against develop.

@jerger
Copy link
Contributor Author

jerger commented May 24, 2018

great ... I will write some docu ... think start of next week should be possible ...

@jerger jerger deleted the include-feature branch May 25, 2018 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants