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

Add html_filename_parameterization option. #665

Merged
merged 1 commit into from Apr 13, 2019
Merged

Conversation

patrickdavey
Copy link
Contributor

This adds the vimwiki_local html_filename_parameterization option (0|1)
which performs the same sanitization of filenames as does the vimwiki_markdown gem.

For example, if your file is called "My File.md" it will be written out
as "my-file.html".

If the html_filename_parameterization options is enabled, we also do
not delete
non-matching html files when the VimwikiAllToHtml command is run.

Closes #129

@ranebrown
Copy link
Contributor

@patrickdavey Overall this looks pretty good. The only changes I see off the top of my head are to update the changelog and add a link to your vimwiki_markdown project.

It might make sense to add a short section like done here with a brief overview of your project and the link.

It will probably be a few days before I get to any testing with this.

@patrickdavey
Copy link
Contributor Author

Updated the docs with the link to project + changelog section.

@ranebrown ranebrown self-assigned this Apr 10, 2019
@Nudin
Copy link
Member

Nudin commented Apr 10, 2019

Seems good. The only thing I wonder about: I guess that sooner or later someone will asks for an option to convert spaces to underscore instead of to a dash. What's our plan for that? Use '2' for this variant?

@ranebrown
Copy link
Contributor

@Nudin This is for integration with vimwiki_markdown to convert markdown syntax files to html. It doesn't really have a use outside of that currently so I don't think that we need to worry about adding another variant.

@ranebrown
Copy link
Contributor

@patrickdavey I tested this and I don't see any issues. I think it would make sense to slightly modify the help description of the documentation to say it prevents the html files from being regenerated every time conversion is done. After that I think its good to merge!

This adds the vimwiki_local `html_filename_parameterization` option (0|1)
which performs the same sanitization of filenames as does the
vimwiki_markdown gem.

For example, if your file is called "My File.md" it will be written out
as "my-file.html".

If the html_filename_parameterization options is enabled, we also _do
not delete_ non-matching html files when the VimwikiAllToHtml command is
run.

Closes vimwiki#129
@patrickdavey
Copy link
Contributor Author

@ranebrown I've altered the text slightly - see

vimwiki/doc/vimwiki.txt

Lines 2445 to 2449 in 5f01182

Description~
This setting is for integration with the vimwiki_markdown gem. If this is set
to 1 it alters the check for generated html filenames to match what
vimwiki_markdown generates. This means that it prevents unnecessary
regeneration of HTML files.

If you want it changed again, can you just let me know what you'd like and I'll put it in there (or just merge it and then change it to what you like)

@ranebrown ranebrown merged commit aff0258 into vimwiki:dev Apr 13, 2019
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.

None yet

3 participants