Hprc banner tamu.png

Wikification

From TAMU HPRC
Jump to: navigation, search

Wikification

This page for internal use only.

Purpose

It is hoped this wiki will help to not only provide up to date information to HPRC users but to also help us, as providers of documentation, to better organize and present the information available on our web site (there really is a lot... some parts less obvious than others).

Responsibilities/owners

See the internal wiki.

Hints on Logging In

(for HPRC staff only)

When logging in there are two important things to check:

  1. make sure you are using an SSL-enabled (https://) URL
  2. make sure you check the button for "Stay in HTTPS mode" (FIXME)

Failure to do this will result in weird errors about "cookies are required".

We will work on improving upon this (but since it only impacts us will not be a priority).

Style/Coding Guide

  • Each page should have a title just above the Table of Contents section.
  • Include a section heading at the top that includes only one equal sign on each end. Then insert the Table of Contents after the section heading and follow up with each remaining section having at least two '='s.
=Resource Allocation Policy=
__TOC__
==Introduction and overview==

Prepend the UNIX prompt when documenting commands. UNIX commands should be bold text

[NetID@cluster ~]$ module load intel/2015B

Images

To use an image on a page:

  1. Use the Upload file link on the left.
  2. Browse for the file to upload and then give it a name (for the wiki) and a description (if desired). Click Upload file button.
  3. Verify the upload by checking the File list link on the left.
  4. To display the image on a wiki page, use the Image keyword. e.g.
[[Image:Hprc_banner_tamu.png]]

displays:
Hprc banner tamu.png

Appearance

The banner at the top of most pages is due to this in LocalSettings.php:

$wgSiteNotice = "[[image:Tamusc_header.jpg]]";


The rest of the page is mainly controlled by the skin, also set in that file.

$wgDefaultSkin = "vector";

You can use the Preferences link on the left to experiment with others. However, all non-HPRC personnel will use the default above.

We will probably want to work on developing our own "skin" based on the present web site. This involves CSS and a few other things. Jack isn't spending time on that just yet (others in this shop know CSS far better than I).

For now, our modified version of the "vector" skin which lives in "$IP/skins_local" (see LocalSettings.php) includes these modifications:

  1. disabling the side bar navigation links for guest users
  2. disabling the top bar navigation links for guest users
  3. removing the page title as the first heading on each page
  4. disabling the "Creative Commons" license blurbs at the bottom

See $IP/skins_local/Vector.php for details.

Testing

You can click on this page to test formatting and other things.

Converting pre-existing materials

To convert the Git Hub wiki "markdown" and the sc.tamu.edu web pages, I used pandoc.

Adadocs

For the Adadocs wiki (formerly hosted here), it was mostly a matter of:

#!/bin/sh
#git clone https://github.tamu.edu/j-perdue/adadocs.wiki.git
cd adadocs.wiki
for x in `ls *.md` ; do echo "### Converting $x" ; xx=`echo $x | sed 's/.md/.mw/' | sed 's/-/_/g' | sed 's/^/Ada:/'` ; pandoc -f markdown_github -t mediawiki -o $xx $x ; done
# EOF

Note that pandoc did a horrible job with tables... most of them had to be fixed manually.

sc.tamu.edu

For the sc.tamu.edu stuff, it is just a matter of finding the stuff between:

<!-- begin main content -->
<!-- end main content -->

and then cut/pasting to a file and running:

pandoc -f html -t mediawiki /tmp/foo

and then just cut pasting the output from that to the edit screen of this wiki. Actually, I wrote a script:

#!/bin/sh
curl -L -O $1
pandoc -f html -t mediawiki `basename $1`
# EOF

Then it is just a matter of giving it a URL (without a trailing slash(/)) and cutting/pasting the stuff between the header stuff at the top:

...
** [[policies/storage.php:NOSSL|Data Storage]]
** [[policies/software.php:NOSSL|Software Acquisition & Licensing]]
** [[policies/earitar.php:NOSSL|Restricted Software]]

and the privacy notice at the bottom:

[[privacy.php|Privacy Statement]] | [http://cis.tamu.edu/ Computing & Information Services] | [http://www.tamu.edu/ Texas A&M University] | [[email/?u=webmaster&d=sc.tamu.edu|Webmaster]]

Again, pandoc did a horrible job with tables and most had to be converted manually (which isn't actually too hard and looks much cleaner than the original tables (see other pages in this wiki for examples)).

Pages NOT to add to wiki

Some pages will/should remain in their current form on the existing web site.

Due to dynamic PHP/MySQL

Due to NetID login

Due to externally provided documentation

  • manuals for all the misc. software

Due to other reasons

  • Dr. M. Thomadakis's two technical reports on Eos... too much/many formatting and illustrations (not worth the effort)
  • In addition to Dr. T.'s valiant documention, there is no point in reformatting documents linked from HPRC:Research_Users

Due to obvious reasons

  • all .pdf, .doc, .ppt, etc. won't be bothered with

Cool Special:SpecialPages

Tracking

For now, each page that was converted from the (old) website should have a "From: URL" comment in the "Talk" (Discussion) page for each page. (so I can remove the "original" links scattered about)

Editing the Navigation Bar

Use the following page to make changes to the wiki's navigation bar.

Moving/Deleting pages

The default skin (our modified version of the "Vector" skin) doesn't provide an easy (if any) way to move or delete a page. This will be needed as we refine the organization of this wiki.

In order to be easily able to move/delete pages:

  1. log in (only HPRC staff can do this)
  2. go to Preferences
  3. go to the Appearance tab
  4. change the skin to something that supports moving and deleting pages (Jack likes 'Cologne Blue')
  5. move pages as desired

You might want to just leave your skin set that way to make it easy to do updates. But you should be sure to check pages with the default Vector skin after you are done to verify that it looks appropriate for the user.

BEFORE MOVING OR DELETING A PAGE, BE SURE TO CHECK THE "WHAT LINKS TO THIS PAGE" PAGE

Moving/renaming a page

Once you're skin/interface allows it:

  1. click Rename Page to select a new name for page. Be sure to enable "set up re-direct" for the moved page.
  2. once new page is established, go back to the redirect page and find all pages that "link here"
  3. correct all pages to point at new page
  4. delete redirect

This may be overkill, but it keeps things tidy.

Preventing cell word-wrap in tables

If you want to prevent a table cell from being automatically word-wrapped in Mediawiki, change the table cell from this:

| sometext

to this:

| style="white-space:nowrap" | sometext

You can also provide advice on where to break/wrap with

<br>


#include "transclusion"

A simple way to import the contents of one page into a larger page is to use "transclusion". Think "#include".

One example is of combining all the Ada compile pages with:

{{:Ada:Compile:Intro | Getting Started}}
{{:Ada:Compile:Scalar | Scalar Programs}}
{{:Ada:Compile:OpenMP | OpenMP Programs}}
{{:Ada:Compile:MPI | MPI Programs}}
{{:Ada:Compile:CUDA | CUDA Programs}}
{{:Ada:Compile:PHI | PHI programs}}
{{:Ada:Compile:Misc | Miscellaneous}}

which combines all the seperate pages into one.

testwiki

There is a test wiki for us to use to develop a better "skin" (appearance) for these pages.

The skins that everyone is welcome to play with (provided that they play nice with RCS) are in:

 sc:/var/www/testwiki1/skins_local/

The rendering of the skin can be tested at the test wiki. (use this page for testing since going to the test wiki Main Page will redirect to production Main Page [not what you want])

This is only meant to be a test of the skin/appearance. DO NOT UPLOAD FILES (they will be lost).

Table shading/alignment

Most of the tables in this wiki use the following prelude to provide background relief and alignment (which varies as needed).

{| class="wikitable" style="text-align: left;"

Adding new HPRC staff to the wiki

  • Go to Special-Pages-> Login/Create Account
  • Click on "Create Account"
  • remove any prefilled data and add data for new staff member (username, email, full name)
  • click "Use temporary password and email to new user"