Difference between revisions of "User:Kebap"

From Mudlet
Jump to navigation Jump to search
m
m
(7 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
= Projects =
 
= Projects =
  
−
* [[User:Kebap/documentation-in-wiki]]
+
* [[User:Kebap/documentation-in-wiki]] - currently on hold
−
** currently on hold
+
 
 
* [[User:Kebap/translation infrastructure|Establish translation-infrastructure for Mudlet universe]]
 
* [[User:Kebap/translation infrastructure|Establish translation-infrastructure for Mudlet universe]]
 
** Create PR to clean up feedback from Crowdin - see [https://github.com/Mudlet/Mudlet/issues/1802 issue 1802]  
 
** Create PR to clean up feedback from Crowdin - see [https://github.com/Mudlet/Mudlet/issues/1802 issue 1802]  
Line 14: Line 14:
 
** Improve documentation for developers
 
** Improve documentation for developers
 
*** How to handle special characters at start or end of translateable text
 
*** How to handle special characters at start or end of translateable text
 +
 
* Learn how to write working i18n style code for English hacks like "next %n time(s)"
 
* Learn how to write working i18n style code for English hacks like "next %n time(s)"
 
** QT documentation thereof: http://doc.qt.io/qt-5/i18n-source-translation.html#handling-plurals
 
** QT documentation thereof: http://doc.qt.io/qt-5/i18n-source-translation.html#handling-plurals
 +
 
* [[User:Kebap/Manual|New structure for wiki manual]]
 
* [[User:Kebap/Manual|New structure for wiki manual]]
 +
 
* Graphical overview of [[User:Kebap/Release dates|Release dates]]
 
* Graphical overview of [[User:Kebap/Release dates|Release dates]]
 +
 
* Add MorgenGrauen to Mudlet MUDs
 
* Add MorgenGrauen to Mudlet MUDs
 
** review recommendations from [[Listing_Your_MUD]]
 
** review recommendations from [[Listing_Your_MUD]]
−
* Enable Discord group "Testers" to (de-)register themselves via Discord reactions
+
 
 +
* <strike>Enable Discord group "Testers" to (de-)register themselves via Discord reactions</strike> done! :)
 +
 
 
* Create PR to clean up texts in source - see [https://github.com/Mudlet/Mudlet/issues/1801 github issue 1801]  
 
* Create PR to clean up texts in source - see [https://github.com/Mudlet/Mudlet/issues/1801 github issue 1801]  
−
* Learn how to make small PR like above with Smart Git instead of github web interface
+
 
 +
* <strike>Learn how to make small PR like above with Smart Git instead of github web interface</strike> done! :)
 +
[[File:Commits201809.png|thumb|Me with a few buddies]]
 +
 
 +
* Improve Mudlet documentation, which is not interesting for Mudlet users, but only for (some) developers.
 +
** Including definitions on internal functions,
 +
** discussions and decisions on coding style conventions,
 +
** standard procedures like [[Release Checklist]], [[update lua function list]] for autocompletion,
 +
** This is done by adding Categories like "Mudlet Developer Manual" or "Mudlet Admin Manual"
 +
** etc.
 +
 
 +
* Look into improving a11y (accessibility) of Mudlet [https://github.com/Mudlet/Mudlet/issues?q=is%3Aopen+is%3Aissue+label%3Aa11y client] and [https://www.w3.org/TR/WCAG20/ website], etc.
  
 
= Examples for Wiki formatting =
 
= Examples for Wiki formatting =
Line 30: Line 47:
 
: What the function does. In this case, it is just a non-existing function with the only purpose to show, how to write documentation for functions
 
: What the function does. In this case, it is just a non-existing function with the only purpose to show, how to write documentation for functions
 
: Returns whatever the function returns.  
 
: Returns whatever the function returns.  
−
: See also: [[Manual:Lua_Functions#paste|paste]]
+
 
 +
See also:  
 +
[[Manual:Lua_Functions#paste|paste]],
 +
[[Manual:Lua_Functions#paste|paste]]
  
 
{{note}} Available since Mudlet 3.5
 
{{note}} Available since Mudlet 3.5
Line 43: Line 63:
  
 
;Example
 
;Example
−
<lua>
+
<syntaxhighlight lang="lua">
 
--a small example snippet of the function in action
 
--a small example snippet of the function in action
 
--the comments up top should introduce it/explain what the snippet does
 
--the comments up top should introduce it/explain what the snippet does
 
functionName("arg1", "arg2")
 
functionName("arg1", "arg2")
−
</lua>
+
</syntaxhighlight>

Revision as of 18:19, 15 July 2019

About me

Mudlet user and script developer, hailing from MorgenGrauen (German).

Projects

  • Enable Discord group "Testers" to (de-)register themselves via Discord reactions done! :)
  • Learn how to make small PR like above with Smart Git instead of github web interface done! :)
Me with a few buddies
  • Improve Mudlet documentation, which is not interesting for Mudlet users, but only for (some) developers.
    • Including definitions on internal functions,
    • discussions and decisions on coding style conventions,
    • standard procedures like Release Checklist, update lua function list for autocompletion,
    • This is done by adding Categories like "Mudlet Developer Manual" or "Mudlet Admin Manual"
    • etc.
  • Look into improving a11y (accessibility) of Mudlet client and website, etc.

Examples for Wiki formatting

functionName

functionName(arg1, arg2, [optionalArg3])
What the function does. In this case, it is just a non-existing function with the only purpose to show, how to write documentation for functions
Returns whatever the function returns.

See also: paste, paste

Note Note: Available since Mudlet 3.5

Parameters
  • arg1:
What arg1 is/does. Passed as a string.
  • arg2:
What arg2 is/does. Passed as a string.
  • optionalArg3
(optional) The name needn't be telling. Relevant is to mark optional arguments at the start of this line (with text "optional" in brackets) and in the function definition line (with [these] brackets)
Example
--a small example snippet of the function in action
--the comments up top should introduce it/explain what the snippet does
functionName("arg1", "arg2")
Retrieved from "https://wiki.mudlet.org/index.php?title=User:Kebap&oldid=5622"