Tiddlywiki edition (app): Building TW-Docs for creating a linear manual/tutorial/course-note/booklet

[Mohammad]

Sphinex with Read the Docs is one of the most common online app for making software tutorial and manuals.

As an example see the docs for Highlight.js at

https://highlightjs.readthedocs.io/en/latest/index.html

See alternatives at the bottom of this post.

I am trying to create TW-Docs app using Tiddlywiki + JD Material theme + JD font-size + some of Kookma plugins (like Shiraz + TOC+Hierarchical navigation + Utility + Favorites) + Comments plugin (not sure on this)

I did most part of the job but there is few things to be resolved before publishing:

1- On the footer of sidebar there is a button v-latest. It lets you to download the whole manual using PDF/HtmlZip/Epub

TW saves as a single .html the whole manual but how about exporting the book (manual) as PDF or epub? (I know printRiver from BTC: difficult to make the book in PDF, needs alot of manual work)

2- The search seems more powerful than Tiddlywiki standard search

It seems Read the Docs is a multi-user app, but I am not going to have TW-Docs a multi user app.

I appreciate to share ideas and solutions.

-- Mohammad

Ps: Alternatives to Read the Docs

1. https://alternativeto.net/software/read-the-docs/?license=free
2. https://www.gitbook.com/
   
3. https://skydocs.skyost.eu/en/index.html
   

[TiddlyTweeter]

2- The search seems more powerful than Tiddlywiki standard search

The new e-pub "highlight search" is very good in both highlighting in the "hit list" and in the text field.

The focus on the "text" field is particularly Good as its been under-used imo in the past. 

I think for "free-text" its simply the best approach. Tools like that are really excellent for unstructured data.

Most of the time you need nothing more.

TT 

[Mohammad]

Thank you TT

On Sunday, March 15, 2020 at 5:11:44 PM UTC+3:30, TiddlyTweeter wrote:

2- The search seems more powerful than Tiddlywiki standard search

The new e-pub "highlight search" is very good in both highlighting in the "hit list" and in the text field.

I am very interested in that! but it is not given as a plugin and I could not figure it out which tiddlers should be exported to use it in another wiki!

in the other hand I do not know what is the license! I hope it is MIT or similar ones to let others use it in their own wikis.

The focus on the "text" field is particularly Good as its been under-used imo in the past. 

I think for "free-text" its simply the best approach. Tools like that are really excellent for unstructured data.

Most of the time you need nothing more.

TT 

--Mohammad 

[TonyM]

Mohammad,

I am not exactly sure what you are missing but for my client I built a solution that produces a visible "report" that also uses <thead><tbody>etc... in tables and @media print css sutch that once they review the report they can open in new window and print or save to PDF. The PDF printer driver does the work and there are some issues to watch. For example sometimes I need to scale the page in the print preview to get the desired result.

To complement the use of interactive tables I have also generated a csv version of the same details and with a click the result is copied to the clipboard, perhaps there is a way to make a button wikify a non visible tiddler (PDF template) and send it to the printer?

On the standard search this is defined to suit new users but more and more we see custom or modified searches, what in your tiddlywiki can you not search for?

Regards

Tony

[Mohammad]

Thanks Tony!

On Monday, March 16, 2020 at 4:22:38 AM UTC+3:30, TonyM wrote:

Mohammad,

I am not exactly sure what you are missing but for my client I built a solution that produces a visible "report" that also uses <thead><tbody>etc... in tables and @media print css sutch that once they review the report they can open in new window and print or save to PDF. The PDF printer driver does the work and there are some issues to watch. For example sometimes I need to scale the page in the print preview to get the desired result.

In my opinion PrintRiver by BTC does part of the job. It needs improvement to lets have something like Wikipedia book creator: https://en.wikipedia.org/wiki/Help:Books 

To complement the use of interactive tables I have also generated a csv version of the same details and with a click the result is copied to the clipboard, perhaps there is a way to make a button wikify a non visible tiddler (PDF template) and send it to the printer?

On the standard search this is defined to suit new users but more and more we see custom or modified searches, what in your tiddlywiki can you not search for?

I mean when TW-Docs is used by people not familiar with Tiddlywiki, they expect the full content search and current search is different. By the way I am trying to use informative keywords in caption and perhaps another field and customize search to look at those fields.