oops

[git.ikiwiki.info.git] / doc / todo / structured_page_data.mdwn

diff --git a/doc/todo/structured_page_data.mdwn b/doc/todo/structured_page_data.mdwn
index 2a196ed23b642beff60314b51164a3ac3a300465..9f21fab7fa6488b53cb0e5f8b8d918724bd6e475 100644 (file)
--- a/doc/todo/structured_page_data.mdwn
+++ b/doc/todo/structured_page_data.mdwn
@@ -1,5 +1,7 @@
 This is an idea from [[JoshTriplett]].  --[[Joey]]
 
 This is an idea from [[JoshTriplett]].  --[[Joey]]
 

+* See further discussion at [[forum/an_alternative_approach_to_structured_data]].
+

 Some uses of ikiwiki, such as for a bug-tracking system (BTS), move a bit away from the wiki end
 of the spectrum, and toward storing structured data about a page or instead
 of a page. 
 Some uses of ikiwiki, such as for a bug-tracking system (BTS), move a bit away from the wiki end
 of the spectrum, and toward storing structured data about a page or instead
 of a page. 


@@ -82,6 +84,10 @@ See also:
 >    rather than all pages linked from a given page.
 >
 >The first use case is handled by having a template in the page creation.  You could
 >    rather than all pages linked from a given page.
 >
 >The first use case is handled by having a template in the page creation.  You could

+
+
+
+

 >have some type of form to edit the data, but that's just sugar on top of the template.
 >If you were going to have a web form to edit the data, I can imagine a few ways to do it:
 >
 >have some type of form to edit the data, but that's just sugar on top of the template.
 >If you were going to have a web form to edit the data, I can imagine a few ways to do it:
 >


@@ -243,8 +249,12 @@ in a large number of other cases.
 
 > would match `data_eq(Depends on,6)`, `data_link(Depends on,bugs/bugA)`, `data_link(Depends on,bugs/bugB)`
 > or, if you applied the patch in [[todo/tracking_bugs_with_dependencies]] then you can use 'defined pagespecs'
 
 > would match `data_eq(Depends on,6)`, `data_link(Depends on,bugs/bugA)`, `data_link(Depends on,bugs/bugB)`
 > or, if you applied the patch in [[todo/tracking_bugs_with_dependencies]] then you can use 'defined pagespecs'

-> such as `data_link(Depends on,~openBugs)`.  The ability to label links like this allows separation of
+> such as `data_link(Depends on,~openBugs)`. <a id="another_kind_of_links" />The ability to label links like this allows separation of

 > dependencies between bugs from arbitrary links.
 > dependencies between bugs from arbitrary links.

+>> This issue (the need for distinguished kinds of links) has also been brought up in other discussions: [[tracking_bugs_with_dependencies#another_kind_of_links]] (deps vs. links) and [[tag_pagespec_function]] (tags vs. links). --Ivan Z.
+
+>>> And multiple link types are now supported; plugins can set the link
+>>> type when registering a link, and pagespec functions can match on them. --[[Joey]] 

 
 ----
 
 
 ----
 


@@ -257,21 +267,21 @@ in a large number of other cases.
     use CGI::FormBuilder;
     use IkiWiki 2.00;
     
     use CGI::FormBuilder;
     use IkiWiki 2.00;
     

-    sub import { #{{{
+    sub import {

        hook(type => "getsetup", id => "form", call => \&getsetup);
        hook(type => "htmlize", id => "form", call => \&htmlize);
        hook(type => "sessioncgi", id => "form", call => \&cgi_submit);
        hook(type => "getsetup", id => "form", call => \&getsetup);
        hook(type => "htmlize", id => "form", call => \&htmlize);
        hook(type => "sessioncgi", id => "form", call => \&cgi_submit);

-    } # }}}
+    }

     
     

-    sub getsetup () { #{{{
+    sub getsetup () {

        return
                plugin => {
                        safe => 1,
                        rebuild => 1, # format plugin
                },
        return
                plugin => {
                        safe => 1,
                        rebuild => 1, # format plugin
                },

-    } #}}}
+    }

     
     

-    sub makeFormFromYAML ($$$) { #{{{
+    sub makeFormFromYAML ($$$) {

        my $page = shift;
        my $YAMLString = shift;
        my $q = shift;
        my $page = shift;
        my $YAMLString = shift;
        my $q = shift;


@@ -350,9 +360,9 @@ in a large number of other cases.
        # IkiWiki::decode_form_utf8($form);
        
        return $form;
        # IkiWiki::decode_form_utf8($form);
        
        return $form;

-    } #}}}
+    }

     
     

-    sub htmlize (@) { #{{{
+    sub htmlize (@) {

        my %params=@_;
        my $content = $params{content};
        my $page = $params{page};
        my %params=@_;
        my $content = $params{content};
        my $page = $params{page};


@@ -360,9 +370,9 @@ in a large number of other cases.
        my $form = makeFormFromYAML($page, $content, undef);
     
        return $form->render(submit => 'Update Form');
        my $form = makeFormFromYAML($page, $content, undef);
     
        return $form->render(submit => 'Update Form');

-    } # }}}
+    }

     
     

-    sub cgi_submit ($$) { #{{{
+    sub cgi_submit ($$) {

        my $q=shift;
        my $session=shift;
        
        my $q=shift;
        my $session=shift;
        


@@ -425,11 +435,11 @@ in a large number of other cases.
        }
     
        exit;
        }
     
        exit;

-    } #}}}
+    }

     
     package IkiWiki::PageSpec;
     
     
     package IkiWiki::PageSpec;
     

-    sub match_form_eq ($$;@) { #{{{
+    sub match_form_eq ($$;@) {

        my $page=shift;
        my $argSet=shift;
        my @args=split(/,/, $argSet);
        my $page=shift;
        my $argSet=shift;
        my @args=split(/,/, $argSet);


@@ -460,7 +470,7 @@ in a large number of other cases.
        } else {
                return IkiWiki::FailReason->new("field value does not match");
        }
        } else {
                return IkiWiki::FailReason->new("field value does not match");
        }

-    } #}}}
+    }

     
     1
 
     
     1
 


@@ -476,22 +486,22 @@ in a large number of other cases.
     
     my $inTable = 0;
     
     
     my $inTable = 0;
     

-    sub import { #{{{
+    sub import {

        hook(type => "getsetup", id => "data", call => \&getsetup);
        hook(type => "needsbuild", id => "data", call => \&needsbuild);
        hook(type => "preprocess", id => "data", call => \&preprocess, scan => 1);
        hook(type => "preprocess", id => "datatable", call => \&preprocess_table, scan => 1);   # does this need scan?
        hook(type => "getsetup", id => "data", call => \&getsetup);
        hook(type => "needsbuild", id => "data", call => \&needsbuild);
        hook(type => "preprocess", id => "data", call => \&preprocess, scan => 1);
        hook(type => "preprocess", id => "datatable", call => \&preprocess_table, scan => 1);   # does this need scan?

-    } # }}}
+    }

     
     

-    sub getsetup () { #{{{
+    sub getsetup () {

        return
                plugin => {
                        safe => 1,
                        rebuild => 1, # format plugin
                },
        return
                plugin => {
                        safe => 1,
                        rebuild => 1, # format plugin
                },

-    } #}}}
+    }

     
     

-    sub needsbuild (@) { #{{{
+    sub needsbuild (@) {

        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{data}) {
        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{data}) {


@@ -506,7 +516,7 @@ in a large number of other cases.
        }
     }
     
        }
     }
     

-    sub preprocess (@) { #{{{
+    sub preprocess (@) {

        my @argslist = @_;
        my %params=@argslist;
        
        my @argslist = @_;
        my %params=@argslist;
        


@@ -546,9 +556,9 @@ in a large number of other cases.
        }
        
        return $html;
        }
        
        return $html;

-    } # }}}
+    }

     
     

-    sub preprocess_table (@) { #{{{
+    sub preprocess_table (@) {

        my %params=@_;
     
        my @lines;
        my %params=@_;
     
        my @lines;


@@ -568,11 +578,11 @@ in a large number of other cases.
        push @lines, '</table>';
     
        return join("\n", @lines);
        push @lines, '</table>';
     
        return join("\n", @lines);

-    } #}}}
+    }

     
     package IkiWiki::PageSpec;
     
     
     package IkiWiki::PageSpec;
     

-    sub match_data_eq ($$;@) { #{{{
+    sub match_data_eq ($$;@) {

        my $page=shift;
        my $argSet=shift;
        my @args=split(/,/, $argSet);
        my $page=shift;
        my $argSet=shift;
        my @args=split(/,/, $argSet);


@@ -592,9 +602,9 @@ in a large number of other cases.
        } else {
                return IkiWiki::FailReason->new("value does not match");
        }
        } else {
                return IkiWiki::FailReason->new("value does not match");
        }

-    } #}}}
+    }

     
     

-    sub match_data_link ($$;@) { #{{{
+    sub match_data_link ($$;@) {

        my $page=shift;
        my $argSet=shift;
        my @params=@_;
        my $page=shift;
        my $argSet=shift;
        my @params=@_;


@@ -618,6 +628,6 @@ in a large number of other cases.
        }
     
        return IkiWiki::FailReason->new("No data link on page $page with key $key matches glob $value");
        }
     
        return IkiWiki::FailReason->new("No data link on page $page with key $key matches glob $value");

-    } #}}}
+    }

     
     1
     
     1