On Tue, Oct 28, 2008 at 8:22 AM, Computist <[EMAIL PROTECTED]> wrote: > > On Oct 28, 2:01 pm, "alinome.net" <[EMAIL PROTECTED]> wrote: >> I started reorganizing and updating the docs on variables. I splitted >> the table to allow clear sections with detailed intros. The skin >> variables are added. >> >> http://boltwire.com/index.php?p=docs.index.variables > > This comment is not strictly related to this, but I think the docs > could benefit from more use of > > (1) numbered lists (to specify stepwise Howto descriptions) > (2) use of <code>, <samp>, <kbd> and other HTML codes to single > out normal descriptive text from code text etc. Currently, one must > think too much when reading ...
All good ideas. For those of you who are new to BoltWire and would like to help with the documentation, just send me your member id and I'll add you to the editor's list. It just takes a second, and it helps to keep the spam down. We do have <code> already, and can use <box> for sample markup, or we could add some more if we desire. It's a great idea if anyone has specific suggestions for markup or styles, etc. But you are right--just a bunch of text is not the answer... > (3) probably a defined way to write the docs should be set up. This is a nice idea. Anyone care to try and draft something? Or perhaps a sample style guide from some other similar software? I'm happy to throw in extra markups/styles if we wish... Maybe something like: http://www.boltwire.com/index.php?p=resources.solutions.css.special > (But right now, it seems impossible to insert e.g. the HTML code > <code> ...) Sounds like a bug. At first I thought you might be able to do: <code> Internal <co`de></co`de> </code> But you get the escape token for your output. In the BOLTMcode function (markups.php) there were two commented out lines. The second one evidently was supposed to fix this, but it didn't work. I changed it to: $code = preg_replace('/~~([0-9]+)~~/e', '$Token[$1]', $code); And of course uncommented it and it seems to works properly. Of course you need to add the ` mark to break the code pattern, but I'm not sure there's another way around this. Other than redefining BoltWire's markup to something that doesn't match the html syntax... Which might break a lot of sites... Cheers, Dan --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
