Kolmafia - User contributions [en]

Talk:Main Page

2007-06-26T11:33:19Z

74.138.96.28: Spam removal

Save these links for now:

== Getting started ==

* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* [http://mail.wikipedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
21895299452399151244860

== Wiki layout... ==

We really should consider exactly how to lay out the wiki... We should probably see how others (especially the KoL wiki) do it and take inspiration... :)

Also, I'm thinking we should eventually have a page for each function, to make searching the wiki more valuable... :)

--[[User:Daychilde|Daychilde]] 23:00, 8 January 2007 (CST)

I agree with your idea about one-page-per-function.

Also I think every* function's documentation should show a real-world example of use. The links to example scripts are a good start in this direction, but some code to read right on the function page would be nice. (*Yes, even the "you are not cool enough to use this" undocumented stuff.)

A master ASH function list page would be helpful. When trying to Find a keyword in browser to see if KM implements a given functionality, it's a minor PITA to have to click into each categorized page and search them all individually.

Also welcome would be some kind of icon, color, or other indicator for newly-added functions. Master list sorted/sortable by implementation version/date if possible.

Also, on the subject of general layout/UI improvements (since you asked): for the main page, I prefer a high-level bulleted-listy index/ToC, kinda like the ToCs on the current sourceforge manual pages. Personally, I find this more useful than the increasingly popular "widgety-portaly-stocks-news-and-weather" look.

Redundancy should be removed wherever possible -- e.g. (ASHRM) in front of every link. I understand if prefixes of that sort are there to assist in organizing the underlying database, but if not, I think they are totally unnecessary and a distraction -- that is, provided the containing page is appropriately identified with a nice big "ASH Reference Manual" heading at the top, breadcrumbs, etc.

I'll quit before I arrive at a frenzy of usability fanaticism the likes of which would make J. Nielsen repent like a dirty sinner. (Got work to do, actually. Now maybe if there was a "job opportunities" section.......)

--[[User:somebody who sincerely appreciates not having to register/login and probably wouldn't participate elsewise]] 12:35, 30 January 2007 (EST)

On the other hand, speed-bumping idiot apammers may be worth it. I could go on for ages about how offensive I find that kind of griefing (If you think life isn't a game, you're doing it wrong)--[[User:Metraxis|Metraxis]] 11:27, 18 February 2007 (CST)

== Updating? ==
Let's get started, guys. Soon enough, I'll have a list of all the functions, which I think should go in a wiki page to (as someone above said) search and link. Also, is there a way to do monospacing with code? --[[User:MagiNinjA|MagiNinjA]] 00:35, 29 March 2007 (CDT)
:You can get mono-spaced text by using <code> tags. For example, using <pre><code>EXAMPLE TEXT</code></pre> produces this as a result. <code>EXAMPLE TEXT</code>
:If you need anymore help, just drop me a line on my [[User_talk:Ksumoe|talk page]]. [[User:Ksumoe|ksumoe]] ([[User_talk:Ksumoe|talk]] [[Special:Contributions/Ksumoe|contrib]]) 18:35, 10 April 2007 (CDT)

== Ideas... ==

These are my ideas that I have floating around in my head:
# A template to put all the relevant information about a function into a table (with proper colored backgrounds and such)
## I can do this; I just need to know what information is 'relevant'.
# Move this type of discussion to the Community Portal. Right now the CP is just a bunch of links (we can make a 'links' page and add it to the sidebar if needed).
# An overhaul of the main page. Someone said that they don't like the 'portal' type of look, but that kind of look has become the ''de facto'' standard for wikis, as it is the most popular. I'll pound out a rough draft on a subpage of my user space.
# Creation of a template structure. Templates for requesting deletion, protection, etc. That way non-sysop flagged users can 'tag' pages [[Talk:Bad title|such as this]] for deletion.
# Logo! 'Cause we need to be cool like that.
# Define a category structure. Do it now before too many pages get created.

Like I said... I'm here to help. [[User_talk:Ksumoe|Comments]]  plox. [[User:Ksumoe|ksumoe]] ([[User_talk:Ksumoe|talk]] [[Special:Contributions/Ksumoe|contrib]]) 21:17, 13 April 2007 (CDT)

I added some links on the home page -- hope that helps users find more documentation... :) -Daychilde

I corrected the Script Repository link to http://www.kolmafia.us from http://www.kolmafia.ua. ;) -Regnar

== Links to Redirects? ==

While I understand the need for redirect, why are we linking to redirect pages? Why not use <nowiki>[[Page Title|Displayed Text]]</nowiki> links instead?

String Handling Routines

2007-06-13T08:22:51Z

74.138.96.28: Fix paragraph tag.

Under Construction
void print( string helloworld ) 
void echo( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window.
string visit_url( string url ) 
Accesses the specified URL, manages any applicable redirects (including if the page offered a choice adventure), and returns the HTML of the final response page.
string location_to_url( location place ) 

Returns the URL that would need to be accessed to visit the specified location.
boolean contains_text( string source, string query ) 
Reveals if the query string is a substring of the source string.
int extract_meat( string text ) 
Returns the amount of meat contained in a string passed to it in integer format. For use in k-mail parsing. *Not for use on pending trades.*
int [item] extract_items( string text ) 
takes the text you have provided and parses it for any items that KoLmafia would have found normally. This means you have access to the built-in pluralization handler as well as the ability to NOT have to lookup description IDs or whatever other loops you had to use to access that information. For use in k-mail parsing. *Not for use on pending trades.*
int length( string text ) 
Returns the length of the given string.

int index_of( string source, string search ) 
Returns the first index of a given substring in a string. 
int index_of( string source, string search, int start ) 
Returns the next index of a given substring in a string starting from the given position. 
int last_index_of( string source, string search ) 
Returns the last index of a given substring in a string.
string substring( string source, int startfrom ) 
Returns the substring of the given string starting from the given character position in the string, and ending at the last character. 
string substring( string source, int start, int end ) 

Returns the substring of the given string starting from the character position indicated by start in the string, and ending at the character position indicated by end.
string replace_string( string source, string search, string replace ) 
searches the source string for the search string and replaces all instances with the replace string
string url_encode( string text ) 
string url_decode( string text ) 
Converts a string text into a formatted string for using with raw URLs or from a formatted string back into “normal” text.

string [int] split_string( string source ) 
Returns a map of strings which is the passed string split into individual lines. Originally implemented for use when parsing session logs, but may see more uses in the future.
http://kolmafia.us/index.php/topic,794.msg3868.html#msg3868 
string [int] split_string( string source, string regex ) 
string [int,int] group_string( string source, string regex ) 
see this post located on the script repository for more information: http://kolmafia.us/index.php/topic,451.msg2235.html#msg2235 

string [int] session_logs( string player, int day_count )
Gives access to the session logs saved by kolmafia. More details will be added when this function's own page is written. For now, more extensive details can be found here: http://kolmafia.us/index.php/topic,794.msg3879.html#msg3879

Talk:String Handling Routines

2007-06-13T08:21:25Z

74.138.96.28: Goodbye Spam!

Miscellaneous Functions

2007-06-13T08:19:48Z

74.138.96.28: Revert to pre-spam page.

== Part 6 - Miscellaneous ==
Mostly internal stuff. Some good for everyone, some only for ASH wizards.

void print( string helloworld ) 
Prints the given string to the graphical CLI window and to the status line of the main Adventuring window

boolean cli_execute( string command ) 
Executes the given command as if it were entered into the graphical CLI window. This can be used for CLI commands or, if you’re careful and not an asshat, for raw URLs. 
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]

void wait( int delay ) 
Does nothing for the desired number of seconds.

string get_property( string key ) 
boolean set_property( string key, string value ) 
Gets or sets a stored property from your character’s .kcs file. 
The KoLmafia [[%28ASHRM%29_KoLMafia_Properties|properties]] page contains details on many of the keys that are available for access. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean file_to_map( string file_to_load, map map_to_fill ) 
boolean map_to_file( map map_to_save, string file_to_write ) 
Loads and saves maps as tab-delimited text files.

int random( int range ) 
Generates a random integer between 0 and (range-1) inclusive.

int round( float ratio ) 
int floor( float ratio ) 
int ceil( float ratio ) 
int truncate( float ratio ) 
Returns an integer near the given real number. Respectively, it returns the nearest, next lowest, next highest, and decimal-stripped integer.

int count( map ) 
Returns the number of defined keys for the aggregate.

void clear( map ) 
Remove all keys from a map. 

void disable( string function_name ) 
void enable( string function_name ) 
For debugging purposes disables or enables the indicated function

float square_root( float value ) 
returns the square root of the passed value

string today_to_string() 
Returns today’s (real-world) date in the form yyyymmdd. It is based on your computer’s system date

Talk:Main Page

2007-06-13T07:49:39Z

74.138.96.28: Links to Redirects?