Dexy filter to use WebSequenceDiagrams.com
wsd
.wsd
.png
.svg
.img
.pdf
Setting | Description | Default |
---|---|---|
add-new-files | Boolean or list of extensions/patterns to match. | False |
added-in-version | Dexy version when this filter was first available. | 1.0.13 |
additional-doc-filters | Filters to apply to additional documents created as side effects. | {} |
additional-doc-settings | Settings to apply to additional documents created as side effects. | {} |
api-key-name | The name of this API | wsd |
api-url | The url of the API endpoint. | http://www.websequencediagrams.com/ |
data-type | Alias of custom data class to use to store filter output. | generic |
document-api-config-file | Filename to store config for a file (can only have 1 per directory, dexy looks for suffix format first. | None |
document-api-config-postfix | Suffix to attach to content filename to indicate this is the config for that file. | -config.json |
examples | Templates which should be used as examples for this filter. | [] |
exclude-add-new-files | List of patterns to skip even if they match add-new-files. | [] |
exclude-new-files-from-dir | List of directories to skip when adding new files. | [] |
ext | File extension to output. | None |
extension-map | Dictionary mapping input extensions to default output extensions. | None |
help | Helpstring for plugin. | Dexy filter to use WebSequenceDiagrams.com |
input-extensions | List of extensions which this filter can accept as input. | ['.wsd'] |
keep-originals | Whether, if additional-doc-filters are specified, the original unmodified docs should also be added. | False |
key | Your WebSequenceDiagrams API Key if you have one | None |
master-api-key-file | Master API key file for user. | ~/.dexyapis |
mkdir | A directory which should be created in working dir. | None |
mkdirs | A list of directories which should be created in working dir. | [] |
nodoc | Whether filter should be excluded from documentation. | False |
output | Whether to output results of this filter by default by reporters such as 'output' or 'website'. | True |
output-extensions | List of extensions which this filter can produce as output. | ['.png', '.svg', '.img', '.pdf'] |
override-workspace-exclude-filters | If True, document will be populated to other workspaces ignoring workspace-exclude-filters. | False |
preserve-prior-data-class | Whether output data class should be set to match the input data class. | False |
project-api-key-file | API key file for project. | .dexyapis |
require-output | Should dexy raise an exception if no output is produced by this filter? | True |
style | Style to use, e.g. 'patent' or 'napkin' | default |
tags | Tags which describe the filter. | [] |
variables | A dictionary of variable names and values to make available to this filter. | {} |
vars | A dictionary of variable names and values to make available to this filter. | {} |
version | Version of the WebSequenceDiagrams API to address | 1 |
workspace-exclude-filters | Filters whose output should be excluded from workspace. | ['pyg'] |
workspace-includes | If set to a list of filenames or extensions, only these will be populated to working dir. | None |
Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.