Hprc banner tamu.png

Difference between revisions of "Wikification"

From TAMU HPRC
Jump to: navigation, search
(Converting Adadocs/sc.tamu.edu)
Line 78: Line 78:
 
[[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]]
 
[[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]]
 
</pre>
 
</pre>
 +
 +
==Pages NOT to add to wiki==
 +
Some pages will/should remain in their current form on the existing web site.
 +
===Due to dynamic PHP===
 +
* http://sc.tamu.edu/software/
 +
* http://sc.tamu.edu/uas/batch_status.php
 +
===Due to NetID login===
 +
* http://sc.tamu.edu/ams*
 +
* http://sc.tamu.edu/forms*
 +
===Due to externally provided documentation===
 +
* manuals for all the misc. software

Revision as of 09:49, 23 September 2014

Style/Coding Guide

  • The only rule so far is not to include a section heading (typically at the top) that includes only one equal sign on each end. That is, instead of writing:
=Title=

you should always start with at least two '='s. e.g.

==Title==

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:Tamusc_header.jpg]]

displays:
Tamusc header.jpg

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 = "cologneblue";

You can use the Preferences link on the left to experiment with others. However, all non-SC 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).

Testing

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

Converting Adadocs/sc.tamu.edu

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

Adadocs

For the Adadocs wiki, 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]]

Pages NOT to add to wiki

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

Due to dynamic PHP

Due to NetID login

Due to externally provided documentation

  • manuals for all the misc. software