Permalink
Browse files

[docs+visidata.org] Release prep.

  • Loading branch information...
anjakefala committed Nov 24, 2017
1 parent b18ab23 commit bdabc315f860e2731f1214734428d3c5fdbbfed6
Showing with 196 additions and 100 deletions.
  1. +1 −0 CONTRIBUTING.md
  2. +1 −2 README.md
  3. +1 −1 docs/README.md
  4. +13 −1 mkwww.sh
  5. +5 −2 visidata/man/parse_options.py
  6. +65 −23 visidata/man/vd.1
  7. +62 −20 visidata/man/vd.inc
  8. +0 −5 www/about.md
  9. +5 −3 www/main.css
  10. +1 −1 www/news/news.tsv
  11. +5 −5 www/news/v0.97.md
  12. +37 −37 www/news/v0.98.md
View
@@ -5,6 +5,7 @@ VisiData was written for those of us on the edge, with one foot necessarily in t
### Code contributions
VisiData has two main branches:
- [stable](https://github.com/saulpw/visidata/tree/stable) has the last known good version of VisiData (which should be on pypi).
- [develop](https://github.com/saulpw/visidata/tree/develop) has the most up-to-date version of VisiData (which will eventually be merged to stable).
View
@@ -29,7 +29,6 @@ Use `-f <filetype>` to force a particular filetype.
* Quick reference: `F1` (or `z?`) within `vd` will open the [man page](http://visidata.org/man), which has a list of all commands and options.
* [visidata.org](http://visidata.org) has [asciicasts of its tests](http://visidata.org/test), which serve as example workflows.
* [The Design of VisiData](http://visidata.org/design), documentation of internals for developers and contributors.
## Support
@@ -38,7 +37,7 @@ If you want to chat about VisiData, make a feature request, or submit a bug repo
- [r/visidata](https://www.reddit.com/r/visidata/) on reddit
- [#visidata](irc://freenode.net/#visidata) on [freenode.net](https://webchat.freenode.net)
For more detailed information about how you can contribute as a developer, influence the roadmap as a user, or provide us with sufficient information to better support you through any issues you come across see the [CONTRIBUTION.md](CONTRIBUTION.md).
For more detailed information about how you can contribute as a developer, influence the roadmap as a user, or provide us with sufficient information to better support you through any issues you come across see the [CONTRIBUTING.md](CONTRIBUTING.md).
## vdtui
View
@@ -14,4 +14,4 @@ VisiData's architecture is converging on an internal design and API, but it is n
However, if you wish to expand VisiData so that it can work with a new beloved data format, it is not difficult, and we would love to work with you and provide support and direction.
Currently, VisiData supports tsv, csv, hdf5, piping from stdin, mbtiles, postgres, shp, sqlite, xlsx, xls, and zip. We would love to find devs interested in creating loaders for xml, json, pandas dataframes, html, and many others.
Currently, VisiData supports tsv, csv, hdf5, piping from stdin, json, mbtiles, postgres, shp, sqlite, xlsx, xls, and zip. We would love to find devs interested in creating loaders for xml, pandas dataframes, html, and many others.
View
@@ -48,8 +48,10 @@ $VD/strformat.py body=$BUILDWWW/about/index.body title="About VisiData" head=""
# Build /man
echo '<section><pre>' > $BUILD/vd-man-inc.html
MAN_KEEP_FORMATTING=1 COLUMNS=100 man $MAN/vd.1 | ul | aha --no-header >> $BUILD/vd-man-inc.html
# <pre> max-width in main.css should be half of COLUMNS=###
MAN_KEEP_FORMATTING=1 COLUMNS=120 man $MAN/vd.1 | ul | aha --no-header >> $BUILD/vd-man-inc.html
echo '</pre></section>' >> $BUILD/vd-man-inc.html
# Properties of columns on the source sheet can be changed with standard editing commands (e
$VD/strformat.py body=$BUILD/vd-man-inc.html title="VisiData Quick Reference" head="" < $WWW/template.html > $BUILDWWW/man/index.html
# Build /contributing
@@ -96,6 +98,16 @@ mkdir -p $BUILDWWW/news
$NEWS/mknews.py $NEWS/news.tsv > $BUILD/news.body
$VD/strformat.py body=$BUILD/news.body title="VisiData News" head='' < $WWW/template.html > $BUILDWWW/news/index.html
for postpath in `find $NEWS -name '*.md'`; do
post=${postpath##$NEWS/}
postname=${post%.md}
mkdir -p $BUILDWWW/news/$postname
posthtml=$BUILDWWW/news/$postname/index
pandoc -r markdown -w html -o $posthtml.body $postpath $VD/strformat.py
body=$posthtml.body title=$postname head="" < $WWW/template.html > $posthtml.html
rm -f $posthtml.body
done
# Build /help
mkdir -p $BUILDWWW/help
pandoc -r markdown -w html -o $BUILDWWW/help/index.body $VD/CONTRIBUTING.md
@@ -20,12 +20,15 @@
{description}
'''
visidata.options.plot_colors = ''
with open(fncli, 'w') as cliOut:
with open(fnopts, 'w') as menuOut:
opts = visidata.baseOptions.keys()
colwidth = max((len(optname)+len(str(default))) for optname, default, _, _ in visidata.baseOptions.values())
menuOut.write('.Bl -tag -width %s -compact\n' % ('X'*(colwidth+3)))
widestoptwidth, widestopt = sorted((len(optname)+len(str(default)), optname) for optname, default, _, _ in visidata.baseOptions.values())[-1]
print('widest option+default is "%s", width %d' % (widestopt, widestoptwidth))
menuOut.write('.Bl -tag -width %s -compact\n' % ('X'*(widestoptwidth+3)))
cliwidth = max(padding+len(str(default)) for _, default, _, _ in visidata.baseOptions.values())
cliOut.write('.Bl -tag -width %s -compact\n' % ('X'*(cliwidth+3)))
View
@@ -138,12 +138,17 @@ scrolls current row to top/center/bottom of screen
.
.It Ic " _" Ns " (underscore)"
adjusts width of current column
.It Ic "g_" Ns " (underscore)"
.It Ic "g_"
adjusts width of all visible columns
.It Ic "z_" Ar number
.No adjusts width of current column to Ar number
.Pp
.It Ic - Ns " (hyphen)"
.It Ic " -" Ns " (hyphen)"
hides current column (to unhide, go to
.Sy C Ns olumns sheet and Sy e Ns dit its width)
.It Ic "z-" Ns
cuts width of current column in half
.Pp
.It Ic \&! Ns
pins current column on the left as a key column
.It Ic ^
@@ -285,10 +290,6 @@ opens
.No saves commandlog to Ar filename.vd No file
.It Ic "Shift-A" Ar number
.No opens new blank sheet with Ar number No columns
.It Ic " m"
.No opens a canvas graphing current column against key column
.It Ic "gm"
.No opens a canvas graphing all visible columns against key column
.It Ic "Shift-R" Ar number
opens duplicate sheet with a random population subset of
.Ar number No rows
@@ -297,6 +298,35 @@ opens duplicate sheet with a random population subset of
.No adds Ar aggregator No to current column (see Sy "Frequency Table" Ns )
.It Ic "z+" Ar aggregator
.No displays result of Ar aggregator No over values in selected rows for current column
.Pp
.El
.Ss Data Visualization
.Bl -tag -width XXXXXXXXXXXXX -compact
.It Ic " ." No (dot)
.No graphs current numeric column vs key columns. Numeric key column is on the x-axis, while categorical key columns determine color.
.It Ic "g."
.No opens a graph of all visible numeric columns vs key column
.Pp
.El
.No If rows on the current sheet represent plottable coordinates (as in .shp or vector .mbtiles sources), Sy "." No plots the current row, and Ic "g." No plots all selected rows (or all rows if none selected).
.Ss " Canvas-specific Commands"
.Bl -tag -width XXXXXXXXXXXXXXXXXX -compact -offset XXX
.It Ic " + -"
increase/decrease zoomlevel, centered on cursor
.It Ic " s u"
selects/unselects rows on source sheet contained within canvas cursor
.It Ic "gs gu"
selects/unselects rows visible on the screen
.It Ic "Enter"
pushes source sheet with only rows contained within canvas cursor
.It Ic "1" No - Ic "9"
toggles display of layers
.It Ic "mouse scrollwheel"
zooms in/out on a canvas
.It Ic "left click-drag"
sets canvas cursor
.It Ic "right click-drag"
scrolls canvas
.El
.Ss Other Commands
.
@@ -310,7 +340,7 @@ views contents of current cell in a new TextSheet
toggles text wrap (only on TextSheet)
.El
.Bl -tag -width XXXXXXXXXXXXXXX -compact
.It Ic " ^^ (Ctrl-^)"
.It Ic " ^^" No (Ctrl-^)
jumps to previous sheet (swaps with current sheet)
.It Ic " ^E"
views traceback for most recent error
@@ -328,6 +358,8 @@ shows version information on status line
reloads current sheet
.It Ic "z^R"
clears cache for current column
.It Ic " ^Z"
sends a SIGSTOP
.
.El
.Pp
@@ -378,6 +410,8 @@ opens sheet of current row/cell as Python object
.Bl -tag -width XXXXXXXXXXXXXXX -compact -offset XXX
.It Ic " &"
adds column from concatenating selected source columns
.It Ic " !"
toggles current column as key on source sheet
.It Ic "g!"
toggles selected columns as keys on source sheet
.It Ic "g+"
@@ -386,6 +420,8 @@ adds aggregator to selected source columns
adjusts widths of selected columns on source sheet
.It Ic "g-" No (hyphen)
hides selected columns on source sheet
.It Ic " ~ # % $ @"
sets type of current column to str/int/float/currency/date
.It Ic "g~ g# g% g$ g@"
sets type of selected columns to str/int/float/currency/date
.It Ic " Enter"
@@ -429,6 +465,8 @@ edits option
.It (sheet-specific commands)
.El
.Bl -tag -width XXXXXXXXXXXXXXX -compact -offset XXX
.It Ic " ^Z"
sends a SIGSTOP
.It Ic " x"
replays command in current row
.It Ic "gx"
@@ -488,7 +526,7 @@ opens sheet of source rows which comprise current pivot cell
dives further into Python object
.It Ic "e"
edits contents of current cell
.It Ic "\&." No (period)
.It Ic "w"
toggles whether methods and hidden properties are shown
.El
.
@@ -510,7 +548,7 @@ overwrites existing files without confirmation
.No adds colorizer for all sheets against Ar base
.
.El
.Bl -tag -width XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -compact
.Bl -tag -width XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -compact
.It Sy --encoding Ns = Ns Ar "str " No "utf-8"
as passed to codecs.open
.It Sy --encoding-errors Ns = Ns Ar "str " No "surrogateescape"
@@ -573,7 +611,7 @@ insert movements during replay
maxsplit to pass to regex.split
.It Sy --show-graph-labels Ns = Ns Ar "bool " No "True"
show axes and legend on graph
.It Sy --plot-colors Ns = Ns Ar "str " No "green red yellow cyan magenta white 38 136 168"
.It Sy --plot-colors Ns = Ns Ar "str " No ""
list of distinct colors to use for plotting distinct objects
.It Sy --zoom-incr Ns = Ns Ar "float " No "2.0"
amount to multiply current zoomlevel by when zooming
@@ -593,7 +631,7 @@ number of rows to check for fixed width columns
.No Display options can only be set via the Sx Options Sheet No or a config file (see Sx FILES Ns ).
.Pp
.
.Bl -tag -width XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -compact
.Bl -tag -width XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -compact
.It Sy "disp_none " No ""
visible contents of a cell whose value was None
.It Sy "disp_date_fmt " No "%Y-%m-%d"
@@ -696,41 +734,45 @@ For example:
.Ed
.
.Sh SUPPORTED SOURCES
.Bl -inset -compact
These are the supported sources:
.Bl -inset -compact -offset xxx
.It Sy tsv No (tab-separated value)
.El
.Bl -inset -compact -offset xxx
.It Plain and simple. Nm VisiData No writes tsv format by default.
.It Plain and simple. Nm VisiData No writes tsv format by default. See the Sy --delimiter No option.
.El
.El
.Pp
.Bl -inset -compact
.Bl -inset -compact -offset xxx
.It Sy csv No (comma-separated value)
.El
.Bl -inset -compact -offset xxx
.It .csv files are a scourge upon the earth, and still regrettably common. See the Sy --csv-dialect Ns , Sy --csv-delimiter Ns , Sy --csv-quotechar Ns , and Sy --csv-skipinitialspace No options.
.El
.El
.Pp
.Bl -inset -compact
.Bl -inset -compact -offset xxx
.It Sy fixed No (fixed width text)
.El
.Bl -inset -compact -offset xxx
.It Columns are autodetected from the first 1000 rows (adjustable with Sy --fixed-rows Ns ).
.El
.El
.Pp
.Bl -inset -compact -offset xxx
.It " " For these multi-table sources, the first sheet is a directory of tables.
.It " " Sy Enter No loads the entire table into memory.
.Bl -inset -compact
.It For these multi-table sources, the first sheet is a directory of tables.
.It Sy Enter No loads the entire table into memory.
.El
.Pp
.Bl -inset -compact -offset xxxxxx
.Bl -inset -compact -offset xxx
.It Sy sqlite
.It Sy xlsx No (requires Sy openpyxl Ns )
.It Sy xls No (requires Sy xlrd Ns )
.It Sy hdf5 No (requires Sy h5py Ns )
.It Sy postgres No (requires Sy psycopg2 Ns )
.It Sy shp No (requires Sy pyshp Ns )
.It Sy mbtiles No (vector only, requires Sy mapbox-vector-tile Ns )
.El
.
.Sh AUTHOR
.Nm VisiData
was conceived and implemented by
.An Saul Pwanson Aq Mt visidata@saul.pw Ns .
.An Saul Pwanson Aq Mt vd@saul.pw Ns .
Oops, something went wrong.

0 comments on commit bdabc31

Please sign in to comment.