Make the Markdown presentations fancier when being shown #26
Conversation
Using the get() function makes the assigning of defaults to global variables a simple one-liner instead of an if block for each one.
It will call an autoload function defined for each file type, which formats one line at a time. State information, which may be needed to format one line based on previous lines, is maintained and passed into the file-specific autoload function. To implement this for a filetype, foo for example, create a file named autoload/foo.vim, and write a function with the signature: foo#format(text, state) Its return value is a 2-item list consisting of: 1. a list of 1 or more strings to be added to the replacement slide 2. the new value of state
Its capabilities are: #, ##, ### lines are rendered using the figlet program if installed. #, ##, ###, #### lines are centered in the window. - and * list indicators are replaced with a Unicode bullet operator. Numbers are recalculated in numbered lists, respecting indents. - [ ] and - [x] are rendered with unchecked and checked Unicode boxes. Code blocks are surrounded by horizontal lines. Quote blocks are word wrapped, indented, and have a left border.
The slides produced from markdown files no longer follow markdown syntax rules. There needs to be some way to specify an alternate syntax file for these slides. If a ...#set_filetype() function is implemented in the filetype's autoload module, then it will be used to set the filetype of the slide show; otherwise, the original source file's type will be used. This works out nicely because (for now) markdown is the only filetype that implements this. If a different filetype is used as source for the slides, it will continue with its current behavior, setting the slide show's filetype to the same as its source file's.
The ftplugin files makes it easier to do multiple setup commands should any more become necessary.
Use an autocommand to toggle the tabline when moving in and out of the slideshow buffers. Using `setlocal showtabline=0` doesn't work because it's not a local setting.
If you choose to set <Esc> to be the quit key, and <Left> to be the previous slide key, you will experience very odd behavior related to the way Vim processes "grey keys". If you press <Left> to go back a slide, the terminal sends <Esc>[D. When Vim gets this sequence, it sees that <Esc> has been remapped, and does that (quit the slide show) instead. Then it continues with [D, and causes all kinds of havoc in the current buffer. The problem and a solution is described in this StackOverflow discussion: https://stackoverflow.com/a/20458579/510067
We can achieve the same thing with the execute command, and reduce the implementation requirements for future filetypes.
Allow it to return either a string, or a list of strings. s:Format() will figure out how to handle it.
|
@sotte , I've heard it said that software is never finished; it's just released. With that in mind, I made a few changes after creating the pull request, but I'm done now. Go ahead and merge this if you approve it. |
These are bigger and easier to see than the old characters.
|
Wow @PhilRunninger, this is quite the PR! Thank you and I'm glad you're enjoying the presenting.vim. Also thanks for the small commits with proper commit messages! I'll try to review it this weekend. Can you please add some screenshots to the PR showing off the new features especially figlet. I'm thinking of re-recording the asciicast in the README. |
`set filetype=<something>` always works, even if there is no such file: `syntax/something.vim`, so the try-catch block was useless. Switch to an if block instead, looking for the syntax file in the runtime path.
|
@sotte, I created an animated GIF of the new Markdown formatting. It is embedded in the README and (now) in the PR description. |
|
Thank you so much. This is a really nice feature, I'm impressed! I also like the attention to detail ;) |
Tables are a Github-flavored extension to Markdown. To be used by this plugin, they must be defined with vertical bars at the beginning and end of the line. This macro doesn't do any spacing adjustments, except for centering the whole table, so the user will need to align the columns manually in the Markdown file.
|
I'm trying it out now. Do you plan to add any more features to this PR or is it feature complete? @PhilRunninger |
|
I don't get any of the cool new features. I think vimwiki (when using markdown) collides with presenting.vim. Debugging... |
|
Yes, it was vimwiki. Without vimwiki I get the new features. But I still have some issues with figlet.
|
|
I'm done with this PR. If I think of anything else, I'll create another one. My Mac installation of figlet includes the |
|
Hey @PhilRunninger, thanks for the quick response and the help! Two things:
After that I'll merge it. |
The Ubuntu installation of figlet does not ship with the font "straight". It's best replacement is "mini", but because it's a little harder to read than the blocky fonts, I switch to "standard" for the large # headings, and "small" for the smaller ## and ### headings.
If installed, vimwiki will take control of Markdown files, and change their filetype to vimwiki. When presenting such a file, presenting.vim will try to find a syntax file named "presenting_vimwiki.vim". It won't find such a file, and will resort to the original filetype "vimwiki" for syntax highlighting. This doesn't have all the nice syntax highlighting features that "presenting_markdown.vim" provides. So to prevent that hijacking, we just need to look for a filetype of "vimwiki", and change it to "markdown" when starting the slide show.
|
@sotte I'll do you one better on that vimwiki issue. I added a simple check for the vimwiki filetype, and changed that back to markdown when preparing the slide show. The more direct replacement for straight would have been mini, but I decided that I like the blocky fonts better, so I picked standard and small for the defaults. |
|
@PhilRunninger great feature and great commits! Thank you so much! |
|
My pleasure. I'm interested to see if anyone else implements this custom formatting for the other file types. |
|
Me too. I created a ticket for it: #27 |
There is a lot to unpack in this one. I wanted to make my presentations a bit spiffier, as if rendered to HTML. Of course, we're limited by what we can do with mono-spaced characters in a Vim buffer. So here's what I did.
Markdown-specific Changes
#and##headings are used as slide separators now.#,##, and###headings are replaced by the output of the program figlet, if it's installed andg:presenting_figletsis1. The fonts for both large and small headings can be overridden by the user.#,##,###, and####headings are centered in the window. This at least partially addresses Center slide content #22.∙□and■┃━//will not be displayed when presenting.Here is an animated GIF showing the changes. It is also embedded in the README.
General Changes
ftplugin/*.vim) as opposed to autocommands. This puts the code in a location that better matches its purpose. If additional statements are needed, they fit better in these files than in an autocommand.s:Format()function and the relatedautoload/markdown.vimfile. Following the pattern set forth therein, custom formatting can be implemented for other filetypes as well. For example, to enable custom formatting for RST files, do the following:rst#format(text, state)in the new fileautoload/rst.vim. This function takes the current line oftextand astatedictionary that describes the current state of the process.statecan be used to remember such things as "We're inside a code block," which would change how the currenttextis formatted. An updatedstateis returned by this function, and is passed back in for the next line oftext.syntax/presenting_rst.vim, and include the appropriatesyntaxandhighlightcommands in it.