scratchpad jdporter <table> <tr><th>[Sitedoclet]</th><th>[Referrer]</th></tr> <tr><td colspan=3><br><h4>[Superdoc]s other than Sections:</h4></td></tr> <tr><td>[Retrieving a forgotten username or password sitedoclet]</td><td>[Retrieving a forgotten username or password]</td></tr> <tr><td>[Voting/Experience System Sitedoclet]</td><td>[Voting/Experience System]</td></tr> <tr><td>[Recently Active Threads Faqlet sitedoclet]</td><td>[Recently Active Threads Faqlet]</td></tr> <tr><td>[Perl Monks Approved HTML tags sitedoclet]</td><td>[Perl Monks Approved HTML tags]</td></tr> <tr><td>[What XML generators are currently available on PerlMonks? sitedoclet]</td><td>[What XML generators are currently available on PerlMonks?]</td></tr> <tr><td>[The St. Larry Wall Shrine sitedoclet]</td><td>[The St. Larry Wall Shrine]</td></tr> <tr><td>[Add your code sitedoclet]</td><td>[Add your code]</td></tr> <tr><td>[Free Nodelet Settings sitedoclet]</td><td>[Free Nodelet Settings]</td></tr> <tr><td>[Nodelet Settings sitedoclet]</td><td>[Nodelet Settings]</td></tr> <tr><td>[Timezone Settings sitedoclet]</td><td>[Timezone Settings]</td></tr> <tr><td>[How to use the moderation system sitedoclet]</td><td>[How to use the moderation system]</td></tr> <tr><td>[Selected Best Nodes sitedoclet]</td><td>[Selected Best Nodes]</td></tr> <tr><td>[Best Nodes sitedoclet]</td><td>[Best Nodes]</td></tr> <tr><td>[Worst Nodes sitedoclet]</td><td>[Worst Nodes]</td></tr> <tr><td>[Login sitedoclet]</td><td>[Login]</td></tr> <tr><td>[Duplicate Post Warning sitedoclet]</td><td>[Duplicate Post Warning]</td></tr> <tr><td>[Message Outbox sitedoclet]</td><td>[Message Outbox]</td></tr> <tr><td>[Buy Stuff sitedoclet]</td><td>[Buy Stuff]</td></tr> <tr><td>[Signature Settings sitedoclet]</td><td>[Signature Settings]</td></tr> <tr><td>[Newest Nodes Settings sitedoclet]</td><td>[Newest Nodes Settings]</td></tr> <tr><td>[Ignored Users sitedoclet]</td><td>[Ignored Users]</td></tr> <tr><td>[Saints In Our Book sitedoclet]</td><td>[Saints In Our Book]</td></tr> <tr><td>[Personal Nodelet Settings sitedoclet]</td><td>[Personal Nodelet Settings]</td></tr> <tr><td>[Permission Denied sitedoclet]</td><td>[Permission Denied]</td></tr> <tr><td>[A hazy shade of winter sitedoclet]</td><td>[A hazy shade of winter]</td></tr> <tr><td>[Choosing a username]</td><td>[Create A New User]</td></tr> <tr><td colspan=3><br><h4>Sections and Section-like [superdoc]s:</h4></td></tr> <tr><td>[Tutorials sitedoclet]</td><td>[Tutorials]</td></tr> <tr><td>[Snippets Section sitedoclet]</td><td>[Snippets Section]</td></tr> <tr><td>[Perl Monks Discussion sitedoclet]</td><td>[Perl Monks Discussion]</td></tr> <tr><td>[Seekers of Perl Wisdom sitedoclet]</td><td>[Seekers of Perl Wisdom]</td></tr> <tr><td>[Meditations sitedoclet]</td><td>[Meditations]</td></tr> <tr><td>[Obfuscated code sitedoclet]</td><td>[Obfuscated code]</td></tr> <tr><td>[Reviews sitedoclet]</td><td>[Reviews]</td></tr> <tr><td>[Cool Uses for Perl sitedoclet]</td><td>[Cool Uses for Perl]</td></tr> <tr><td>[Perl News sitedoclet]</td><td>[Perl News]</td></tr> <tr><td>[Categorized Questions and Answers sitedoclet]</td><td>[Categorized Questions and Answers]</td></tr> <tr><td>[Code Catacombs sitedoclet]</td><td>[Code Catacombs]</td></tr> <tr><td>[Perl Poetry sitedoclet]</td><td>[Perl Poetry]</td></tr> <tr><td>[Book Reviews sitedoclet]</td><td>[Book Reviews]</td></tr> <tr><td>[Module Reviews sitedoclet]</td><td>[Module Reviews]</td></tr> <tr><td>[Nodes to consider sitedoclet]</td><td>[Nodes to consider]</td></tr> <tr><td>[Editor Requests sitedoclet]</td><td>[Editor Requests]</td></tr> <tr><td>[Inner Scriptorium sitedoclet]</td><td>[Inner Scriptorium]</td></tr> <tr><td>[Quests sitedoclet]</td><td>[Quests]</td></tr> <tr><td>[Past Polls sitedoclet]</td><td>[Past Polls]</td></tr> <tr><td>[The Monastery Gates sitedoclet]</td><td>[The Monastery Gates]</td></tr> <tr><td colspan=3><br><h4>[Nodelet]s:</h4></td></tr> <tr><td>[Information sitedoclet]</td><td>[Information]</td></tr> <tr><td>[Pedagogues Nodelet sitedoclet]</td><td>[Pedagogues Nodelet]</td></tr> <tr><td>[Pollsters' Nodelet sitedoclet]</td><td>[Pollsters' Nodelet]</td></tr> <tr><td>[Cabalists' Nodelet sitedoclet]</td><td>[Cabalists' Nodelet]</td></tr> <tr><td>[SiteDocClan Nodelet sitedoclet]</td><td>[SiteDocClan Nodelet]</td></tr> <tr><td>[QandAEditors Nodelet sitedoclet]</td><td>[QandAEditors Nodelet]</td></tr> <tr><td>[Leftovers sitedoclet]</td><td>[Leftovers]</td></tr> <tr><td>[Sections sitedoclet]</td><td>[Sections]</td></tr> <tr><td>[Settings Nodelet sitedoclet]</td><td>[Settings Nodelet]</td></tr> <tr><td>[Find Nodes sitedoclet]</td><td>[Find Nodes]</td></tr> <tr><td>[PmDev Nodelet sitedoclet]</td><td>[PmDev Nodelet]</td></tr> <tr><td colspan=3><br><h4>[htmlcode]s:</h4></td></tr> <tr><td>[showhints sitedoclet]</td><td>[showhints]</td></tr> <tr><td>[monktitlebar sitedoclet]</td><td>[monktitlebar]</td></tr> <tr><td colspan=3><br><h4>Unusual usages:</h4></td></tr> <tr><td>[Cabal Ticker]</td><td>stand-alone document</td></tr> <tr><td>[empty sitedoclet]</td><td colspan=2>Standalone. Because sometimes you just need an empty [sitedoclet].</td></tr> <tr><td>[New User Mail sitedoclet]</td><td colspan=2>not yet used; intended to replace [New User Mail] ([mail])</td></tr> <tr><td colspan=3><br> <i>All</i> of the above use their [sitedoclet] as the source of user-visible text; <br>that's the "normal" mode for [superdoc]s and [nodelet]s especially. <br>Keep that in mind when considering adding a [sitedoclet] for meta-doco. </td></tr> <tr><td colspan=3><br><h4>Meta-doco:</h4></td></tr> <tr><td>[fullpage print page sitedoclet]</td><td>[fullpage print page]</td><td>[htmlpage]</tr> <tr><td>[CanConsider sitedoclet]</td><td>[CanConsider]</td><td>[accessrule]</td></tr> <tr><td>[handlelinks settings sitedoclet]</td><td>[handlelinks settings]</td><td>[setting]</td></tr> <tr><td>[gettable fields sitedoclet]</td><td>[gettable fields]</td><td>[setting]</td></tr> <tr><td>[split_html sitedoclet]</td><td>[split_html]</td><td>[htmlcode]</td></tr> <tr><td>[expandfreenodelet sitedoclet]</td><td>[expandfreenodelet]</td><td>[htmlcode]</td></tr> </table> <hr> <ul> <li><small>2007-04-21</small> re: [id://611306] - We need a tut on packages! <li><small>2007-05-16</small> how about a monitor that alerts you when one of your nodes pops up in [id://328478] ! <li><small>2007-05-22</small> make a version of the site which simply uses css (classes & IDs) rather than hard-coding colors, etc., as [id://1064]s do. <li><small>2007-05-22</small> see the on-site <a href="?node_id=106927;whichtype=227668">css files</a> <li><small>2007-05-22</small> Note: [id://144936], by [Petruchio]</a> <li><small>2007-05-22</small> Note: [id://145860] <li><small>2007-05-25</small> [id://505895] <li><small>2007-07-17</small> [id://605813] defines a displaytype 'sourcetext' but it is not yet functional. work on this! (for [id://627112]) <li><small>2007-07-31</small> try to get PerlNews section posts FrontPageable, or investigate why they can't be. <li><small>2008-02-28</small> add a NN mode "raw", which simply lists NNs in chrono order - No sectioning, no sorting. <a href="?node_id=157620;searchterms=order_nn_by">search for 'order_nn_by'</a> <li><small>2008-04-11 [id://5348] said</small> [ad_and_talk] should be a [fullpage] <li><small>2008-04-16</small> [id://5771] needs to be eliminated! <li><small>2008-04-16</small> just the markup templates) <li><small>2008-04-21 [id://523944] said</small> add a submit button to the messages form in the [chatterbox sidebar]. i have to pull up a full PM page in order to mark msg's as read <li><small>2008-09-09</small> idea: a "forward" capability in [Message Inbox] <li><small>2008-09-11</small> re: [id://710739] - In fact, all the entry fields (bottom of each section, as well as CatQ/A, and replies/comments) need their supertitles revisited/revamped <li><small>2008-09-17</small> consider adding support for <a href="http://hobix.com/textile/">Textile</a> markup <li><small>2008-09-17</small> consider integrating <a href="http://tinymce.moxiecode.com/">TinyMCE</a> for wysiwyg posting <li><small>2008-10-07</small> give [id://16902] xml feed capability (and/or rss) <li><small>2009-01-08</small> mission from Petruchio: make all wikis consistent in using either p/hr or dl/dt/dd. Then put the warning/template OUTSIDE (above) the textarea <li><small>2009-01-08</small> other mission: make a section able to be accessed (r/w) only by a group; completely inaccessible to users outside the group. Optionally, readable by other groups in the cabal. <li><small>2009-01-08</small> then promote these for group discussions, vice the wikis. <li><small>2009-01-08</small> [c2://WikiModes] <li><small>2009-01-29 I told [id://9073]</small> Your [id://347416] has a number of replies suggesting additions/improvements but afaict you've ignored them. I'd like to get this converted into (i.e. reposted as) a [Tutorials|tutorial]. Perhaps now would be a good time to revisit those things? tia... <li><small>2009-01-29 [id://9073] said</small> hadn't ignored them... none of them really invalidate what i said.. just add to it. so I left the original in context (heh) <li><small>2009-01-29 [id://9073] said</small> sure... feel free to merge whatever you see, saying it was "inspired by the discussion at..." :) <li><small>2009-01-29 I told [id://9073]</small> yes, very good... for the original meditation. But if it gets reposted as a tutorial, it might be good to incorporate that stuff, so people aren't tempted to make the same responses again. <li><small>2009-02-05</small> [id://150940] - for finding and fixing broken root linkages in replies. <li><small>2009-02-05</small> [id://20162] - could use? link in wiki? <li><small>2009-02-05</small> [id://485787] - shows problems created by re-categorizing CatQ's! <li><small>2009-02-05</small> [id://741059] </a> <li><small>2009-02-05</small> after creation of [CanQAEdit], will want to patch [handle_node_edits]. <li><small>2009-02-05</small> after this patch - [id://741554] - is applied, will need to create a catqalist named "New Categorized Questions" <li><small>2009-02-05</small> integrate <a href="http://microformats.org/wiki/Main_Page">microformats</a>? <li><small>2009-02-23</small> re: [id://17245] - Flip so that bars are horizontal? Some users complain that the table is too wide. <li><small>2009-07-06</small> make a [toInbox]-like htmlcode for linking to NN with number of unread nodes! (if any) <li><small>2009-07-20</small> need to make [SuperSearch] search [sitedoclet]s &mdash; and map the hits back to the doc containing the sitedoclet. </ul> <hr/> <h3>datetime fields:</h3> <ul> <li> [id://112732].[href://?node_id=157620;searchterms=applied|applied] <li> [id://28873].[href://?node_id=157620;searchterms=considertime|considertime] <li> [id://53604].[href://?node_id=157620;searchterms=createtime|createtime] <li> [id://886].[href://?node_id=157620;searchterms=createtime|createtime] <li> [id://11173].[href://?node_id=157620;searchterms=createtime|createtime] <li> [id://31454].[href://?node_id=157620;searchterms=createtime|createtime] <li> [id://10156].[href://?node_id=157620;searchterms=date|date] <li> [id://61898].[href://?node_id=157620;searchterms=edittime|edittime] <li> [id://7488].[href://?node_id=157620;searchterms=endtime|endtime] <li> [id://1722].[href://?node_id=157620;searchterms=lasthit|lasthit] <li> [id://891].[href://?node_id=157620;searchterms=lasttime|lasttime]* <li> [id://16959].[href://?node_id=157620;searchterms=lastupdate|lastupdate]* <li> [id://21364].[href://?node_id=157620;searchterms=lastupdate|lastupdate]* <li> [id://3991].[href://?node_id=157620;searchterms=lastupdate|lastupdate]* <li> [id://891].[href://?node_id=157620;searchterms=lastupdate|lastupdate]* <li> [id://886].[href://?node_id=157620;searchterms=locktime|locktime] <li> [id://7488].[href://?node_id=157620;searchterms=starttime|starttime] <li> [id://16657].[href://?node_id=157620;searchterms=stattime|stattime] <li> [id://5770].[href://?node_id=157620;searchterms=votetime|votetime] </ul> <h4>*Collisions: Fields with name same as above but different type:</h4> <ul> <li> [id://489261].[href://?node_id=157620;searchterms=lasttime|lasttime] : timestamp <li> [id://772117].[href://?node_id=157620;searchterms=lastupdate|lastupdate] : timestamp <li> [id://490335].[href://?node_id=157620;searchterms=lastupdate|lastupdate] : timestamp <li> [id://888].[href://?node_id=157620;searchterms=lastupdate|lastupdate] : int(11) </ul> <hr/> <h3>How to move a [Categorized Question]:</h3> <p> <c>?node_id=761527;changegroup=1841</c> <br> The node_id value is the CatQ being moved; the changegroup value is the target [QandASection]. </p> <h3>How to delete a [Categorized Answer]:</h3> <p> <c>?node_id=761527;769649=delete</c> The node_id value is the CatQ which is the parent of the CatA to be deleted; the NAME of the delete parameter is the the CatA. </p> <hr/> <table border=0 cellspacing=0 cellpadding=2> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 15:29:45 UTC">jdporter</a>&#93;: <a href="?node_id=761006">usergroup display page - (patch)</a></td></tr> <tr><td>&#91;<a href="?node_id=518801" title="2009-04-30 15:33:54 UTC">Co-Rion</a>&#93;: The "go to inbox" part seems not to be working</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 15:36:10 UTC">tye</a>&#93;: Please don't add ubiquitous "send /msg to group" links. Please! ugh</td></tr> <tr><td>&#91;<a href="?node_id=5348" title="2009-04-30 15:38:03 UTC">Corion</a>&#93;: Why do you feel strongly against this? Do you think the /msg volume would go up unduely?</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 15:39:45 UTC">tye</a>&#93;: send a /msg to a group is one of the worst communication features of the site. we allow it for rare situations. <a href="?node=breathers%20of%20fire">breathers of fire</a> have no reasonable way to know that a /msg is waiting for them.</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 15:40:11 UTC">tye</a>&#93;: People should only be encouraged to /msg a group after the appropriate reasons to /msg that particular group are covered.</td></tr> <tr><td>&#91;<a href="?node_id=5348" title="2009-04-30 15:46:31 UTC">Corion</a>&#93;: <a href="?node=tye">tye</a>: Hmm - that's true, there are groups without ears</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 15:47:02 UTC">tye</a>&#93;: as I said yesterday when the first patch was discussed, such links should be sitedocclan work not patchwork</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:03:26 UTC">jdporter</a>&#93;: it appears, based on my cursory tests, that all groups do have an inbox, even the fraternal ones. So I don't see why a link to such inbox can't be shown on all group pages.</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:05:29 UTC">jdporter</a>&#93;: my thinking is that the group page could act a little more like a "home node" for the group.</td></tr> <tr><td>&#91;<a href="?node_id=299049" title="2009-04-30 16:05:42 UTC">ysth</a>&#93;: sure.</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:06:16 UTC">jdporter</a>&#93;: well, apparently not all the <a href="?node=gods">gods</a> agree.</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:06:32 UTC">jdporter</a>&#93;: but I haven't heard a persuasive argument.</td></tr> <tr><td>&#91;<a href="?node_id=299049" title="2009-04-30 16:07:16 UTC">ysth</a>&#93;: where was this discussed?</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:07:25 UTC">jdporter</a>&#93;: mostly in my absence. :-)</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:08:16 UTC">jdporter</a>&#93;: interestingly, none of it was posted as a response to the <a href="?node_id=761006">patch in question</a>.</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:08:34 UTC">jdporter</a>&#93;: <a href="?node_id=174180">SDC Wiki</a> has some context at the top.</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:09:16 UTC">tye</a>&#93;: yes, when people ask for feedback in the chatterbox, they get feedback in the chatterbox. twice. once by you, jdporter.</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:10:40 UTC">tye</a>&#93;: CB history has the second conversation. And so we still don't have a response to a patch, jdporter? your criticism doesn't apply to yourself? :D</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:12:44 UTC">tye</a>&#93;: replies are the best conversation method at the site. wikis are second worse. group inboxes are the worst of all. but I should probably /msg cabal about this instead of using the CB.</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:13:14 UTC">jdporter</a>&#93;: well, I wasn't exactly asking for feedback. I could just as likely have been asking for someone to apply it. :-)</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:13:31 UTC">tye</a>&#93;: the cabal inbox "exists", clearly I should be using it for something</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:13:59 UTC">jdporter</a>&#93;: otoh, "/msg gods" is better than "/msg chromatic".</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:15:04 UTC">tye</a>&#93;: um, /msg co-rion is obviously better when co-rion was the one who /msg'd you. let's design the site based on lame excuses of people trying to game the system and then pretend otherwise?</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:15:50 UTC">tye</a>&#93;: and <a href="?node=co-rion">co-rion</a> was already linked and the page linked already has a /msg co-rion link on it.</td></tr> <tr><td>&#91;<a href="?node_id=299049" title="2009-04-30 16:15:59 UTC">ysth</a>&#93;: phrased in the positive: inboxes work great for action requests</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:16:27 UTC">tye</a>&#93;: s/great/sometimes/</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:17:17 UTC">jdporter</a>&#93;: the extreme negativity toward "/msg" as a communication medium makes me wonder if maybe <a href="?node=SiteDocClan">we</a> shouldn't go through the docs and eliminate all references to that mechanism.</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:17:30 UTC">tye</a>&#93;: most of the "action request" in inboxes don't actually get fulfilled. it would be good to provide guidance about what type of "action request" might not be a waste of time before encouraging "/msg group"</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:18:17 UTC">tye</a>&#93;: all of the references to it that I've read note it as a last resort. We don't need to go black-and-white. If we want to go extreme, just eliminate the feature.</td></tr> <tr><td>&#91;<a href="?node_id=170442" title="2009-04-30 16:18:55 UTC">jdporter</a>&#93;: fair enough.</td></tr> <tr><td>&#91;<a href="?node_id=22609" title="2009-04-30 16:19:30 UTC">tye</a>&#93;: There are a few specific cases where "/msg group" is a reasonable last choice and perhaps once case where it is the only choice (or nearly so)</td></tr> </table> <hr/> [setting] nodes can have [sitedoclet]s!<br> Currently only one does: [handlelinks settings]. <hr/> <h2>How does node updating work? How does the edit history work?</h2> <p> When I asked the gods about this, [tye] said: </p> <blockquote> It is a global thing. Horrible security idea. Look where the settings for fields that can/can't be updated are applied. </blockquote> <p> He is referring to the [setting] nodes [id://1067] and [id://152999]. </p><p> These settings are only used in [id://165672], in the <tt>sub gotoNode</tt>. This sub only updates the node; it does <i>not</i> call any "RJE" (edithistory) related code. (See next) </p><p> The "RJE" functionality chain reads and updates the [edithistory] table. Updates are done via [id://481659], which is called <b>(1)</b> by the "edit" [htmlpage]s of the [sitefaqlet] and doclists/docstrings [nodetype]s. [id://481659] is also called <b>(2)</b> by [node editors page]. which is the "editors" [htmlpage] for [id://7]. </p><p> Wiki edits also cause entries in the [edithistory] table, but these are done <b>(3)</b> in the [wiki editpage], which is the [wiki] nodetype's "editpage" htmlpage. </p><p> So it's like this: <ol> <li> If you're in [SiteDocClan] and you edit a faqlet, faqlist, or faqstring, then [id://481659] is called by the corresponding "edit" htmlpage. Similarly, if you're in [Pedagogues] and you edit a tutlist or tutstring. </li> <li> If you're in [janitors] and you edit any node, then [id://481659] is called by the [node editors page|node editors] htmlpage. </li> <li> If you edit a wiki, then the edithistory is updated by [wiki editpage], the "edit" htmlpage for wikis. </li> </ol> Otherwise: the node is simply updated according to your submission, but some fields are restricted from being updateable in this way. </p> </hr> <h2>To create a new doclist derivative ([pmdev] only)</h2> <p> It's probably easiest to make a new [doclist] type by cloning an existing one, where possible. For this purpose, in the steps below, we'll clone from [tutlist], as it is more "normal" than [faqlist].<br> Cloning can only be done by [gods], so where the procedure says to clone, you'll have to ask a [gods|god] to do it if you're not one yourself.<br> Note that in all cases of cloning, replacing names and other values (e.g. group names) must be done meticulously! This aspect, however, can be done via ordinary patching, if not taken care of during cloning. </p><p> In the following example, we use "NEW" to represent the name of the new type family: <pre> ( NEWlist : NEWstring : NEWpost : NEWeds ) :: ( [tutlist] : [tutstring] : [perltutorial] : [Pedagogues] ) </pre> "NEW" is merely suggestive, and should not be substituted blindly. Use your intellect! </p> <ol> <li> Clone the source [doclist]-derived type, e.g. [tutlist], into <tt>NEWlist</tt>. </li> <li> Clone the associated [maintenance|maintenance create], e.g. [tutlist maintenance create], into <tt>NEWlist maintenance create</tt>. </li> <li> Clone the source [docstring]-derived type, e.g. [tutstring], into <tt>NEWstring</tt>. </li> <li> Clone the associated [maintenance|maintenance create], e.g. [tutstring maintenance create], into <tt>NEWstring maintenance create</tt>. </li> <li> Patch the [maintenance|maintenance create] of the user-postable type which your NEWlist is intended to hold (let's call it <tt>NEWpost</tt>) so that it inserts new posts into a special "holding pen" NEWlist, just as [perltutorial maintenance create] does. If <tt>NEWpost maintenance create</tt> does not yet exist, create it by cloning the [maintenance|maintenance create] of the source user-postable type, e.g. [perltutorial maintenance create] (editing meticulously, as always). </li> <li> Clone [CanPedagoguesEdit] into <tt>CanNEWedsEdit</tt> </li> <li> Patch [handle_node_edits] to account for the above. </li> <li> Patch [render_doclist_group], [doclist display page], [doclist edit page], and [Create a New User] to account for the new type in the same way they account for [tutlist], etc. </li> <li> Create a new instance of the <tt>NEWlist</tt> node type and name it "New NEWposts" (analogous to "New Tutorials"). The existence of this node is presupposed by the <tt>NEWpost maintenance create</tt> created/patched in Step 5. </li> <li> Add links in the appropriate place(s) &mdash; typically top of NEWeds's "how-to" wiki &mdash; to create a new instance of the type: <br> <code>/?op=new;displaytype=edit;type=NEWlist;node=available_NEWlist</code> </li> </ol> <b>Here's a draft plan:</b> <ol> <li> switch Q&A to use doclists ([catqalist]s) for organization (as above); </li> <li> add support for finding the "containing section" of a tutorial/catq at display time; </li> <li> cache this info; </li> <li> use it (link to it) at the top of catq's in place of the [QandAsection] link. Also add such a link to [perltutorial]s and [sitefaqlet]s! </li> <li> use it in [Super Search] as well, for determining whether a node is "in" the [Tutorials] section, or "in" the [Categorized Questions and Answers|CatQA] section, etc. </li> </ol> <hr> <h2>How Patching Works</h2> <p> Two things you need to know: </p> <ol> <li> A patch has two important fields: <ul> <li> The <c>'field'</c> field: indicates which field of the node to be patched will actually be modified by the patch.<ul> <li> For [htmlcode]s, this will be <c>'code'</c> </li> <li> For [htmlpage]s, this will be <c>'page'</c> </li> <li> For [setting]s, this will be <c>'vars'</c> </li> </ul></li> <li> The <c>'code'</c> field: contains the new version of the "code". This is true regardless of the type of the node being patched. </li> </ul> </li> <li> You can't dump the fields of a patch unless you own the patch. </li> </ol> <hr> <h2>Links to other views of the Current Node:</h2> <p>Put this in your [id://590089|Free Nodelet]:</p> <code> This node: &#91;id://`id`] [href://?node_id=3333;parent=`id`|replyto], [href://?node_id=`id`;displaytype=xml|xml], [href://?node_id=`id`;displaytype=raw|raw], [href://?node_id=`id`;displaytype=viewcode|code], [href://?node_id=`id`;displaytype=edit|edit], [href://bare/?node_id=`id`|bare], [http://prlmnks.org/rss/`id`.xml|rss], [href://?node_id=`id`;displaytype=edithistory;limit=25|rje], [href://?node=`title` sitedoclet|doclet], [href://?node_id=`parent_id`;displaytype=xml|parent as xml], [http://pmdev.flux8.com/?node_id=`id`|on DEV], [http://corion.net/perlmonks/`id`.xml|orig(xml)], <a href="`url`" id="page_url">url</a> </code> <hr/> <h2>Overriding the Level Requirement for Home Node Pics</h2> <p> As documented in [id://17639], the site restricts the ability to have a homenode pic to users of at least [id://198665]. This is implemented in accessule [id://493266] and manifested in [id://81] and [id://82]. </p><p> However, this [accessrule] also implements a trap door which lets specific, blessed individuals have a homenode pic even though they don't meet the minimum height requirement. This is documented in [id://11946], and refers to the settings [id://11923] (which should probably have been implemented as a [usergroup], not as a [setting]). </p><p> Apart from the original purpose of granting homenode pic amnesty to early cheaters, this is used to give certain [wp://non-player character]s a homenode pic, since it may be useful to their errand, though it involve no monk level attention. If you have a non-player character who you feel should have a home node image, you may request (via [/msg]) that the [gods] add it to the list. If you do, expect to get a lot of pushback. </p> <hr/> <h2>How to create a new node of arbitrary type</h2> <p> [pmdev]ils can't do it directly. We need to invoke the [gods]. <br> In essence, we ask them to make a new, empty node of the desired type, then we submit a patch to populate the node with its initial contents. Practically, these can be done in the same step. The traditional, preferred way to do this is to submit a patch against the special node<br> [id://218666].<br> (In actual fact, it doesn't matter what node the patch is submitted against. At the time of applying it, the [gods|god] will "re-direct" it to the new node you asked for, regardless of where it was originally.)<br> In addition to the desired node title and content, you must also communicate to the [gods] precisely which nodetype you desire for the new node. Therefore, it is recommended that the "reason" you give on the patch be formulated as follows:<br> <i>nodetype: exact node name</i><br> For example:<br> <tt>fullpage: node navigator ticker</tt> <p> It is also advisable, in most cases, to immediately reply to your patch with a comment explaining the rationale for the new node in more detail. <p> Note that when the new node has been created and the patch applied to it, the patch will no longer be listed under [id://218666] and will be listed under the new node (when viewing its code). <p> To see what happens, look at this patch I wrote: [id://621873].<br> I originally wrote it against [href://?node_id=481723;displaytype=viewcode|unused fullpage], but it was applied against the new node, [href://?node_id=693598;displaytype=viewcode|node navigator ticker].<br> You can see the patch listed under the latter, but not under the former. The patch's title (not reason) still suggests that it was written against the former. That's a little confusing, but ultimately immaterial. <hr/> <h2><tt>displaytype</tt>s</h2> <p> You know you can select a displaytype other than the default by adding <tt>;displaytype=<i>type</i></tt> to the URL. For example, to get the XML view of a post, add <tt>;displaytype=xml</tt>. </p><p> Where are these types defined and implemented? What displaytypes are available for any given nodetype? </p><p> To find what displaytypes are defined for a nodetype, simply go to that nodetype's definition page and look at the list under <b>Relevant pages</b>. For example, see the definition of the [id://11] nodetype. The first column is the name of the displaytype (e.g. <tt>xml</tt>, <tt>edit</tt>, <tt>print</tt>, and so on) and on the right is the corresponding [id://5] which implements the displaytype. The htmlpage naming scheme, which is a convention from Everything, is "<tt><i>nodetype</i>&nbsp;<i>displaytype</i>&nbsp;page</tt>". See the [href://?node_id=106927;whichtype=5|full list of htmlpage]s. </p> <p> Note that [id://5] is a node type, with its own database table. One of the fields in the [id://881] table is <b>pagetype_nodetype</b>. This points to exactly one of the many [id://386578|node types]. This htmlpage can be applied to (used on) that node type or any of its derivatives, down to the point where it is overridden by a subtype. To see the value of this field for a given htmlpage, view the htmlpage's page. E.g. [id://180958] shows <b>pagetype</b>:&nbsp;[id://7], while [id://1603] shows <b>pagetype</b>:&nbsp;[id://1588]. </p> <p> To define a new displaytype, you'll need to create the corresponding [id://5]. See &rArr;[http://everydevel.com/index.pl?node_id=242|Creating a display htmlpage]. </p><p> It is definitely best to request cloning of an existing [htmlpage], because several fields have to be set by things you can't touch via a patch, such as <b>pagetype</b> and <b>displaytype.</b> Be sure to state in your supplication what the new value of these fields should be. </p><p> To see where these things are used, look at <c>sub getPageForType</c> in [Everything/HTML.pm]. </p> <hr/> <a name="dbtables"></a> <h2>Not All Database Tables are Used Directly in Node Type Definitions</h2> <p> There are 79 [dbtable]s, in total.<br/> 31 tables are used by [nodetype]s.<br/> 48 tables are <b>not</b> used by nodetypes. </p><table> <tr><th>dbtables used by nodetypes:</th><th>other dbtables:</th></tr> <tr><td>[id://930]</td><td>[id://2065]</td></tr> <tr><td>[id://879]</td><td>[id://393764]</td></tr> <tr><td>[id://18505]</td><td>[id://499694]</td></tr> <tr><td>[id://108653]</td><td>[id://499696]</td></tr> <tr><td>[id://878]</td><td>[id://177275]</td></tr> <tr><td>[id://14555]</td><td>[id://298587]</td></tr> <tr><td>[id://880]</td><td>[id://16959]</td></tr> <tr><td>[id://881]</td><td>[id://21364]</td></tr> <tr><td>[id://882]</td><td>[id://511893]</td></tr> <tr><td>[id://118396]</td><td>[id://28873]</td></tr> <tr><td>[id://884]</td><td>[id://50969]</td></tr> <tr><td>[id://885]</td><td>[id://10156]</td></tr> <tr><td>[id://888]</td><td>[id://182337]</td></tr> <tr><td>[id://889]</td><td>[id://448676]</td></tr> <tr><td>[id://935]</td><td>[id://323939]</td></tr> <tr><td>[id://112732]</td><td>[id://323937]</td></tr> <tr><td>[id://232665]</td><td>[id://323938]</td></tr> <tr><td>[id://1445]</td><td>[id://61898]</td></tr> <tr><td>[id://7488]</td><td>[id://81029]</td></tr> <tr><td>[id://152615]</td><td>[id://28938]</td></tr> <tr><td>[id://405890]</td><td>[id://175026]</td></tr> <tr><td>[id://31664]</td><td>[id://175027]</td></tr> <tr><td>[id://294548]</td><td>[id://17754]</td></tr> <tr><td>[id://890]</td><td>[id://883]</td></tr> <tr><td>[id://1981]</td><td>[id://5134]</td></tr> <tr><td>[id://1749]</td><td>[id://489261]</td></tr> <tr><td>[id://1057]</td><td>[id://11838]</td></tr> <tr><td>[id://517550]</td><td>[id://886]</td></tr> <tr><td>[id://1059]</td><td>[id://887]</td></tr> <tr><td>[id://891]</td><td>[id://208184]</td></tr> <tr><td>[id://72218]</td><td>[id://404234]</td></tr> <tr><td></td><td>[id://11173]</td></tr> <tr><td></td><td>[id://23615]</td></tr> <tr><td></td><td>[id://328452]</td></tr> <tr><td></td><td>[id://1478]</td></tr> <tr><td></td><td>[id://490335]</td></tr> <tr><td></td><td>[id://53604]</td></tr> <tr><td></td><td>[id://1722]</td></tr> <tr><td></td><td>[id://1858]</td></tr> <tr><td></td><td>[id://11178]</td></tr> <tr><td></td><td>[id://3990]</td></tr> <tr><td></td><td>[id://3991]</td></tr> <tr><td></td><td>[id://16657]</td></tr> <tr><td></td><td>[id://524789]</td></tr> <tr><td></td><td>[id://31454]</td></tr> <tr><td></td><td>[id://276370]</td></tr> <tr><td></td><td>[id://253077]</td></tr> <tr><td></td><td>[id://5770]</td></tr> </table> <hr/> <h2>Hint on Patching Strange Nodetypes</h2> <p> When you view nodes of certain types (such as [id://227668]; example: [id://204962]), they're shown as "raw" data, with no containers or other usual PerlMonks decorations. Suppose you wanted to patch such a thing. How can you get to that function? </p><p> Try adding <c>;displaytype=viewcode</c> to the URL, e.g. <tt>[href://?node_id=204962;displaytype=viewcode|/?node_id=204962;displaytype=viewcode]</tt> </p><p> The other thing you can do is go to [id://106927], and filter for the type you're interested in (e.g. [href://?node_id=106927;whichtype=227668|list nodes of type 'css']). Next to each node listed is a 'viewcode' link. <hr/> <h2><tt>VARS</tt></h2> <p> The <b><tt>VARS</tt></b> hash: What is it? Where does it come from? </p><p> <b><c>VARS</c></b> is actually a hashref. By default, it is loaded at page load time from data associated with the current user (you). (Look for <tt>[href://?searchterms=confirmUser&setsic_dogrep=1&clrsic_dogrep=1&setsic_or_terms=0&clrsic_or_terms=1&node_id=157620&sexisgood=submit|sub confirmUser]</tt>) </p><p> The function that actually loads a "vars" hash for a given node is <tt>[href://?searchterms=confirmUser&setsic_dogrep=1&clrsic_dogrep=1&setsic_or_terms=0&clrsic_or_terms=1&node_id=157620&sexisgood=submit|sub getVars]</tt>. The node must already have been loaded into memory. It looks for data in the <tt>'vars'</tt> field of the node. For there to be a <tt>'vars'</tt> field, the node must be of a nodetype which has a <tt>'vars'</tt> database field. Only one db table has a field named <tt>'vars'</tt>: [id://890]. </p><p> But wait - [id://15] isn't a [id://871] node! Is it? </p><p> Yes, it is! If you take a look at the definition of the [id://15] nodetype, you'll see it actually joins three different db tables: [id://891], [id://890], and [id://878]. </p><p> Although <c>$VARS</c> is loaded automatically for the current user, htmlcode can get the "vars" for any user. For example: <code> $num_writeups = getVars( getNode($user_id) )->{numwriteups}; </code> </p><p> So you're probably wondering: What other nodetypes might have "vars" (besides, obviously, [id://871]) by virtue of joining the [id://890] db table? There are a few (scan [id://386578]), but an interesting one (IMHO) is [doclist], or rather, its two subtypes, [faqlist] and [tutlist]. </p> <hr/> <h2>Usage of <c>%HTMLVARS</c></h2> <p> See the [id://461491] for an explanation of what <c>%HTMLVARS</c> is for. </p><p> <c>%HTMLVARS</c> is loaded by [Everything/HTML.pm] using [id://49]. It loads the data from <b>[id://916]</b>. (It also reads the contents of <b>[id://84]</b>, but this data is dropped into the bit bucket.) <hr/> <a name="pmdev_tips"></a> <h2>Tips for the new [PmDev]il</h2> <p> The [pmdev] group is actually one of the <i>safest</i> groups to be in, in terms of being able to commit destruction to the site. That's because the only thing you can do is write patches: unless/until a [gods|god] applies the patch, it has zero effect. </p><p> The [http://everydevel.com/index.pl?node=Everything Documentation Index|Everything] structure is pretty complicated, to be sure. To gain familiarity with it, you pretty much just have to keep slogging through nodes, through code, manually tracing function calls. The wall I hit is about the database and various related things that are still opaque to [pmdev]ils. </p> <h4>How should a new [pmdev]il get started?</h4> <p> The very first thing to do is [Nodelet Settings|enable] the PmDev Nodelet, of course. That should almost go without saying. I would also enable the Cabalists Nodelet, if you haven't done so already. </p><p> The various [pmdev] wikis are good resource, of course. You should read at least these: <ul> <li> [id://106868] </li> <li> [id://222493] </li> <li> [id://461491] </li> </ul> </p><p> It's really essential to understand about node types. You can start at [id://386578] (linked in the PmDev Nodelet as "Types") and browse around. Also check out "chromatic's library" (linked in the PmDev Nodelet); it has more info than you'll ever need, but the first five links in the list are essential. (<i>Update:</i> everydevel.com is now gone. But the contents are preserved in the Wayback Machine.) </p><p> Many types of nodes are patchable. Primarily there is [htmlcode]; it's the real workhorse nodetype, essentially a subroutine in the Everything framework. There are several other code-like and template-like nodetypes. Then there's [id://871]s, which are data tables. So choose some of these, read the code, and read some of the patches people have written against them. For a (not quite random) example, go to [id://131] and click on the 'code' link. You see the code formatted with line numbers, then the code in a text edit box, and then a table of all the node's patches. (Btw... when you're viewing a nodetype, either on its own display page or within the [Type Tree], it has a link to a listing of all of the nodes of that type. That is <i>very</i> handy, in my experience.) </p><p> As you browse around the code and start to get familiar with perlmonks' workings, you'll encounter certain basic subroutines time and again. In most cases, such subroutines are defined in nodes of the same name. For example, [parseCodeInString]. Nodelets are defined this way as well &mdash; for example, [PmDev Nodelet]. So, as a first resort, you can type/paste the name of the sub you're curious about into the Search box. </p><p> Failing that, you can use the [id://157620] tool (linked in the PmDev Nodelet as "Search code"). This tool is truly your friend. </p><p> You'll eventually discover that some of the code that runs the site is not in patchable nodes. I'm referring to [id://118397] nodes (see near the bottom of the [id://386578] page). Most important is [id://165672]. <!-- Everything/HTML.pm --> Many of the most fundamental functions that you encounter in pm code are defined there. You'd do well to be familiar with it. E.g. say you're trying to find the definition of sub linkNode. There's no linkNode node! That's because it's defined in Everything/HTML.pm. ([id://157620] would find it there, but many other places besides.) </p> <h3>pmdev notes</h3> <p> Some node types are ultimately just html. With templating features, of course.<br/> The node types in this category include [superdoc], [fullpage], and [htmlpage]. <br/> Note that [superdoc] and [fullpage] are sub-nodetypes of [document]. <br/> ([document], [htmlpage], and [htmlcode] are not related. That is, their closest common ancestor is [node].) </p><p> The templating syntax uses three flavors, all based on square brackets: <ul> <li> <c>["perl string"]</c> evaluates simply to the given string. It's a perl string literal, so it does interpolation of variables etc. </li> <li> <c>[{code_call}]</c> or <c>[{code_call:arg1,arg2}]</c> evaluates to the result of calling the code contained in the [htmlcode] node named <c>code_call</c>. </li> <li> <c>[% full perl code here %]</c> evaluates to whatever the given perl code evaluates to. </li> </ul> In each case, the square-bracketed expression is replaced in the html with the string resulting from its evaluation. </p><p> Here's a node which happens to use all three: [id://113501] </p> <p> Nodes of type [htmlcode] contain straight perl code, <i>not</i> html. <br/> Sub-nodetypes of [htmlcode] are [opcode], [patch], and [accessrule].<br/> </p> <a name="add_user_setting"></a> <h4>How To Add a User Setting</h4> <p> It's really not complicated: <ol> <li> Make up a name for the new variable. E.g. <c>show_id_on_note</c>.</li> <li> Decide which type of variable it should be, e.g. <c>checkvar</c> is a boolean, which gets rendered as a checkbox. </li> <li> In [Display Settings] (for example), add something like <tt>&#91;{[checkvar]:show_id_on_note}]</tt> </li> <li> Use it in node code as an element of %VARS. E.g. <c> ( $VARS->{show_id_on_note} ? " [id://$NOTE->{node_id}]" : "") </c> </li> </ol> (The example above is taken from [id://581735] and [id://581731].) </p> <p> The available [htmlcode]s for form input elements are: <ul> <li> checkbox = <tt>&#91;{[checkvar]:<i>varname</i>}]</tt> </li> <li> text field = <tt>&#91;{[setvar]:<i>varname</i>}]</tt> </li> <li> text area = <tt>&#91;{[setvararea]:<i>varname</i>}]</tt> </li> <li> menu = <tt>&#91;{[listVarMenu]:<i>varname</i>}]</tt> </li> </ul> See each one's code for a description of optional arguments. </p><p> (Note: &#91;{[varmenu]}] is not a general-purpose form input widget; ignore it for now.) </p> <a name="embed_sitedoclets"></a> <h4>How to embed a [sitedoclet] in another node</h4> <p> An example can be seen in the code of [id://101], which embeds [id://156912]. </p><p> The basic formulas are as follows. </p><p> For embedding in the template types ([superdoc], [fullpage], [htmlpage]) &mdash; <code> [{get_sitedoclet}] # use default doclet selection [{get_sitedoclet:Choosing a username}] # select specific doclet </code> For embedding in Perl code, e.g. within <c>[%....%]</c> blocks and in [htmlcode] nodes &mdash; <code> $html .= htmlcode('get_sitedoclet',...); </code> </p><p> [id://370014] is quite flexible. Read its code, which has embedded doco. </p><p> Note that the [id://370014] doco also includes critical information on the <i>formatting</i> of [sitedoclet]s, which [SiteDocClan] will find highly pertinent! </p><p> If the first arg (the sitedoclet node title) to [id://370014] is omitted (i.e. false), a default title of "<i>Foo</i> sitedoclet" is used, where "<i>Foo</i>" is the title of the node being rendered, i.e. the node in which the [sitedoclet] is being embedded. </p><p> Also, it appears that the first arg can be a node ID instead, since <tt>getNode</tt> has been enhanced to defer to <tt>getNodeById</tt> if the title given is a string of digits. </p><p> Another htmlcode you can use instead of [get_sitedoclet] is [showsitedoclet].<br> [showsitedoclet] differs from [get_sitedoclet] only in that it adds some "decoration" to the rendered doclet: If the user is in [SiteDocClan], it adds an "Edit" link (or a link to create the doclet if it does not yet exist); if the user is not in [SiteDocClan] and there is no doclet, a "no such sitedoclet" message is inserted at the top.<br> Currently this is only used in two spots: in [usergroup display page|displaying usergroups] and in [accessrule display page|displaying accessrules]. Because of the rather annoying message shown to Poor Ol' Monks when there is a missing sitedoclet, use of [showsitedoclet] should probably be carefully considered. </p> <h4>How to control user access to a node?</h4> <p> You make the following call, which returns a boolean: <code> Everthing::isApproved( $USER, $AccessControl ); </code> Where <c>$AccessControl</c> is the ID of either a [usergroup] or an [accessrule]. If it's a [usergroup], <c>isApproved</c> will return true if the user is in the group. If it's an [accessrule], <c>isApproved</c> will return whatever the [accessrule] returns. An [accessrule] contains an arbitrary chunk of perl code (rather like an [htmlcode]) which should return a boolean. See the existing [accessrule]s for an idea. </p><p> <c>isApproved</c> is defined in [id://165673]. </p> <h4>Generating XML</h4> <p> The function to use is [new_xml_fling] ([href://?node_id=157620;searchterms=new_xml_fling|uses]). This supercedes [href://?node_id=157620;searchterms=XML%3A%3AFling|XML::Fling] (defined in [id://165689]) which is still in use in a significant number of nodes. Note that XML::Fling itself is not going away; [new_xml_fling] calls it! </p> <p> Observe that the current uses of [new_xml_fling] are either in [fullpage] nodes, which generally have "xml&nbsp;generator" or "xml&nbsp;ticker" in the name, or in [htmlcode] nodes, which means it's being wrapped in another function. </p> <h4>pmdev links</h4> <p> Mentioned in [id://403447]. </p><code>[pmdev://TARGET|pmdevTEXT|othersTEXT]</code><p> For [pmdev]ils, the pmdevTEXT is displayed, and links to the given target. For everyone else, the othersTEXT is displayed, and is not a link. </p><p> e.g. </p><p> <code>[pmdev://42|secret magic node|Poor muggle]</code> = [pmdev://42|secret magic node|Poor muggle] </p><p> [demerphq] <i><small>in the cb, on 2005-10-25</small></i> saith:<br/> so <c>[pmdev://14]</c> will show a link to pmdevils, and just text <c>[pmdev://14]</c> for everybody else.<br/> <c>[pmdev://foo|bar|baz]</c> acts like <c>[foo|bar]</c> for pmdevils and as simply <c>baz</c> for non pmdevils.<br/> the original reason was i wanted links to source code on the xml ticker list. but i didnt want normal users to see links that would lead them to a tough beans. its use in chatter was just a bonus.<br/> </p><p> </p> <h4>The basic page framework</h4> <p> ...<i>information lost!</i>...