Getting Started

From UTSW Neuro Wiki
Jump to: navigation, search

Contents

Welcome to the UTSW NeuroWiki!

The purpose of this website is to collect and distribute information that will help residents and faculty provide better care. To get started, please create a NeuroWiki account. An account is not necessary to read the wiki, but is required to add new pages or edit current pages. NeuroWiki is compatible with most modern browsers including Chrome, Firefox, Opera, Safari, and newer version of Internet Explorer. Older versions of internet Explorer may not be compatible with the wiki edit functions.

Questions or suggestions may be emailed to the wiki administrator at neuroadmin@phhs.org.

Creating an Account

This can be done by clicking the link above or the login link to the top right of the wiki and create an account. The account name is used to identify the account making edits. Any name can be chosen, but it should identify the account holder so as to identify to person making edits or adding articles. The password can be anything. An email address is optional, but would help users contact each other directly. This account is not currently linked to the UTSW account system.

Navigating NeuroWiki

On the main page are links that will take you to the major sections of the wiki. Additional links may be added over time, so keep an eye out! To the left are the navigation, search, and tool boxes. To the top are tabs which perform various functions to help edit and organize pages. To the upper right is a link to log in/out or create an account.

  • Navigation box- Contains links to various sections of the wiki.
  • Search box- Type in a search query here to begin searching for pages. The search function will search title names as well as page content. This will prioritize page names matching your search string, but will also show pages containing your search string as well.
  • Tool box- Contains links to various specialized sections of the wiki. These links are mostly used by the wiki administrators and are not typically necessary for average users.

At the top is the tabs bar which contain tabs linked to functions necessary to edit and organize the wiki.

  • Edit- used to edit the entire page.
  • History- used to view the change history of a particular page
  • Delete- used to delete an entire page
  • Move- used to move a particular page to another name space. i.e moving America to United States.
  • Protect- used by administrators to protect a page and make it read-only.
  • Watch- used to keep track of a page and changes made to it.
  • Refresh- used to purge the cache for a page and forcibly refresh it.
  • Add topic- used to add a section to a page which will be appended to the bottom.
  • Upload- used to upload files which can be later linked or displayed.
  • Add article- used to add an article entry to the ‘Articles’ section. This tab is only visible in the ‘Articles’ section.

Organization of the Wiki

The wiki is currently divided up into two main sections. The first section is the ‘Articles’ space. This space is used to post journal articles divided into sections. The second section is the ‘Handbook’ space. This section is meant to organize relevant information in an organized form to simulate the ‘Parkland Neurology Guide.’ This is meant to help organize a portion of the wiki into a virtual book, but is not meant to link to every page of the wiki.

Viewing the Wiki

Viewing pages on the wiki can be done by one of two ways. The first is to click on links on the main page and navigating through the various subsections. This will take you through the organized portion of the wiki pertaining to each section. The second way is to use the search box to search for an item of interest. The search box will search page titles as well as the content of each page. The search results will prioritize page titles matching the search query and will also display pages with occurrences of the particular search term. Some search terms may have an abbreviation or eponym which may lead to a redirect to another page i.e. ICH will redirect to Intracerebral Hemorrhage. If an abbreviation or eponym does not have a redirect, one can be created. Within the page, there may be links to other wiki pages which may direct you to another topic of interest. Depending on the number of sections, there may also be a table of contents which can direct you to various sections of that page. In the ‘Articles’ section, posted articles will have a link to that particular journal article on PubMed.

Changing the Wiki

Making changes to the wiki requires the creation of a user account. To edit a page, one must first navigate to the page to be edit. The page may or may not exist. If a page exists, then the content can be edited. If a page does not exist, then it may be created.

Creating a Page

When searching for a page, a page with that exact title name may not exist. The search results will display any pages with content that may contain the search string. At the top of the search results will be a red link asking you to create a page with that particular name. Navigating the link will take you to the page with that exact name stating that there is not text on the page. Clicking the ‘Create’ tab at the top will create the page from scratch. Clicking ‘Add Topid’ will add a section to the page. Once a page is created, it can now be searched. Each page has a unique name and there can only one page with that name. Beware of misspellings and pages listed under abbreviations or eponyms so as to avoid creating redundant or unsearchable content. If a page already exists under another name, a redirect can be created instead.

Editing a Section

If a page is divided into sections, each individual section may be edited separately and independently of the others. For each section, there is an ‘edit’ link to the right of the header. Navigating this link will take you to the edit screen. However, the content of the edit box and changes made to it will only reflect this section. Editing a Page
If a page already exists, the page content can instead be edited. Clicking the ‘Edit’ tab take you to the edit screen. This will edit the entirety of the page, sections and all. The content can be edited in the edit box. When changes are complete, you may preview the page or save it directly. Changes should be reflected immediately. If the changes are not shown, you may need to reload the page or click the ‘Refresh’ tab.

Adding an Article

To add an article entry to the Article Section, navigate to the desired topic. On this page, click the ‘Add Article’ tab which will then take you to a screen displaying ‘Add another.’ Clicking this button will reveal a box labeled ‘PMID.’ In this box, simply input the PubMed ID (PMID) number of the article in question. The PMID can be obtained by searching for the article on PubMed and finding the number listed to the bottom left. Multiple articles can be posted at a time by clicking the ‘Add another’ box which will reveal another PMID box. Once you are done, click ‘Save page’ and this will take you the topic page with the articles posted in boxes. If an article was added in error, the section may be changed by click the ‘edit’ link to the right of the section and deleting the particular entry.

Editing a Section

If a page is divided into sections, each individual section may be edited separately and independently of the others. For each section, there is an ‘edit’ link to the right of the header. Navigating this link will take you to the edit screen. However, the content of the edit box and changes made to it will only reflect this section. Editing 101
Editing the wiki requires a small learning curve. The wiki uses a simple but specialized syntax to specify various formatting attributes, such as creating headers, changing text formats, or adding images or tables. Luckily, there is also a rich text editor which can be accessed by click the ‘Show RichTextEditor’ link. This will reveal a new toolbar with advanced editing functions. Not all the functions on this toolbar are functional, but most should be familiar to you if you have used Word or similar word processor. Wiki Text Editor
This is a simple editor used to edit the text and/or code of each page. This may be desirable if the Rich Text Editor is not quite making the desired changes. For most users, the Rich Text Editor will be preferable.

Rich Text Editor

This editor is designed to mimic common word processers and should help take out the learning curve typically required to edit a wiki. Text can be created in another editor, such as Word, and pasted into the Rich Text Editor, with or without formatting. The text can be pasted with formatting using the ‘Paste from Word’ button or without formatting using ‘Paste as plain text’ button. When editing is complete, you may view your work without posting it to the wiki by using the ‘Show preview’ button at the bottom. If this appears satisfactory, the entry can be saved. Listed below are the various functions of the buttons, though not all of them are functional. Italicized entries specifies advanced functions not typically used.

  • Source displays the text which the wiki will ultimately see, including the code which is not typically displayed.
  • Styles- makes various style changes
  • Print- prints the content of the edit box.
  • Spell checking- checks spelling
  • Spell check as you type- checks spelling as you type
  • Paste as plain text- pastes copied text as plain text. This is useful if you copy text from a website or word processor and just want to past the text and nothing else. Copied text from these sources typically have formatting associated with it as well.
  • Paste from Word- used to paste text copied from Word. This will open up a dialog box in which text can be pasted from Word, including formatting information. This is useful for adding formatted text and other objects such as bullet points and tables.
  • Find- searches the edit box
  • Replace- replaces a text string with another text string.
  • Subscript- types subscript.
  • Superscript- types superscript
  • Link- creates a link to an external website
  • Unlink- undoes link
  • Undo- undo
  • Redo- redo
  • Image- displays the external image
  • Table- insert table (right click on the table to edit table properties)
  • Insert horizontal line- inserts a horizontal line (use sparingly)
  • Insert special character- inserts special character
  • Special tags- adds custom tags
  • Signature- add signature
  • Insert a new query- nonfunctional
  • Webservice- nonfunctional
  • Upload media- nonfunctional
  • Semantic toolbar- nonfunctional
  • About-about CKEditor
  • Styles- change text styles
  • Format- changes text/paragraph format. Standard text is ‘Normal’ format and standard sections are ‘Heading 2.’
  • Font-changes font. Please keep standard font if possible.
  • Size- changes text size. Please keep standard size if possible.
  • Bold- bolds text
  • Italic- italicizes text
  • Underline- underlines text
  • Strikethrough- strikes through text
  • Align left- aligns text left
  • Center- centers text
  • Align right- aligns text right
  • Justify- justifies text
  • Numbering- numbers text
  • Bulleting- bullets text
  • Increase indent- moves indent to right
  • Decrease indent- moves indent to left
  • Block quote- changes text to a block quote
  • Text color- changes text color
  • Text highlight- changes text highlight
  • Maximize- maximizes edit window
  • Show blocks- shows block quotes
Personal tools