t00m / kb4it Goto Github PK

It might be convenient to auto detect theme from a given source directory.

When a source filename has spaces, KB4IT is not able to handle it properly.

Finish implementing all features for this theme

• Events
• Messages
• Filtered key pages

After converting a json database of movies to KB4IT format and during the processing, I got the following error:

OSError: [Errno 36] File name too long: '/home/t00m/.kb4it/var/tmp/...

Enable pagination in order to display a large amount of values. Otherwise, it takes ages to display all doc cards at one.
Disable filters for key pages.

KB4IT should have a section or page for those document with the following property:

:Bookmark: True

Let people to use custom index, about and help pages instead of default ones.

Initially, when pages with filters are visited it shows all cards available in the database. That's is ok for a few doc cards. But not for many.

Images load on local but not in remote.
The images path should be relative. Now their path is absolute.

Allow KB4IT to use themes (user templates and scripts) to represent the information.

Eg.:

• Technical documentation
• Dictionaries
• Notes
• Bookmarking
• Blog
• Tasks

It repeats the number of pages to be displayed.

Until now, icons in cards depends on the availability of a value for the property 'Author'.

In future developments, KB4IT shouldn't have core properties.

Therefore, as proposal, KB4IT will look for an icon

• if an icon is present for the author property
• if not, it will look for an icon with the same name that the document in the resources/images/ directory
• finally, if none is found, it will use the default generic icon.

Whenever the metadata or the body is changed, KB4IT detects the change and force a new compilation.

That doesn't happen when the title is changed. Fix it.

Till now, UIKit is included by default as the front-end framework for developing the web interface.
KB4IT shouldn't care about the framework used. Themes should provide it.

How to improve KB4IT so it doesn't depend on core properties (a predefined set of properties)?
Or should KB4IT look for a very small set of properties (like Author, Category, Scope)?

KB4IT should have a specific section or page for new documents added or modified.

Your projects demo URL is a 404

t00m.github.io/KB4IT/demo

Create a demo site:

• Add more tests and sources
• Rename tests directory to demo-sources
• Create target directory demo-output

Allow users to keep track of new/modified documents in KB4IT:

1. One main feed for all documents in KB4IT
2. A feed for each property

Allow users to pass more command line options.

For example:

• Force a new and clean compilation
• Create a site only for a list of specific keys/values
• etc...

Allow themes to insert code before and after the page content.

By identifying a document with the property:

Category: Blog

KB4IT should handle it as a blog post.

There is no link to page All with a list of all documents available in the knowledge database.

Detected a wrong behavior when sources files are moved/deleted from an (already cached) directory.

Affected property pages should be compiled again.

Workaround: delete cache directory.

Cache directory can be found by checking DEBUG output during the compilation.

Fix 1: redesign the algorithm to detect changes
Fix 2: add an optional parameter to force a new and clean compilation.

• Explain workflow
• Explain themes

Current templating system is very basic (simple substitution).
By using mako template system, it is easier to create templates.

This adds the first dependency to the project. It was necessary.

Clean and polish HTML output for a better understanding of the code

When a key with spaces is clicked to open the modal window, it doesn't work.

Doc cards should display more info apart from title and author icon.

Display following metadata:
(=) Author
(=) Title
(+) Timestamp
(+) Category
(+) Scope
(?) Priority (badge)
(?) Status (change backround color)

Verify that DEBUG, INFO, WARNING and ERROR messages are useful.

Create a set of standard templates (modifiable by users) with a set of predefined properties and values. This would make easy to add issues / tickets / reports / blog posts / etc...

Currently, because of a bug, the compilation algorithm compile again several documents even if it is not necessary.
Fix it!

Current filter output doesn't show cards list sorted by title.

Create theme 'techdoc' (Technical documentation) with its own logic.