Hi Felix,
 

> Do you mean the dictionary format? 
>
How can I document nested objects with that or go multiline? 
>

I mean a simple...

title:foo
bar:baz

text

...all neatly enclosed for "doc'ing"...

/**
title:foo
bar:baz

text
*/

If an editor needs superfluous asterisks to highlight comment blocks, then 
maybe it's a poor editor.

/**
 * title:foo
 * bar:baz
 * 
 * text
 * */

Do you see how much that impinges on readability? ... if we wanted it to be 
*tid*-style?
To me it's shooting our own foot, with little peas maybe. ^^
 

> Do you want to write a parser that automatically does all the rendering 
> and automatic linking?
>

The parser wouldn't do that. That's the entire point. the parser would only 
output straight forward tiddlers. So, the miniml logic that is actually 
required goes into components for a TiddlyWiki API edition that does all 
the cross-referencing with TiddlyWiki elements, e.g. macros viewtemplate 
sections, etc. That's very straight forward stuff... and a pretty good case 
for leveraging and showcasing the power of this thing we all like.
 

> Why do you want to do this with tiddlywiki?
>

Because, that's the entire point of TiddlyWiki... to be used for 
documentation... in this case, it's very own API.

This is just code documentation directed at developers. Joomla and Drupal 
> are Content Management systems. Do they say: "let's develop and write our 
> code docs in a joomla parsable format and publish it as a Joomla or Drupal 
> Website?"
>

The difference is, those are not designed for that task  TiddlyWiki is. All 
it takes is a rather simple build script (within TiddlyWIki), one that 
isn't all too different from the one that creates TiddlyWiki itself... and 
we're set.

I encourage you to take a look at that draft on GitHub, maybe that gives a 
more concrete image.

https://github.com/tobibeer/TiddlyWikiDoc

Best wishes, Tobias.

-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/tiddlywikidev.
For more options, visit https://groups.google.com/d/optout.

Reply via email to