Talk:CLI Reference

From Kolmafia
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

should we add that Csend will add make it's own message to the recipient if it is not given?--Icon315 21:47, 21 April 2010 (UTC)

That's the kind of detail that should go on it's own page if the command is important enough to get its own page. --Bale 01:03, 22 April 2010 (UTC)

I agree with Bale. My thoughts so far on CLI commands;

  • Obvious stuff that anyone can figure out by looking at this table doesn't warrant it's own page.
  • Stuff that behaves exactly the same as an ASH command should probably say so and link to the function page
    • If it isn't exactly the same, but close enough that a line or two of explanation will clarify the difference, still link to the function but edit the function's CLI section to explain the difference.
    • Said functions don't need their own pages
  • Stuff that has a similar or identically named ASH function, but behaves significantly differently on the CLI, should have it's own page (with the command as a link).
    • If the command names are the same, the cli command should be "command (CLI)" (ie "eat (CLI)", if eat needed its own page)
    • If the command has no ASH function with the same name, the "(CLI)" part can be omitted (we can always move a page later if an ASH equiv. is added)
  • Create page names with alphanumeric characters when at all possible. Ie don't use "!" but rather "bang"

All additional thoughts on this are welcome. --StDoodle (#1059825) 03:17, 22 April 2010 (UTC)

My thought is that you've covered everything perfectly. This should be our bible for CLI pages. --Bale 03:38, 22 April 2010 (UTC)

Bale recently explained a limitation with the acquire command that I was previously unaware of in this thread. Perhaps acquire needs it's own page to account for this information? --That FN Ninja 16:10, 15 July 2010 (UTC)

  • This is not a CLI issue. The exact same issue affects retrieve_item(). It should probably be mentioned on that page. --Bale 20:37, 15 July 2010 (UTC)

FYI

You can't simply copypasta stuff into these wiki tables; remember, the pipe character (|) is treated special in templates! Use {{!}} instead, or <nowiki>Stuff</nowiki> tags. (P.S. You should see the source for this fyi...) This, by the way, is the reason a lot of parameter options appear to be missing. --StDoodle (#1059825) 03:26, 22 April 2010 (UTC)

Ugh, what a mess. Sometimes, {{!}} results in a <pre> tag or something inside of wiki tables. On the other hand, similar FUBARS happen when using &#124; outside of tables on a wiki. Long story short; inside of a table, use &#124; for | and outside of a table use {{!}}. Messy enough for you? --StDoodle (#1059825) 03:59, 2 May 2010 (UTC)

Remark

While used intrinsically in the ASH examples, it seems that nowhere is it stated explicitly that to remark a line in either a CLI or ASH script to preface it with // Stanley 14:28, 3 April 2011 (UTC)

Seriously? (this is a link. Click it!) --Heeheehee 21:19, 3 April 2011 (UTC)