Enrique Vega wrote:
> The first is to simply add better examples to some of the functions. For
> instance the function mgd_list_topics at:
>
> http://www.midgard-project.org/req/midgard-1.4/mgd-list-topics.htm
>
> shows an example:
>
> <?php
> $lst = mgd_list_topics(17);
> if(!$lst) {
> echo "mgd_list_topics(17) failed.<br>";
> echo "reason: " . mgd_errstr();
> }else{
> while($lst->fetch()){
> echo $lst->name . "<br>\n";
> }
> }
> ?>
>
> But if someone could add the code which would display a link instead of a
> simple name, then the web developer could simply copy and paste it into an
> element to their page. (hint, hint, please...)
A link to what? There's no canonical URL to an object unless it's a
page.
> BTW, mgd_list_topics really displays sub-topics and not topics. I could not
> find a function which would display all topics. Is there such a thing?
mgd_list_topics(0);
> As I said earlier, we can simply add better examples to the existing manual
> via annotations, or we can start from ground zero and create a how-to manual
> for building a dynamic web site.
The annotations were meant to be semi-temporary. What we had planned is
to integrate
useful annotations to the manual itself. We haven't found the time so
far. What we
did find out in a hurry is that writing a manual is a very difficult and
often
frustrating process. A lot more difficult then, random choice here,
coding for
example.
> I guess what I am trying to say is that if I was to try to do a how-to by
> myself, that it would not get done. So, the question is whether someone with
> programming experience desires to get involved with me in creating a how-to
> manual that details the necessary elements of building a dynamic web site.
It's not expected of anyone to get this done in isolation. It's
impossible to get
right in that case, and mark that goes both ways: if a developer writes
user
dox in isolation they could well be technically correct but still
utterly
useless to the actual intended audience.
I've said it (a long time) before: anyone who wants to help with
documentation
has me on call darn near 24/7. Yes, that totally means that if your
needs
coincide with a documentation project there's a chance to get your own
goals achieved better and faster by having me jump through hoops to get
your problem solved. The trade-off is worth it to me. For me it's the
best way to contribute to the dox themselves since I totally suck at
writing
them. I can't think in your domain well enough, so I need the help.
> The basics of building a dynamic web site should start with developing a
> standard set of navigation tools. These tools or "elements" need to address
> links between pages, topics, sub-topics, and articles. I don't believe we
> need to go into style or page layout at this time. I think that most web
> developers already know enough about html that they can wing it. The need is
> to have a simple way to link pages, topics, and articles.
The above is still a bit too vague for me. Navigation how? In what way
would these tools link pages/topics/etc together, what information
would you roughly expect to feed into this, and what, roughly, would
you expect to see returned?
Emile
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
