Contributing to the J Wiki

From J Wiki
Jump to navigation Jump to search



Introduction

How do I join the J Wiki?

Before you can edit the wiki, you must create an account.

To do so, please email the wiki group with your login name (First Last) and email address.

After creating an account, log in to be able to edit the wiki.

What is expected of me as a contributor?

You are free to edit the pages on the wiki to correct and improve them, except where

pages are protected.

A page is protected when the usual Edit tab reads View source.

How can I test my code?

Preview is your friend.

Use the Show Preview button early and often. This will keep your lock on the page current and alert you early on when you make a mistake. I have many examples of inconvenient typos that I have caught by previewing a page that I was sure was correct. The Preview button is located at the bottom of the edit window.
Save, Preview and Cancel buttons below the Wiki text editor

Return to top

Welcome to the J Wiki Sandbox.

We have created a page with a few different examples that is available if you would like to go in and experiment. Please do not save any changes of your experiments, so that the J Wiki Sandbox is preserved for others. You should see all of the changes that you need by using Show Preview. There is a link at the top of the J Wiki Sandbox page that will return you here when you are done experimenting.

Link to View J Wiki Sandbox
Link to Edit J Wiki Sandbox
Return to top

How do I create a page?

Open up a non-existent page.

In order to create a new blank page, enter the name of the page along with any folder names or special prefixes such as User: or Category: in the wiki search text area.
CreateNewPage.png
If the page has not already been created you will be given the option to create this page
NewPageResponse.png

Return to top

Can I use other pages as a template?

That's not hard to do, but it is a two step process. First, reveal the structure of the page that you want to use as a template using the edit tab and make a copy of that html mark-up.
EditTab.png
Next, you enter the name of the new page that you would like to create and if it does not already exist, you will have the option to create a new page. When that new page is created, you just paste the contents that you had copied onto the new page. After that, you can make any alterations that you like in the content while still retaining the style of the template you copied. In the near future there may be template pages that can be copied that will have structure without content and in some cases this might simplify the process.

Return to top

Creating content on User pages.

Once you have registered, you have access to your own user page. The wiki uses a "first surname" pattern like "Bob Therriault" and this can be used as a sub-directory name, with underscores replacing spaces, to group your own pages. You create a new page simply by entering it into the wiki search, like this:
Creation of User:Name/Page
You should see an option to create a new page with that name. Then select create this page and you should be given a fresh page with the name you had entered.
Wiki response to new page

Return to top

How do I control the table of contents on the page?

Remove it.

Place __NOTOC__ in the page script and no Table of Contents will appear on the page.

Return to top

Move it.

Place __TOC__ in the page script at the position you would like it to display and if there are at least four entries in the Table of Contents it will appear.

Return to top

Force display.

If you have fewer than four headings and you would still like the Table of Contents to appear then place __FORCETOC__ in the page script and it will appear on the page at the default position. To move the Table of Contents to a different position, place __TOC__ in the page script at that position.

Return to top

How do I link to other information?

The easiest way to link a page is to use the link tool in the wiki editor.
Close up of the Link tool
A pop up is generated that will provide most of the options that you require.
Dialogue Window for Link Creation
If you are interested in a more hands on approach, there are three content components and four punctuation components of a wiki link:

[[Page # Anchor | Label]]

  • Content
    • Page - Designates the target page of the link. If it is missing, the target is the current page.
    • Anchor - Designates position within the target. If it is missing, the position is top of the page.
    • Label - The link text displayed on the wiki page. If it is missing, the link itself is displayed.
  • Punctuation
    • [ ... ] Single brackets enclose external links.
    • [[ ... ]] Double brackets enclose links to pages within the wiki
    • # Precedes the anchor description. If it is missing, there is no anchor.
    • | Precedes the link label. For external links a space is used instead of |
For more info

Return to top

Linking to sections within a page.

Complete Discussion of Linking in the Section Above(by the way this is an example of linking to a section!)

There are three ways to link to a section of page and they are all based on the concept of an anchor.

[[#Anchor| Label]]</nowiki>

1. The Anchor can be a subheading of the page.
[[#Heading Text|Label]]

2. The Anchor can be an embedded span element.
[[#Anchor Text|Label]]
This span html would need to appear on the page as the target for the link.
<span id="Anchor Text"> ...content optional... </span>

3. The Anchor can be the meta element "top", which will go to the top of the page.

[[#top|Label]]

For more info about links
Return to top

Linking to other pages in the wiki.

Complete Discussion of Linking in the Section Above

Links to a particular page on the wiki have a very straightforward format.

[[Page # Anchor | Label]]

Page is just the descriptor following /wiki/ in the target url.
[[Sandbox#Anchor|Label]]
https://code.jsoftware.com/wiki/Sandbox

The function of the Anchor is as described above.
[[Page#Anchor|Label]]

The Label can be any content in the text used as a placeholder for the link.
[[Page#Anchor|Label]]

All enclosed in double brackets.

[[ Page#Anchor|Label ]]

For more info about links
Return to top

Linking to other pages outside the wiki.

Complete Discussion of Linking in the Section Above

Links to external pages are similar, but with single [ ... ]'s and a space delimiter instead of |.

[Page#Anchor Label]

Page is the target url.
[Page#Anchor Label]
[https://www.jsoftware.com/help/jforc/more_verbs.htm#_Toc191734356 Label]

The function of the Anchor is as described above.
[Page#Anchor Label]

The Label can be any content in the text used as a placeholder for the link.
[Page#Anchor Label]

All enclosed in single brackets.

[ Page#Anchor Label ]

For more info about links
Return to top

Sandbox#anchorExample
#Remove it.
Sandbox#Heading 1
Sandbox#Heading 4
Sandbox#top

How do I include media in the wiki?

Uploading media.

Inserting media.

Styling media.

Linking internal media.

Linking external media.

How are tables used in the wiki?

Why should I use a table?

How do I use a table?

What about fonts and special characters?

Characters that emphasize.

Entering code.

Inline code can be typeset with <tt>...</tt> tags, which renders like this: Hello world =: +/%#. Code on its own line can be wrapped in <pre>...</pre> tags, which renders as 

 HelloWorld =: +/%# 0 1 2 NB. some comment

If you want to use syntax highlighting, use <syntaxhighlight lang="j"> ... </syntaxhighlight> , which renders as: 

HelloWorld =: +/%# 0 1 2 NB. some comment

Subscripts and Superscripts

Math Formulas

Before you edit, please read the Editing Guidelines. Beginners can start with the Editing Wiki introduction for creating and editing pages.

Please note that Jsoftware is not responsible for the contents of the wiki, and you should take reasonable precautions when running software from these pages. See also the policy on attachments.

Useful Links


The "wiki" category is used for pages involving the maintenance and development of the J wiki.

See Also

  • Category:WikiProgress for lightweight pages which might belong here.
  • Category:Update and Category:FixMe for pages where we would specifically like to focus our upgrade efforts.
  • Category:Delete for pages which someone has, for whatever reason, deemed to be irrelevant to the site (perhaps because the information is better handled in some other context, in which case replacing the page with a redirect might be the right answer).
Retrieved from "https://code.jsoftware.com/mediawiki/index.php?title=Category:Contributing_to_the_J_Wiki_W.2&oldid=45680"