Skip to content

simplecodemerchant/decipher-vim-clips

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits

plugin

plugin

 
 

snippets

snippets

 
 

syntax

syntax

 
 

.gitignore

.gitignore

 
 

.travis.yml

.travis.yml

 
 

LICENSE.txt

LICENSE.txt

 
 

Makefile

Makefile

 
 

README.rst

README.rst

 
 

Repository files navigation

decipher-vim-clips plugin for vim =============================

image

Installation

You may want to use a plugin manager. I suggest vim-plug. Also you need a vim version that was compiled with +python, which is typical for most distributions on Linux.

Add vim-plug section to your ~/.vimrc:

call plug#begin('~/.vim/plugged')

Plug 'MarcWeber/vim-addon-mw-utils'
Plug 'tomtom/tlib_vim'
Plug 'garbas/vim-snipmate'
Plug 'https://github.com/matt92martin/decipher-vim-clips.git'

call plug#end()

Then run :PlugInstall in vim

Cheat Sheet

Normal Mode

These commands are to be executed in vim's Normal mode

NewSurvey

Clean up unicode, newlines, tabs and place the current buffer in a new-survey template. This is typically the first thing done when working with a new survey.

<leader>ss

MakeOrs

Create boolean logic you can trust. Conditions will be put inside a cond="" (if present) on the line where invoked. Supports alpha ranges as well as numeric. Will place (if found) [row] into a rowCond="" and [col] into a colCond="" similar to the third example below.

<leader>mo

Question Label?: Q1
Label Numbers: e.g. (1-4,5|A-D,E): 1-3,5,8  // supports mixture of ranges and individual indices
Cell Type: e.g. (r|c|ch): r
Join type: e.g. (or|and|,) [or]: and        // default is to use `or`

...will become...

Q1.r1 and Q1.r2 and Q1.r3 and Q1.r5 and Q1.r8
<leader>mo

Question Label?: Q2
Label Numbers: e.g. (1-4,5|A-D,E): A-C,E,H  // support alpha ranges as well
Cell Type: e.g. (r|c|ch):
Join type: e.g. (or|and|,) [or]:

...will become...

Q2.A or Q2.B or Q2.C or Q2.E or Q2.H
<leader>mo

Question Label?: Q3[row]                   // useful in row and col conds
Label Numbers: e.g. (1-4,5|A-D,E): 1-5
Cell Type: e.g. (r|c|ch): c
Join type: e.g. (or|and|,) [or]:

...will become...

Q3[row].c1 or Q3[row].c2 or Q3[row].c3 or Q3[row].c4 or Q3[row].c5

Justify

Justify the current line with hard breaks, removing extra spaces in the process. Indentation will be preserved and words will not be broken.

<leader>ju

Well, there's egg and bacon; egg sausage and bacon; egg and spam; egg bacon and spam; egg bacon sausage and spam; spam bacon sausage and spam; spam egg spam spam bacon and spam; spam sausage spam spam bacon spam tomato and spam

...will become...

Well, there's egg and bacon; egg sausage and bacon; egg and spam; egg bacon and spam; egg bacon sausage
and spam; spam bacon sausage and spam; spam egg spam spam bacon and spam; spam sausage spam spam bacon
spam tomato and spam

SwitchRating

Switch adim and averages between cols and rows

<leader>sr

averages="cols" adim="rows"

...will become...

averages="rows" adim="cols"

Vimdiff

Open the current buffer into parts delimited by blank lines in gvimdiff. This is very handy when trying to discover differences between repeating items in a questionnaire.

<leader>dif

CommentBlocks

Add <!-- EO block --> style comments to the end of blocks for easier navigation of nested block trees

<leader>cb

<block label="spam_block" randomizeChildren="0" cond="1">
<radio label="Q1">
    <title>What would you like to eat?</title>
    <comment>Please select one</comment>
    <row label="r1">Ham</row>
    <row label="foo">Spam</row>
    <row label="r3">bar Eggs</row>
    <row label="r42">Bacon</row>
</radio>
<suspend/>
</block>

...will become...

<block label="spam_block" randomizeChildren="0" cond="1">
<radio label="Q1">
    <title>What would you like to eat?</title>
    <comment>Please select one</comment>
    <row label="r1">Ham</row>
    <row label="foo">Spam</row>
    <row label="r3">bar Eggs</row>
    <row label="r42">Bacon</row>
</radio>
<suspend/>
</block>
<!-- EO spam_block -->

AttrSpacing

Justifies the spacing of attributes accross multiple xml elements

<leader>as

<row label="ham" cs:extra="HAM"  >HAM</row>
<row label="spam" cs:extra="SPAM" >SPAM</row>
<row label="r3" cs:extra="BACON" exclusive="1" randomize="0">BACON</row>

...will become...

<row label="ham"  cs:extra="HAM"  >HAM</row>
<row label="spam" cs:extra="SPAM" >SPAM</row>
<row label="r3"   cs:extra="BACON" exclusive="1" randomize="0">BACON</row>

CleanNotes

To clean aggregated tasks in the form of <!-- XXX [foo]: bar -->

<leader>no

<!-- XXX [Q1]: Not enough Spam -->
<!-- XXX [Q2]: Bacon doesn't have Spam on it -->
<!-- XXX [Q3]: Spam, then Eggs, then Spam -->

...will become...

[Q1]: Not enough Spam
[Q2]: Bacon doesn't have Spam on it
[Q3]: Spam, then Eggs, then Spam

Insertions

Executing these commands will insert their accompanied text at the cursor's position

<leader>ee

exclusive="1" randomize="0"
<leader>rr

randomize="0"
<leader>oe

open="1" openSize="25" randomize="0"
<leader>aa

aggregate="0" percentages="0"
<leader>oo

optional="1"
<leader>dev

where="execute"
<leader>sh

shuffle="rows"
<leader>su

<suspend/>  // this is inserted below the current line
<leader>br

<br/><br/>
<leader>mb

<br><br>

Visual Mode

These commands are to be executed in vim's Visual mode. Note the use of the period as a delimiter of a cell's label.

Rows

Make row cells

<leader>ro

Ham
foo. Spam
bar Eggs
42. Bacon

...will become...

<row label="r1">Ham</row>
<row label="foo">Spam</row>
<row label="r3">bar Eggs</row>
<row label="r42">Bacon</row>

Cols

Make col cells

<leader>co

Ham
foo. Spam
bar Eggs
42. Bacon

...will become...

<col label="c1">Ham</col>
<col label="foo">Spam</col>
<col label="c3">bar Eggs</col>
<col label="c42">Bacon</col>

Choice

Make choice cells

<leader>ch

Ham
foo. Spam
bar Eggs
42. Bacon

...will become...

<choice label="ch1">Ham</choice>
<choice label="foo">Spam</choice>
<choice label="ch3">bar Eggs</choice>
<choice label="ch42">Bacon</choice>

Rates

Make rating-style col cells with <br/> tags before poles. Note: periods delimiting labels and text are optional as the digits are assumed to be the rating numbers.

<leader>ra

1 Spammy
2
3
4
5 Very Spammy

...will become...

<col label="c1">Spammy<br/>1</col>
<col label="c2">2</col>
<col label="c3">3</col>
<col label="c4">4</col>
<col label="c5">Very Spammy<br/>5</col>

MakeRadio

Make radio element

<leader>mr

Q1 Which is your favorite?
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>

...will become...

<radio label="Q1">
  <title>Which is your favorite?</title>
  <comment>Please select one</comment>
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>
</radio>
<suspend/>

MakeRating

Make radio-rating element

<leader>mv

Q1 Please rate each item by it's spam factor
  <col label="c1">Spammy<br/>1</col>
  <col label="c2">2</col>
  <col label="c3">3</col>
  <col label="c4">4</col>
  <col label="c5">Very Spammy<br/>5</col>
  <row label="r1">Spam</row>
  <row label="r2">Spam Spam</row>
  <row label="r3">Spam Spam Spam</row>

...will become...

<radio label="Q1" averages="cols" values="order" adim="rows" type="rating">
  <title>Please rate each item by it's spam factor</title>
  <comment>Please select one for each row</comment>
  <col label="c1">Spammy<br/>1</col>
  <col label="c2">2</col>
  <col label="c3">3</col>
  <col label="c4">4</col>
  <col label="c5">Very Spammy<br/>5</col>
  <row label="r1">Spam</row>
  <row label="r2">Spam Spam</row>
  <row label="r3">Spam Spam Spam</row>
</radio>
<suspend/>

MakeCheckbox

Make checkbox element

<leader>mc

Q1 What would you like?
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>

...will become...

<checkbox label="Q1" atleast="1">
  <title>What would you like?</title>
  <comment>Please select all that apply</comment>
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>
</checkbox>
<suspend/>

MakeSelect

Make select element

<leader>ms

Q1 Select your quantity of each...
  <choice label="ch1">0</choice>
  <choice label="ch2">1</choice>
  <choice label="ch3">2</choice>
  <choice label="ch4">3</choice>
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>

...will become...

<select label="Q1" optional="0">
  <title>Select your quantity of each...</title>
  <comment>Please select one for each selection</comment>
  <choice label="ch1">0</choice>
  <choice label="ch2">1</choice>
  <choice label="ch3">2</choice>
  <choice label="ch4">3</choice>
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>
</select>
<suspend/>

MakeNumber

Make number element

<leader>mn

Q1 Enter desired quantity for each item...
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>

...will become...

<number label="Q1" optional="0" size="3">
  <title>Enter desired quantity for each item...</title>
  <comment>Please enter a whole number</comment>
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>
</number>
<suspend/>

MakeFloat

Make float element

<leader>mf

Q1 What... is the air-speed velocity of an unladen swallow?

...will become...

<float label="Q1" optional="0" size="3">
  <title>What... is the air-speed velocity of an unladen swallow?</title>
  <comment>Please enter a number</comment>
</float>
<suspend/>

MakeText

Make text element

<leader>mt

Q1 Please explain your love for the following...
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>

...will become...

<text label="Q1" optional="0">
  <title>Please explain your love for the following...</title>
  <comment>Please be as specific as possible</comment>
  <row label="r1">Ham</row>
  <row label="foo">Spam</row>
  <row label="r3">bar Eggs</row>
  <row label="r42">Bacon</row>
</text>
<suspend/>

MakeTextarea

Make textarea element

<leader>ma

Q42 Briefly describe the ultimate question of life, the universe, and everything

...will become...

<textarea label="Q42" optional="0">
  <title>Briefly describe the ultimate question of life, the universe, and everything</title>
  <comment>Please be as specific as possible</comment>
</textarea>
<suspend/>

MakeHTML

Make html element

<leader>mh

That's it. That's all there is.

...will become...

<html label="" where="survey">
  <p>
    That's it. That's all there is.
  </p>
</html>

Resource

Make res elements

<leader>re

spamLot. Ham Spam Eggs Bacon and Spam

...will become...

<res label="spamLot">Ham Spam Eggs Bacon and Spam</res>

MakeGroups

Make group cells

<leader>mg

Spam
Eggs
Bacon
Ham

...will become...

<group label="g1">Spam</group>
<group label="g2">Eggs</group>
<group label="g3">Bacon</group>
<group label="g4">Ham</group>

MakeNets

Make net Cells

<leader>ne

Spam
Eggs
Bacon
Ham

...will become...

<net labels="">Spam</net>
<net labels="">Eggs</net>
<net labels="">Bacon</net>
<net labels="">Ham</net>

NoAnswer

Make noanswer cells

<leader>na

r99. I do not like spam

...will become...

<noanswer label="r99">I do not like spam</noanswer>

Case

Make a pipe consisting of selected lines as cases

<leader>ca

Spam
Eggs
Bacon
Ham

...will become...

<pipe label="" capture="">
  <case label="c1" cond="">Spam</case>
  <case label="c2" cond="">Eggs</case>
  <case label="c3" cond="">Bacon</case>
  <case label="c4" cond="">Ham</case>
  <case label="c99" cond="1">BAD PIPE</case>
</pipe>

AddValuesLow

Add values to cells from low to high

<leader>avl

  <col label="c1">Spammy<br/>1</col>
  <col label="c2">2</col>
  <col label="c3">3</col>
  <col label="c4">4</col>
  <col label="c5">Very Spammy<br/>5</col>

...will become...

<col label="c1" value="1">Spammy<br/>1</col>
<col label="c2" value="2">2</col>
<col label="c3" value="3">3</col>
<col label="c4" value="4">4</col>
<col label="c5" value="5">Very Spammy<br/>5</col>

AddValuesHigh

Add values to cells from high to low

<leader>avh

  <col label="c5">Very Spammy<br/>5</col>
  <col label="c4">4</col>
  <col label="c3">3</col>
  <col label="c2">2</col>
  <col label="c1">Spammy<br/>1</col>

...will become...

<col label="c5" value="5">Very Spammy<br/>5</col>
<col label="c4" value="4">4</col>
<col label="c3" value="3">3</col>
<col label="c2" value="2">2</col>
<col label="c1" value="1">Spammy<br/>1</col>

AddGroups

Add groups to cells

<leader>ag

  <row label="a">King Arthur</row>
  <row label="b">Launcelot</row>
  <row label="c">Shrubber</row>

...will become...

<row label="a" groups="g1">King Arthur</row>
<row label="b" groups="g1">Launcelot</row>
<row label="c" groups="g1">Shrubber</row>

AddAlts

Add alts to cells and title. Which ever is contained in the visual selection.

<leader>aa

<text label="Q1" optional="0">
  <title>Please explain your love for the following...</title>
  <comment>Please be as specific as possible</comment>
  <row label="r1">${res.spam1}</row>
  <row label="r2">${res.spam2}</row>
  <row label="r3">${res.spam3}</row>
  <row label="r4">${res.spam4}</row>
</text>
<suspend/>

...will become...

<text label="Q1" optional="0">
  <title>Please explain your love for the following...</title>
  <alt>Please explain your love for the following...</alt>
  <comment>Please be as specific as possible</comment>
  <row label="r1"><alt>${res.spam1}</alt>${res.spam1}</row>
  <row label="r2"><alt>${res.spam2}</alt>${res.spam2}</row>
  <row label="r3"><alt>${res.spam3}</alt>${res.spam3}</row>
  <row label="r4"><alt>${res.spam4}</alt>${res.spam4}</row>
</text>
<suspend/>

CommentQuestion

Create a question comment

<leader>qc

Please select one spam

...will become...

<comment>Please select one spam</comment>

XMLEscape

Escape < and > characters into &lt; and &gt;

<leader>es

Green eggs and <em>spam</em>

...will become...

Green eggs and &lt;em&gt;spam&lt;/em&gt;

XML/HTML Comment

Comment out some text from the xml

<leader>hc

I have to push the pram a lot.

...will become...

<!--
I have to push the pram a lot. 
-->

Make Extras

Pull text node value into a configurable style attribute. This is useful when you want to use row text, but avoid translation problems.

<leader>me

  <row label="r1">Spam</row>
  <row label="r2">Ham</row>
  <row label="r3">Bacon</row>

...will become...

<row label="r1" cs:extra="Spam" >Spam</row>
<row label="r2" cs:extra="Ham"  >Ham</row>
<row label="r3" cs:extra="Bacon">Bacon</row>

Quote Spaces

HTML escape spaces. This is very useful when dealing with macro arguments which are space delimited

<leader>qs

That parrot is dead

...will become...

That&#32;parrot&#32;is&#32;dead

Strip

Strip text nodes from selected cells

<leader>st

  <col label="c1">Spammy<br/>1</col>
  <col label="c2">2</col>
  <col label="c3">3</col>
  <col label="c4">4</col>
  <col label="c5">Very Spammy<br/>5</col>
  <row label="r1">Spam</row>
  <row label="r2">Spam Spam</row>
  <row label="r3">Spam Spam Spam</row>

...will become...

Spammy<br/>1
2
3
4
Very Spammy<br/>5
Spam
Spam Spam
Spam Spam Spam

Switcher

Switch back and forth between cols and rows

<leader>sw

  <row label="r1">Spam</row>
  <row label="r2">Spam Spam</row>
  <row label="r3">Spam Spam Spam</row>

...will become...

<col label="c1">Spam</col>
<col label="c2">Spam Spam</col>
<col label="c3">Spam Spam Spam</col>

Quote URL

URL escape selection. This very handy in passing text to certain swf's that do not do this themselves.

<leader>qu

No, now go away or I shall taunt you a second time.

...will become...

No%2C%20now%20go%20away%20or%20I%20shall%20taunt%20you%20a%20second%20time.%20

CleanUp

Clean out common utf-8 chars and remove excessive tabs and newlines

<leader>cl

‘“HAM”–“SPAM”&“EGGS”’…

...will become...

'"HAM"-"SPAM"&amp;"EGGS"'...

HRef

Turn the selected text into a hyperlink. This is useful in emails where the href and the text node will have the same value.

<leader>hr

http://google.com

...will become...

<a href="http://google.com">http://google.com</a>

MailLink

Turn the selected text into a mailto: hyperlink

<leader>ml

foo@bar.com

...will become...

<a href="mailto:foo@bar.com">foo@bar.com</a>

About

Vim clips for Decipher surveys

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Python 82.2%
  • Vim Script 17.7%
  • Makefile 0.1%