So, when I look back on this project, I did my first check in on October 31^st, 2009. Just a generic QT project. This project was truly on a whim. I had grand ideas, but, I really didn't get far. Learning the QT interface alone was a daunting task. And then, of course, the Spirit 2.1 library was in the process of getting released. Working on the documentation for Spirit 2.1 helped to learn that library at a much faster pace. So many things to learn, so many ideas floating in my head.

So, where am I today? I've got a basic parser that reads the common syntax types and displays them in a QTextEditor. I parse directly to a QTextCursor, which in turn is displayed in a tab. It's a good starting point in my opinion. Proof of concept is working. So, here, I'll layout what I'm trying to do.

The first and foremost point that I've found with the Boost documentation is, QuickBook files are used mostly as project files for documentation. There is a master file that contains the includes for the subsections (or chapters) which of course are also .qbk files. So, one feature of the QuickBook Editor (QBE) will be to manage the documentation project with a project pane, showing all the related files for a documentation project.

The next major point is a Table of Contents (TOC) widget that shows the sections in a hierarchical format including section names and headings. Easy to navigate from section to section for editor purposes. As the user clicks a section or heading, the information is then displayed in a QTextEditor.

Macro and template definitions will also be displayed in a list widget so that the user can quickly edit them. Inserting them will be as simple as right clicking in the editor and selecting the insertion type from a menu, with the proper item.

So, as the information is parsed in from the read process, a file object gets created that is used to store all the pertinent information. The main document which needs to get edited, lists for includes, macros, templates and such. Everything gets parsed into something that is related to a file. So, when the parser is running on a project, it will marshal up the include sections and build a list of files. It's recursive, so, everything gets put somewhere.

So, back to the grind stone. I'm now going to start working on the file object and putting things in their places. Look for something soon, because, I'm cranking away.

Comments

Add New Search

Write comment
Name:
Email:	do not notifynotify
Website:
Title:
UBBCode:	-color-aquablackbluefuchsiagraygreenlimemaroonnavyolivepurpleredsilvertealwhiteyellow -size-tinysmallmediumlargehuge

Powered by !JoomlaComment 3.12

Copyright (C) 2007 Alain Georgette / Copyright (C) 2006 Frantisek Hliva. All rights reserved.