I think the parentheses are necessary...I'm thinking of the PHP online documentation here...
Ok, that may have been mashed together out-of-context, but still.
If you're thinking of pages such as
THIS then I'd have to disagree with parenthesis being part of the page name.
I do, however, fully support the idea of adding in something for "See also" functionality into the ash function page template(s).
Absolutely agree with Zarqon here, the () are necessary for ASH functions, and should be kept in.
I'm going to take one last stab at it and mention that the parentheses are a
language construct, not part of the function name itself. However, in the interest of Mercedes McNab*, we should probably vote on it and come up with a standard way of dealing with this.
If we go with functions w/o (), we would need disambiguation pages every time the same names is used for a cli command.
If we go with functions w/ (), we need to either 1) Pipe all links (easy to miss, and has the downside of searches not directly leading to function pages) or 2) Create a redirect for every single function that doesn't have a cli equivalent. In the case of #2, we still need to decide whether searching for, say, "drink" should take you directly to the cli command page, possibly with a "Did you mean..." for the ash function, or if disambiguation pages should be used.
As per Doodle's request, and the fact that we can't use conditionals in our templates until the website is edited, we should discuss the templates here as not to overwrite them.
Since the conditional situation is about to change, we'll have a much easier time coming up with flexible templates. However, I think that makes it
even more important that we hammer out
what exactly they should include before we go ahead and start overhauling things.
For the few cases where they're actually the same, disambiguation pages could be used.
This is my thinking as well, as per above. (As in, even with parentheses as part of function names, they may still be required.)
I'll be upgrading the wiki and adding parser functions tomorrow.
Woot, thanks fewyn, that will make a lot of the complicated, flexibility-minded pre-planning stuff much more feasible!
I want to mention that:
1) I am not a programmer by trade. In some instances, this means I won't agree completely with the approach that others have. I don't think this is
always a bad thing for this project, though, as I'd really like to open up ash to others, like myself, who aren't really programmers by nature. I tend to approach this project more from the perspective of "how can we be of most help to a complete ash noob" than "how can we provide professional documentation just like other languages have." However, I do understand that each trade has its list of things that "must be done a certain way." I don't want to stomp all over standards; I just want to make things easier for new scripters. Please keep that in mind.
2) The overall goal here is not just to revamp the entire kolmafia wiki overnight. That's a task beyond us at the moment. I'd love to make a great deal of progress, but there's a strong possibility that in a few days, I will no longer have the free time to put towards a great deal of editing. I would much rather we came up with a solid foundation of templates and standards, so that anyone who looked into it knew exactly what to do, and how, when going to re-write a function page. I'd like to make it incredibly easy for a casual wiki user to go through and edit pages in a standardized way as they see fit. Right now, the pages are a hodge-podge of standards and philosophies, and there's very little coherence to the wiki as a whole.
With all of this in mind, I think it's best, going forward, if we decide on
what templates are needed and
what information should be standard in those templates. As for the actually syntax of those templates, let's not worry about that at the moment. It looks like at least myself & bumcheekcity have a clear enough idea on wiki template syntax to come up with workable templates, once we're sure
what to put in them. That's where I'd like to concentrate efforts in the planning stages.
One thing for sure I want to avoid is pages like
THIS.
Edit to add footnote: *Mercades McNab is the name of an actress from
Buffy: The Vampire Slayer and
Angel who played a character named "Harmony." It's a dork-joke.