Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
TinyWiki has some lessons here. It was created to house Perl Design Patterns, so the end goal is a book-like document. Like a Wiki or like the Everything Engine, it is composed of nodes. The standard Wiki idiom of category membership was barrowed, to good effect. The original Wiki, Ward's Wiki uses this. Wiki automatically creates links at the mention of a known compound word, and Wiki will tell you all of the pages linking to a page. By linking to a category index, people may link back from that category index to everything that links to it.

TinyWiki has an assemble.cgi script that attaches all referenced nodes from one node to the end of that node. Essentially, the starting node is the table of contents for a book, or a chapter, or some other document. It has no role but to list which nodes, and in which order, nodes should compose a book.

Recent edits has proven critical for Wikis as well. TinyWiki's lists all nodes last edits. This lets maintainers work both directions - update the least recently edited nodes and the most recently edited nodes - to bring things up to date or refactor them, and to answer questions and check peoples editorial work.

Refactoring is important. It is vital. An old page that duplicates the contents of a newer page may have the newer page merged in, or it may be merged into the newer page. Things are transient in a Wiki. Nothing is permenant. People contribute knowing that eventually their ideas are just fodder for something larger. In terms of an information system, redundancy is bad.

Cross referencing. Each new node links to related nodes by mention of keywords, but it requires attention from people who know their way around the site to edit old and new nodes and improve this cross referencing. If nodes don't link to related nodes, navigation is impossible. I find browsing Wards Wiki a great way to pass time, but leaving the beaten path of the home page on PerlMonks, and you're instantly in no-mans land.

Mechanisms help the process, but ultimately it boils down to, as Ward puts it, careful attention to detail.

-scott

In reply to Node aging, document structure: lessions from TinyWiki by scrottie
in thread Lack of structure. Channeling structure by larsen

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others chilling in the Monastery: (6)
As of 2024-04-18 11:56 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found