Extension:Semantic Forms/Linking to forms

From MediaWiki.org
Jump to: navigation, search
Semantic Forms - navigation (view)
Basics Main page (talk) · Download and installation · Quick start guide · Hosting · Special pages
Using Semantic Forms SF and templates · Defining forms · The "edit with form" tab · Linking to forms · Creating query forms
Resources for help Common problems · Known bugs and planned features · Getting support · Developers' documentation
About Semantic Forms Authors and credits · Version history · Sites that use Semantic Forms · Related extensions

How do you get users to forms? The standard way is via the #forminput parser function call, which displays a single input for users to enter the name of a page; if they enter such a name and click the button, they are sent to a form to create that page - unless a page with that name already exists, in which case they are sent to a form for editing the existing page. This is what is known as the "two-step process". The reason for the initial step, of having the user first enter the page name, is to ensure that users don't accidentally overwrite existing pages. This process is so standard that it is built into the default forms produced by Semantic Forms' "Special:CreateForm" and "Special:CreateClass" helper pages: any form-definition page created by Semantic Forms includes, at the top, a call to #forminput, so that users who go to that form page can automatically start to use the form.

However, it's also possible to have users skip the first step, of entering the page name - that's what you should do if the form contains a formula for setting the page title based on the user input. That's the "one-step process", and it uses the parser function #formlink instead of #forminput.

Query forms, that use Special:RunQuery, have their own linking method, using the parser function #queryformlink.

The two-step process[edit | edit source]

The two-step process, i.e. the standard way to get users to forms, is done using the #forminput parser function.

Using #forminput[edit | edit source]

Here is the syntax of the #forminput parser function:

{{#forminput:form=|size=|default value=|button text=|query string=query string parameters|autocomplete on category=|autocomplete on namespace=|remote autocompletion|placeholder=|popup}}

All arguments are optional. An explanation of the parameters:

  • form= - the name of the SF form to be used; if it is left empty, a dropdown will appear, letting the user choose among all existing forms.
  • size= - the size of the text input (default is 25).
  • default value= - the starting value of the input (default is blank).
  • button text= - the text that will appear on the "submit" button (default is "Create or edit page").
  • query string= - you can use this option to pass information to the form; this information generally takes the form of templateName[fieldName]=value. It should look like a typical URL query string; an example would be "query string=namespace=User&User[Is_employee]=yes".
    • additionally, any query string values can be passed directly in as parameters - so the values above could instead be passed in as "|namespace=User|User[Is_employee]=yes".
  • autocomplete on category= - adds autocompletion to the input, using the names of all pages in a specific category.
  • autocomplete on namespace= - adds autocompletion to the input, using the names of all pages in a specific namespace (only one of these two can be used).
  • remote autocompletion - specifies that autocompletion values should be retrieved dynamically from the server, instead of directly from a list of values hidden in the page's HTML (thus allowing many more values)
  • placeholder= - "placeholder" text that appears in the form input before the user types anything.
  • popup - opens the form in a popup window.

Adding pages of a specific namespace[edit | edit source]

You can have a page-input form create pages within a specific namespace (like 'User:') by default, without forcing users to type in that namespace every time. To do that, add 'namespace=namespace-name' to the "query string=" parameter.

(Note that, if you want to use SMW on a custom namespace, you need to add the namespace to $smwgNamespacesWithSemanticLinks.)

Adding sub-pages[edit | edit source]

In MediaWiki, you can create subpages by including a slash in the page name. To have the page that's added automatically be a subpage, you can add a value for "super_page=" in the query string. To make it a subpage of the current page, you can set this value to "super_page={{PAGENAME}}". This will prepend a "current-page-name/" at the beginning of the page name that the user types in.

The one-step process[edit | edit source]

You can have the name of the page created by the form be set automatically, by adding a "page name" parameter within the form definition's "info" tag. There are two types of "variables" one can include in the value for this parameter:

  • '<template-name[field-name]>' - gets replaced with the value for the specified field field-name in the specified template template-name.
  • '<unique number>' - by default, gets replaced by the lowest number for which the page title that's generated is unique. Normally, this value starts out as blank, then goes to 2, then 3, etc. However, one can manually set the starting number for this value, by adding a " start= " parameter; this number must be 0 or higher. For instance, to have the number start at 1 and go upward, you should set the tag to be "<unique number;start=1>". You can also instead set it to be a random six-digit number, by adding the "random" parameter, so that the tag looks like "<unique number;random>". Note that the parameter in either case is delimited by a semicolon.
    • Note that the "page name=" value cannot start with "<unique number>", due to a bug in Semantic Forms; there has to be some text before that. And it cannot contain the character "#", because MediaWiki does not allow pound signs in page titles.

As an example, imagine a form for storing notable quotes. Its {{{info}}} tag could have a parameter of "page name=<Quote[Author name]> quote <unique number;start=1>". This would include the author's name in the name of every quote page, as well as a number to guarantee the uniqueness of every opinion-item page added. A user could then go to the URL "http://mywiki.com/Special:FormEdit/Quote" and fill out the form; if they set the author to be "Ernest Hemingway", and no other quotes in the wiki had him as an author, then hitting the "Save page" button would result in a new page called "Ernest Hemingway quote 1" .

The "start" value can have leading zeroes; a value of "001", for instance, would lead to pages that had the value "001", then "002", etc.

The "page name=" value gets parsed by the MediaWiki parser, so you can also add parser functions, pre-defined variables, etc. into the value.

Note that users must be sent to the page "Special:FormEdit/form-name" for this automatic page-setting to work; if they somehow end up at a #forminput call and are prompted for a page name, that name will override whatever the automatic page name would be.

Using #formlink[edit | edit source]

If you want, you can generate this link using the "#formlink" parser function, instead of creating the URL directly. This function is called as:

{{#formlink:form=|link text=|link type=|query string=query string parameters|target=|tooltip=|popup|new window}}

An explanation of the parameters:

  • The "form=", query string and "popup" arguments work much the same way that their equivalents in "#forminput" work.
  • "link text=" works like "button text=" (see above).
  • The "link type=" argument sets the display of the link: if it's set to "button", the link will show up as a button; if it's set to "post button", it will be a button that sends the query-string value(s) using "POST" instead of via the URL - this is helpful when a lot of data has to be preloaded, and it is more robust with special characters like line breaks in the query string; if it's set to blank or anything else, it will show up as a regular link.
  • The "target=" parameter shouldn't usually be used, but it sets the "target" page to be edited, if you want to link to the editing of a specific page.
  • The "tooltip=" parameter displays a "tooltip", displayed if a user hovers the link.
  • The "popup" parameter opens the form in a popup window. (Note: popup forms may not work if you have the ConfirmEdit extension installed - users might not see the CAPTCHA they need to fill out.)
  • The "new window" parameter opens the form in a new window or tab, depending on the browser.

An example call to #formlink would be:

{{#formlink:form=Quote|link text=Add a quote for this author|link type=button|query string=Quote[Author]={{PAGENAME}} }}

This will link from the page, via a button, to a form for adding a quote, with the "Author" field filled in with the current page name.

Note: If any part of your query string - such as a page name or anything else - contains characters such as apostrophes, ampersands or +, you will need to URL-encode that value. For that, you can use the "urlencode" function from the ParserFunctions extension. The example above, for instance, would need to change to: Quote[Author]={{urlencode:{{PAGENAMEE}}}}.

You may want to have the link to the form be an image, instead of text or a button. For that, you could call something like:

{{#formlink:form=Quote|link text=[[File:edit.png|link=]]}}

Linking to query forms[edit | edit source]

You can link to query forms, i.e. forms run within the page Special:RunQuery, by using the #queryformlink parser function. This is called in the same way as #formlink, except that there's no "target" parameter. For a more complete explanation, see Creating links to query forms.

Pointing red links to a form[edit | edit source]

In MediaWiki, links to nonexistent pages are called 'red links', because they are usually colored red. By default, these links go to a page for adding the article to the wiki using the standard edit interface. However, if you know that the page in question will be editable via a form, it can be helpful to instead link directly to the form to create that page.

Starting with version 3.0 of Semantic Forms, the recommended way to do this is to use the #formredlink parser function. Its syntax is quite similar to the #formlink function (see above), but unlike #formlink it only displays a link to a form if the the page being linked to (with the "target=" parameter) does not exist. If the target page does exist, the function will simply link to that page.

There may be times when you are not sure which form a linked-to page will use; it could be one of a number of choices. You can set it so that the user gets other possibilities when they click on the red link, by adding one or more "alt_form" parameters to the #formredlink call, each with its own number.

As an example, see this page. Both the author and the source are red-linked, but the links take you to forms for adding these two pages (please do not actually fill out and submit these forms, because that would ruin the example). When you get to the forms for each page, you can see, at the top, that there are alternative forms that you can select for adding each page. That is enabled by the following two calls to #formredlink in the template where those links are defined:

For the source:

 {{#formredlink:target={{{source|}}}|alt_form[0]=Source|alt_form[1]=Magazine|alt_form[2]=Online magazine}}

For the author:

 {{#arraymap:{{{author|}}}|,|x|{{#set:Was written by=x}}{{#formredlink:target=x|form=Author|alt_form[0]=Editorial board}}}}

In the example page, the "source" call creates a link to Special:FormEdit/The_Denver_Post?alt_form[0]=Source&alt_form[1]=Magazine&alt_form[2]=Online magazine&redlink=1. Note that no main/default form is specified; only alternate forms.

The "author" call is more complex because that field can hold a list of values. #arraymap is used to put in a call to #formredlink for each individual value; as well as to store each individual value using an SMW property.

Note also that, if you've defined a namespace as having a default form, red-links that go to a page within that namespace will also go to the right 'add data' form, without any extra work needed.

SF versions before 3.0[edit | edit source]

For Semantic Forms versions before 3.0, the way to have forms point to red links is instead done via SMW's properties. If such a nonexistent page is being pointed to by a semantic property, the red link can be made to point to the form by adding the special property "Has default form: (see 'The "edit with form" tab') to the page for that property.

Setting this default form can be done directly within the 'CreateProperty' page.

In addition, or instead, you can also add one or more "Has alternate form" special properties to the property page, to set alternate forms for the link.

When using this older approach, by default Semantic Forms checks, for every red link, for the existence of properties across the wiki pointing to that page in order to find default forms. However, for pages with a large number of red links, this can slow down page loading. If that's an issue for you, you can change the behavior so that SF only checks properties on the page in question, instead of throughout the whole wiki. To do that, add the following to LocalSettings.php, after the inclusion of Semantic Forms:

$sfgRedLinksCheckOnlyLocalProps = true;

Populating red-linked pages automatically[edit | edit source]

It's nice to have red links point to the right form for creating the page, but this still calls for work on the part of users - they have to click to the form, fill out the fields and save the page. This is especially bothersome when the form contains few or no fields, and/or if there are many such pages to be created. You can instead have such red-linked pages get automatically created by the system.

To do this, instead of using "Has default form" or "Has alternate form", you should add the special property "Creates pages with form" to the property that you want pointing to those automatically-created pages. For instance, if you have pages that point with the property "Has country" to other pages, and you want those other pages to automatically be created using a form called "Country". You just need to add the following to the "Has country" property's page:

[[Creates pages with form::Country]]

It should be noted that it may take a while for each page to be created, since page creation is done through MediaWiki "jobs", which can take anywhere from a few seconds to several hours or more to run, depending on the length of the job queue. Pages created with this method will be associated with user ID 1 (the first user created on the wiki), unless you set $sfgAutoCreateUser to another username.

Preloading data[edit | edit source]

You may want a form to already contain some data when the user goes to it. (Note that this only applies to adding new data, or to query forms; for editing an existing page, there is no way to set the contents of the form to anything other than the current contents of that page.) There are various ways to do this:

  • Specify a "default" value for whatever fields you want to have a value for in the form.
  • Specify a "preload" page for the "free text" input, which will preload the free text field with the contents of that page.
  • Add 'preload=preload-page-name' to the query string value in the 'forminput' call; this will preload the entire form with the contents of that page.
  • Similarly, you can add a "preload=..." value to the query string for a 'FormStart' or 'FormEdit' URL.
  • Add "template-name[field-name]=field-value" to the query string value in the 'forminput' call, to set the value for a specific field. To preload values for more than one field use "&": "template-name[field-name-1]=field-value-1&template-name[field-name-2]=field-value-2"
  • To preload values for multiple-instance templates, add the instance number after the template name. So you could have something like "template-name[1][field-name]=field-value&template-name[2][field-name]=field-value" for two instances.
  • Similarly, you can add a value for a specific field to the URL query string for 'FormStart' or 'FormEdit'.
  • Finally, you can create your own custom handling, using the 'sfEditFormPreloadText' hook. If another extension calls this hook, it can preload data however it wants. The function registered with this hook should have a header like "function-name(&$page_contents, $page_title, $form_title)".

Modifying pages automatically[edit | edit source]

You can create links that, when clicked on, create or edit pages automatically in the background, with a preloaded set of values, using the #autoedit parser function. This function is called, and is displayed, in a very similar manner to #formlink - the difference is that the link only performs an action in the background, instead of bringing the user to a form. The syntax for #autoedit is:

{{#autoedit:form=|target=|link text=|link type=|summary=|query string=''query string parameters''|reload}}

All these parameters but 'reload' work in the same way as they do in #formlink; 'reload', if added to the call, reloads the current page after the link is clicked.

As an example, let's say you want to create a simple voting scheme, letting users vote between "Vanilla", "Chocolate" and "Strawberry". You have a page for each, and each one contains a template called "Flavor", with a field called "Num votes" - that field, in turn, sets a semantic property called "Has number of votes". And there is also a form, also called "Flavor", to edit such pages. To create a link that, when clicked, increments the number of votes in the "Vanilla" page by one, you could place the following call on the page:

{{#autoedit:form=Flavor|target=Vanilla|link text=Vote for Vanilla|query string=Flavor[Num votes]={{#expr:{{#show:Vanilla|?Has number of votes}} + 1}}|summary=Adding vote {{#expr:{{#show:Vanilla|?Has number of votes}} + 1}}. }}

This functionality is also available via the MediaWiki API, as the sfautoedit action - this enables outside scripts, and bots, to easily modify template calls within wiki pages. You can find the full documentation on this by searching for "sfautoedit" here.