brokenprogrammer / hdocs Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 100 KB

GUI application to make it easier producing software documents using templates.

License: MIT License

Haskell 100.00%

hdocs's Introduction

HDocs

GUI application to make it easier producing software documents using templates.

hdocs's People

Contributors

Watchers

hdocs's Issues

Create HDocsGUI for the main window and initialize it upon new proj.

The HDocs.glade should be utilized and initialized when the New button in the Splash gui is pressed.
Things to keep in mind:

Might need to delete or destroy the splash window.
If destroyed should the HDocs be called from the SplashGUI main or the Main.hs main ?

Possible to return an actual value from the SplashGUI main and then call the HDocs GUI from the main together with the result from the SplashGUI.

Set up stack and use stack instead of cabal for running.

Populate the HDocsVars.

Basically the same as #20 but will contain the variables in the form of "${name}" read from within the template document.

For later feature when this link is clicked the HDocsHelpBar will also be populated with help information regarding the clicked section.

Clean file structure.

Using the current structure there will be several *GUI.hs modules which feels a bit repetitive and the files contain a lot of logic. Maybe there is a better way to structure this into modules.

Fix GTK Warning for NewDialog, Need Transient Parent.

Following warning message is displayed in the terminal when running HDocs. It should be fixed.
Gtk-Message: GtkDialog mapped without a transient parent. This is discouraged.

Display JSON Template on the screen.

The JSON templates are currently being read using a simple initial template format. Time to read the contents and display it in the main editor window.

Figure out proper file format for templates.

Each template as of current plans should contain the following:

Template text (This is static text used by the template)
Template variables (This is variables that the user can switch out to their own text or values)
Template variables help (This is some form of comments that will be available to aid the user when entering the comments for the template variables.)

Implement proper structure for TextTags.

Find out a good way on how to implement all the TextTags for HDocs and where to place them. Maybe a separate module is the right choice for this.

Clean up evalState in SplashGUI

TODO: Account for when invalid Name or TemplateName is specified.
TODO: Maybe remove data types such as SplashGUIState & NewProjectData and use type instead.
Oskar Mendel 2018-02-27

Add scroll window to the HDocs window.

The HDocs editor which is a TextView currently expands vertically instead of a scrollbar showing up. This can be fixed by wrapping the target widget into a Scroll Window in glade.

Add support for variable comments.

This type of comment will probably have to sit within the same string as its variable looking something like this:

"author": "${name} *{This is the name of the author of the document.}"

The *{} type can be changed to something else if something that looks better iss found.

Add toolbar for changing font, size & color.

When writing a document different fonts, headers colors etc needs to be available for use. A toolbar should be added using glade and the implementation can be left out for a different issue.

Implement propper parsing of the templates

Maybe a parsing library would be both more sane and efficient than the current manual parsing which feels really "hacky". This should be looked into.

Initial GUI design (Structure)

Structure of how the GUI should look like not the actuall style of it.

Add keyboard shortcuts.

Using standard keyboard shortcuts to used for writing documents will probably increase the productivity for the ones who uses the application.

Some examples:

CTRL + B - Makes marked text bold
CTRL + I - Makes marked text cursive
...

HDocsLinks is a GtkTreeView which is supposed to contain buffer links to different areas of the document. For example if we have an introduction section in the document there will be a link to that section header which scrolls to that specific section when you click the link.

For later feature when this link is clicked the HDocsHelpBar will also be populated with help information regarding the clicked section.

Implement support for saving & loading.

Apply TextTag styling to the titles.

gtk3 uses something called TextTags to modify parts of text within a TextBuffer and this is probably what will have to be used when adding different styles to the editor.

For this implementation I'm thinking that addToBuffer should be modified to take a TextTag in the parameters as well and if passed the text should be set to use that TextTag.

https://hackage.haskell.org/package/gtk3-0.14.8/docs/Graphics-UI-Gtk-Multiline-TextTag.html#t:TextTag

Implement support for reading JSON files.

Add support for reading JSON files and then work on storing the contents into appropriate structure.
Some module planning will have to take place around this issue.

File.hs - Handle file functions such as reading, writing and creating files.
JSON.hs - Parses the JSON contents of a file.
Note to self: Above two modules may need some more thought behind them and there might be a good idea for a 3rd module that contains the actuall data structure and constructs it by taking in the parsed JSON contents.