Jump to content

維基函式庫:介紹

From Wikifunctions
This page is a translated version of the page Wikifunctions:Introduction and the translation is 27% complete.

Functions make calculations on the data you provide.

Wikifunctions is an open source project that enables anyone to create functions and share them for others to use, remix, test, and learn from.

Use the following how-to guides to try out the basic features of Wikifunctions. We are looking forward to your feedback and contributions!

執行函式

You can try out community-contributed functions on Wikifunctions for yourself! Pick one from our library of functions, and give input values to discover the output.

步驟:

  1. Find a function on the Main page.
  2. Navigate to a function page.
  3. Enter the input values.
  4. 執行函式。

結果:

  1. Was the output what you expected?
  2. Do you have corrections or feedback to report?

Share a Function call

After you run a function, use the 'Copy result link' button beneath the result panel to copy a shareable URL. When someone opens that link, Wikifunctions preloads the same function call and runs it automatically, so they see the inputs and result exactly as you did. This is a quick way to demonstrate reproducible examples or ask others for help with a specific function input/output.

Steps (continue from "Evaluate a Function"):

  1. After the result loads, click 'Copy result link' under the result panel.
    Share a function call feature in Wikifunctions screenshot
  2. Share the URL with others!

Note: the shared link preloads your exact inputs and runs them again, so recipients see the same result unless the underlying implementation has changed since you generated the link.

建立函式

You can add your own functions to Wikifunctions! Create a new function for use in your own implementations and enable others to use it as well. New functions can be written in your preferred language.

步驟:

  1. 前往函式建立頁面
  2. 命名函式。
  3. Define your function's inputs:
    1. Add/remove input fields.
    2. Define each input type.
    3. Name each input.
  4. Define your function output type.
  5. Optionally, provide multilingual values for any of these fields:
    • Function name, function aliases, input labels.
  6. 發布函式。

結果:

  1. Was the function successfully published?
  2. Do you have corrections or feedback to report?

編輯函式

You can contribute to Wikifunctions by editing its library of functions. Add or edit multilingual information to functions, and expand and alter the definitions of functions.

步驟:

  1. Find a function on the Main Page.
  2. Navigate to the function page.
  3. Click Edit source to see the edit options for this function.
  4. Optionally, modify the values of:
    1. 函式名稱、
    2. 函式別名、
    3. Input list
      1. Add/remove input fields
      2. Edit input type
      3. Edit input labels
    4. Output type.
  5. Optionally, provide multilingual values for any of these fields:
    1. 函式名稱
    2. 函式別名
    3. Input labels.
  6. 發布更新。

結果:

  1. Were your edits successfully published?
  2. Do you have corrections or feedback to report?

建立測試

You can create tests for your function implementations in Wikifunctions to ensure they are working properly.

步驟:

  1. Find a function on the Main Page or the function you created in the previous workflow.
  2. Navigate to the function page.
  3. Click the “+” link in the tests table.
  4. The "Call" section should automatically be expanded.
    1. In the field under "Function", type in the name of the function you are testing and select the function when it shows up.
    2. Add values for the inputs in the respective fields.
  5. The "Result Validation" section should automatically be expanded.
    1. In the field under "Function", type in the name of the function you want to use to check the result.
    2. For a function whose output is String, this will be "String equality", for a function whose output is Boolean, this will be "Boolean equality".
    3. Add the expected value in the given field (either "Second String" or "Second Boolean").
  6. 發布更新。

結果:

  1. Was the test successfully published?
  2. Do you have corrections or feedback to report?

建立函式實作

Functions are brought to life in implementations created to suit your needs. Run, remix, and combine functions via implementations in Wikifunctions. See the section below to learn how to connect your implementation to functions. We recommend creating and connecting a test before creating an implementation. A more comprehensive guide to creating implementations is available at Wikifunctions:How to create implementations.

步驟:

  1. Find a function on the Main Page.
  2. Navigate to the function page.
  3. Click the “+” link in the implementations table.
  4. You can create a new implementation in one of two ways:
    1. 程式碼
      • Select the required programming language to write the function code.
      • Input your code.
    2. Composition:
      • Create a composition using existing functions.
  5. Publish your updates (after running a test by clicking the round arrow on the right of the box titled 測試).

結果:

  1. Was the implementation successfully published?
  2. Do you have corrections or feedback to report?

Connect an Implementation or Test to a Function

Note: This feature is only available to Functioneers.

Connect tests and implementations to your function to see it come to life.

步驟:

  1. Find a function on the Main Page.
  2. Navigate to the function page.
  3. Select one or more tests, or one or more implementations.
  4. Click on the button “連接”.

結果:

  1. Was the 已連接/已中斷連接 state successfully changed?
  2. Do you have corrections or feedback to report?

Insert a Function in a Wikipedia article

Now it is time to insert a function in a Wikipedia article and see the magic unfold.

步驟:

  1. Open the article you want to add a function to.
  2. Go to the edit tab and open visual editor.
  3. Click on the “Insert” menu at the top of the visual editor. Scroll down and click on “Function”. A dialog box will open.
  4. Search for the function you want to insert and click on it. Or, try one of the Suggested Functions below the search bar.
  5. Enter the necessary inputs and click on the “Insert” button at the top right to insert the function into the article.
  6. You can now see the output of your function in the article. You can proceed to publish the changes.
  7. If you want to edit the function, click on it. A tooltip will appear with the function name and description. Click on the “Edit” button.
  8. Then you can make changes to the inputs and click on “Apply changes” when you are done editing.

結果:

  1. Was the output what you expected?
  2. Do you have corrections or feedback to report?