Welcome to Geeklog, Anonymous Wednesday, December 06 2023 @ 02:24 am EST

Geeklog Forums

GL Documentation - Formal Effort

Post New Reply

Author:

Mood:

Code

Font Color Font Size Close Tags

Forum BBCode Help

BBCode	Effect
[b]bolded text[/b]	bolded text
[i]italicized text[/i]	italicized text
[u]underlined text[/u]	underlined text
[s]strikethrough text[/s]	strikethrough text
[img]http://www.site.com/forum/images/forum.png[/img] OR [img h=65 w=50]http://www.site.com/forum/images/forum.png[/img]
[url=https://www.geeklog.net]Geeklog[/url]	Geeklog
[quote]quoted text[/quote]	To quote: quoted text
[size=15]Your Text[/size] "12" is usually standard on message boards. Usually measured in pixels (px).	Your Text
[color=red]Red Text[/color] OR [color=#FF0000]Red Text[/color] Can use many different color names or hex codes.	Red Text
[list] []List item 1 []List item 2 [/list] OR [list=1] []List item 1 []List item 2 [/list]	List item 1 List item 2 List item 1 List item 2
[code]monospaced text[/code]	monospaced text
[code=XYX]formatted code[/code] Where XYZ can be any of the following: c css html4strict java javascript jquery perl php plain python SQL and many more...	formatted code
To enter a backslash (\) in your post, use \\\\	\

Subject

[QUOTE][u]Quote by: lcox[/u][p]See:

<a href="http://www.mindfab.com/tutorials/GLDocExample.html">http://www.mindfab.com/tutorials/GLDocExample.html</a>

for an extremely crude example of using an outline based on OPML to point to documentation/stories that reside in GL itself.  It also has a link to what OPML looks like.  It can get more sophisticated by adding columns to an entry which become attributes to the xml tag for the item.

Three quick refinements to the concept are 1) frame-based - outline lives in left frame, content target in right and page turning nav in an upper above the content.  2) instead of a static outline as in this example, the outline is expandable/collapsable based on some of the OSS PHP tree code listed above.  We walk an OPML outline and generate the tree code  3) instead of pointing to the stories as rendered in GL itself, rip the GL db to render the story HTML as a standalone page this brings it back straight to using GL as the document repository and even authoring tool we all know and love.

The main point is that we can use GL as the core documentation repository and wrap it with some interesting tools/components to get good, navigable content using GL itself to do a lot of the work for us.  GL gives us a lot: templating, database repository, search, authoring.  Useful documentation can be generated in GL while the navigation wrapper tools come together.[/p][/QUOTE]

Options:

HTML Mode

Geeklog Forums

Search

Resources

About

Getting started

Support

Development

Topics

User Functions

What's New

Articles last 4 weeks

Comments last 4 weeks

Pages last 4 weeks

Links last 4 weeks

Downloads last 4 weeks