....................................................... Title: WickedDocs Planning Subtitle: Bugs, Backlog, Roadmap Version: 1.0 Company: Subflexion Author: John Ryland Date: January 26, 2020 Copyright: (C) Copyright, 2020 Comment: Project Planning for WickedDocs, including backlog, bugs, changelog, roadmap and anything else, like new ideas and feature requests Style: SelectedStyle Password: pw .......................................................

Must Fix

--<<>>--

Wicked Docs

[%toc]

--<<>>--

Markdown specs

PDF specs

--<<>>--

Competitors

Byword
- macOS and iOS only, $11US ($16) - appears to lack applying templates and custom styling
- iCloud drive support (sync across devices)
- autosave
- spelling and grammar checking
- tags - file organization
- publish to internet / blog features
MarkdownPro
- macOS only, $10US
- templates / css
- export to PDF
- RTL
- save history
MarkdownPad
- Windows only
- Free version
- css styles
- Pro version, $15US
  - PDF export
  - tables
  - code syntax highlight
Bear
- macOS and iOS only
- note taking oriented
- Free version
- Pro version is $15 annually !!!

--<<>>--

Business Case / Analysis

http://blogs.harvard.edu/pamphlet/2014/08/29/switching-to-markdown-for-scholarly-article-production/

Academic usage required features
- generation of table of contents
- links
- footnotes
- cross-references
- figures
- tables
- citations
- bibliographies
- math equations (MathJax)

Publication
- multiple columns

Extension Features
- imports/includes <[include.ext]
- including a csv file and it expands as a table
- visualize a table as a graph or chart

--<<>>--

TODOs

For HTML preview - the style settings can be converted/output as CSS
- the HTML preview could re-use the WebView widget on macOS
installation of license file
idea: mime-multipart like emails for combining the markdown, style, formatting and referenced images to a single file for sending/export/reasons while maintaining some level of plain-text
UI add/remove templates files
handle user vs system templates and styles
- perhaps copy system ones to user when creating the user directory structure
need to have licensing - app config file
hook up missing connected toolbar buttons
undo/redo of property changes - not just text changes
open recent files - maintain a recent list
'export...' not implemented (both menu and project tab)
style template item of horizontal rule - text property to draw a HR.
- that way can add a HR under specific types of text or can
- turn off HRs completely
style/template settings for:
- text properties for 'links'
- syntax highlighting colors for code blocks
- properties for table (font, border thickness, colors, alternating colors, spacing etc)
- task list properties
- emoji set
defaults to new docs as .txt, but perhaps should be .md
need to add support for other platforms - test, installer/packaging
as the file gets larger, the refresh is way slower perhaps need a way to only redraw/refresh the first page? need to profile to figure out the problem

Search for todos in code
user configuration of UI colors and settings
in to setting up of templates
- support for markdown extensions like tables (github markdown supports this)
  - Kind of works - Need to add border and work on the conversion from HTML to PDF
- test cases
- support for syntax highlighting of code - colouring according to templates
  - Kind of have pre/code sections - need to set a fixed font, needs work
if add a ‘-‘ on line under text, the text is a heading
- in the PDF, these headings are underlined - feature or bug? style option?
broken build dependancies - after edit UI files, need to force recompile of other files

--<<>>--

Improvements

Git integration
Vim key bindings
be able to edit from the formatted view (or hide/remove it for MVP)
make template value items editable with context appropriate controls
EULA doesn't disclaim warrenties etc
Should make links to the EULA on the download page
WebSite terms of use page needs to make exception about the WickedDocs application which is downloaded from the site, that its terms of use are instead or additionally governed by the EULA
Perhaps need to add information about registered and non-registered versions of the software in both the EULA and terms of use pages
Privacy policy: "We will collect and use of personal information " ... badly worded. Need to look in to implications for how to handle customer lists etc.
should be a macOS native widget to display a PDF file
- could use this for macOS
- on Windows, using IE embedded ActiveX control might be one way instead of a QWebView
- Linux still needs to use the current approach

--<<>>--

Done

resizing issue of mainwindow splitter and native windows fixed
syntax highlighting is broken for italics more text bold
hide formatted view
img tag supported
list indenting fixed
Make it faster to edit - a bit slow and non-responsive
UI add/remove template objects
move template items up/down in the list
installer/packaging done for macOS
file size of PDF is really large - the background/images are duplicated each page - fixed with image caching
also file size seems much larger - found flags and settings to enable compression in libharu
need to copy/install Qt libraries in packaging up of build
currently has hard-coded letter head loading, should be from the template file
handle/test multiple instances running
move saving of temp files to a temp directory/location
application icon
search for template file, currently hard coded to load test.tmpl
hide debug things (menus, tool-windows etc)
coloring of plain-text markdown / syntax highlighting
titlebar of mdi child is black - must fix
plain-text editor control should be a fixed-width font
when run UI from the command line, open files from args if provided
one line of text, and on next line, the text doesn’t show in the PDF if add a CR between the lines, it appears
```
- Fixed - needed to handle <br> tag
```
menubar in wrong place - FIXED (code change to MdiWindow.cpp)
menubar not working until switch to other app and back - FIXED (run from MyApp.app dir)
Need to rename everywhere from MakePDF to WickedDocs (or other name). Wicked Docs is not bad.
black toolbar - fixed by not setting document mode and setting stylesheets
menu has “Show Tab Bar” / “Hide Tab Bar” which doesn’t make sense / bad feature - macOS thing, menu cleared
seems to break if remove the 2nd dummy toolbar - related to black toolbar issue and document mode
when running from MyApp.app dir, pdf.js resources not found, display not-retina/blurry
- blurry solution is Info.plist with NSHighResolutionCapable. now copying the resources
the preview as PDFs of some markdown files is wrong scale - seems ok with WebKit WebView
integration of color scheme editing

--<<>>--

Design Ideas

Command line tool takes a number of inputs and outputs a PDF
- the minimum input is the markdown text file
- additionally a style sheet and template and project settings can be passed
- the project settings can set a style sheet and template also
The GUI tool edits the project settings and the markdown text
- it can also edit the style sheet and template
- version control integration?? - tracking/comments
Markdown based for main text
- structured content
  - TOC
  - sections and sub-sections
  - bookmarks
  - insert images, tables, diagrams, graphs, media
  - comments / tracking?
Templates for background and headers and footers - portrait or landscape, page size, margins etc
Style sheet templates for how the markdown is transformed
These are all plain text files for easy version controlling
- Markdown text can be standard markdown
- Templates for background etc can be SVG based and JSON based
- Style sheet can be CSS like or JSON based
Palettes
- Palette editor to create a palette of colours to pick from
- Can also free pick colors - perhaps derived off of a palette color
- Colors need to store if they are relative to a palette or absolute
Style sheet contains
- font family, size, color and style/weight etc for each text markdown type
- indentation, spacing and alignment
- bullet / list styles
Editor for editing the templates and style sheets and previewing
Company template - like dot / word doc template.

--<<>>--

Testing

WebSite

one
two
1. one
2. two

--<<>>--

Example Image

ExampleImage

Alt text

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

a	a	ff ff	a	d
d	a	ff w	a	d
d	a	ffd df	a	d
d	a	a	a	d

y^(a+b)^ x~y,z~ y(a+b) xy,z

An example of math within a paragraph --- ${e}^{i\pi }+1=0$ --- easy enough.

And an equation on it's own:

\[ {x}_{1,2}=\frac{-b\pm \sqrt{{b}^{2}-4ac}}{2a} \\]

That's it. Here’s what it looks like in action (if you’re viewing this document in a supported format):

An example of math within a paragraph — ({e}^{i\pi }+1=0) — easy enough.

And an equation on it’s own:

[ {x}_{1,2}=\frac{-b\pm \sqrt{{b}^{2}-4ac}}{2a} ]

That’s it.

In addition to the \[ \\] and  syntax, you can use LaTeX style “dollar sign” delimiters:

An example of math within a paragraph --- ${e}^{i\pi }+1=0$ --- easy enough.

And an equation on it's own:

$${x}_{1,2}=\frac{-b\pm \sqrt{{b}^{2}-4ac}}{2a}$$

That's it.