I'm trying to keep the documentation concise by using a rather concise notation. It's pretty much consistent throughout the help system. As an example, here's the interpretation:
TAKES A PAGE NAME AND BREAKS IT DOWN TO A DISPLAY OF CLICKABLE LINKS UP IT'S HIERARCHY. PAGE NAME IS PAGE(POS1) OR DEFAULTS TO CURRENT PAGE. OTHER OPTIONAL PARAMETERS INCLUDE SEPARATOR (DEFAULT >) AND NAME=LINK OR NONE (DEFAULT TEXT) First sentence summarizes what it does. Then it summarizes the parameters page=some.page or some.page in position 1. If not supplied defaults to current page. separator=' >> ' means use >> instead of default > between the various links. Any position, but must be labeled. name=link (or none) tells what to do with the last part of the page name. By default it shows text but it can be linked or omitted completely. Any position, but must be labeled. The idea is, if you are not sure or something, you can see what parameters are available, and what options they allow. If you have suggestions for a different notation I'm open. I made them upper case long ago, because they stood out better in the code. And I didn't want to have to rewrite all of them for the new help system. But it's doable... Probably instead of (POS1) we could just as easily do (1) or (#1) or something. Maybe others have additional suggestions. Of course, the bigger problem is probably just trying to get people used to using the help system. It's quite nifty, if you remember to use it. I'm still trying to get into the habit of it. More often, I usually just open my code editor and look directly at the code. I almost never use the docs. Cheers, Dan On Fri, Feb 6, 2009 at 8:01 PM, Linly <[email protected]> wrote: > > Thanks Dan, it worked. > > From your answer, so I remember I've read ALL these three OPTIONAL > PARAMETERS at your new help system: > > http://www.boltwire.com/index.php?p=docs.help&help=Breadcrumb > > I've read it before, but I can't understand it. It tell me there are > three parameters, but I don't know how to use them. How to write, how > to use, put to where... As a copy-and-paste "BoltWire script" writer, > I need an exact code example to know where I can put and change the > parameter. Just like your answer here. > > The help system is great but I need more example code, not > explanation. An example is worth than a thousand words. :P > > Btw, the explanation use all upper case. It's really difficult to > read. > > Thank again. The more I "play" with BoltWire the more I admire and > appreciate your work and talent. > > Cheers, > linly > > On 2月7日, 上午1時43分, The Editor <[email protected]> wrote: >> Sure, put [(breadcrumb name=none)]. You can also do name=link if you >> wanted the final output to be a hyperlink. >> >> The default is name=text. >> >> Cheers, >> Dan >> >> On Fri, Feb 6, 2009 at 12:21 PM, Linly <[email protected]> wrote: >> >> > I have forced my skin to show page {title} in header, but there is >> > another {title} in [(breadcrumb)]. Therefor I have two {title} in one >> > page at the same time. Is it possible to omit the {title} part of the >> > [(breadcrumb)]? >> >> > Cheers, >> > linly > > > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "BoltWire" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/boltwire?hl=en -~----------~----~----~----~------~----~------~--~---
