DErik's Test Page Renamed: Difference between revisions

From RCGRS MRT Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:




This is another test on a page that is just for that, testing.  I'm using the WYSIWYG editor to just type stuff in...
This is another test on a page that is just for that, testing.  Using the WYSIWYG editor to just type stuff in...


* Bullet, lust like it would be
* Bullet, lust like it would be
Line 21: Line 21:
th8is is a n edit by eric
th8is is a n edit by eric


In the main body, I changed five things.
In the main body, I (Eric) changed five things.
*FileUpload to true
*FileUpload to true
*from: address for password requests    ([[RCGRS_Wiki_Admins@rcgrs.com]])
*from: address for password requests    ([mailto:RCGRS_Wiki_Admins@rcgrs.com RCGRS_Wiki_Admins@rcgrs.com])
*from: address for emegency contacts    (RCGRS_Wiki_Admins@rcgrs.com)
*from: address for emegency contacts    (RCGRS_Wiki_Admins@rcgrs.com)
*mail when updated                                (this is why we didn’t get mail earilier in out test!)
*mail when updated                                (this is why we didn’t get mail earilier in out test!)
*mail when talk updated                          (another feature to test..)
*mail when talk updated                          (another feature to test..)
 
----Playing with
 
==Section headings with anchor==
Section headings with anchor


  <nowiki><div id="Unique anchor name 1">optional text</div></nowiki>
  <nowiki><div id="Unique anchor name 1">optional text</div></nowiki>
Line 37: Line 36:


Setting an anchor in a section heading
Setting an anchor in a section heading
  ==<nowiki><span id="Alternate Section Title"></span></nowiki>Section heading==
  ==<nowiki><span id="Alternate Section Title 1">Some anchor name here?</span></nowiki>Section heading goes here==
Note the placement. This must be a "span" tag, not a "div". (Such anchors allow sections to be retitled without breaking incoming links.)
Note the placement. This must be a "span" tag, not a "div". (Such anchors allow sections to be retitled without breaking incoming links.) DErik note: Note that the text line starts with a blank character, not the "==" characters that indicate a section start. Deleting that blank character results in the following:
 
==<nowiki><span id="Alternate Section Title 1">Some anchor name here?</span></nowiki>Section heading goes here==
optional text
Also note that, in both examples above, everything between the double equals sign pairs, that are the wiki markup for a section, is also wrapped in a "nowiki" tag section - that you cannot see without editing this page.
optional text
 
Section heading
----
----
The following was copied from the [https://mediawiki.org/wiki/Help:Links Help:Links] help page. <span style="font-family:'Times New Roman'; color:green;">Not sure why the <translate> and other tags are here. They don't show up on the Help:Links page as they get interpreted by the MediaWiki, I assume to do language translation for <translate>, but what <tvar> is for I have no idea. I think <syntaxhighlight> should also be recognized to highlight various [computer programming] languages. We may need to include some extension to get these to be properly recognized.</span>
==Creating a table with special formatting==
The following was copied from the [https://mediawiki.org/wiki/Help:Links Help:Links] help page. Generally, copying a page is not a good idea, but this is just a section of the formatting help, and taken from different parts of that page. So copying is necessary. But I actually copied rather than referenced because I wanted to see what the same stuff would do in my page versus their page. There are differences I have yet to explain. <span style="font-family:'Times New Roman'; color:green;">Not sure why the <translate> and other tags are here. They don't show up on the Help:Links page as they get interpreted by the MediaWiki, I assume to do language translation for <translate>, but what <tvar> is for I have no idea. I think <syntaxhighlight> should also be recognized to highlight various [computer programming] language keywords or sections. We may need to include some extension to get these to be properly recognized.</span>
{| border="1" class="wikitable"
{| border="1" class="wikitable"
! <translate><!--T:116--> Name</translate>/<translate><!--T:6--> Description</translate>
! <translate><!--T:116--> Name</translate>/<translate><!--T:6--> Description</translate>
Line 74: Line 71:


<syntaxhighlight lang=html>
<syntaxhighlight lang=html>
==<span id="Alternate Section Title"></span>Section heading==
==<span id="Alternate Section Title"></span>Section heading from source page==
</syntaxhighlight>
</syntaxhighlight>


Line 164: Line 161:
---- Note the table ends here.
---- Note the table ends here.


= some thoughts on page creation =
On the main page, in the "'''create page'''" input box, type a MEANINGFUL page name in and hit "'''create page'''". Be sure to pick a page name that really conveys the subject matter. That's probably obvious, but I mention it because changing the page name is hard to do.


 
Now you are looking at an empty box with perhaps no clue how to proceed. So just start typing in the box.  The default "'''edit'''" mode uses a WYSIWYG editor, just type away for now and what you see is how it will look on the web page, for the most part. There are some formatting things, like changing the font style, or making a list, or inserting images that are handled by the tool bar above the text entry area. There are a lot of choices there, but not all choices are covered there. See the https://www.mediawiki.org/wiki/Help:Formatting link to get more details.
= as oppossed to whole sale copying of... =
Consider using a LINK instead:
A link to how to edit: '''[https://www.mediawiki.org/wiki/Help:Formatting Help with Formating]'''
 
= some thoughts on philosophy =
Some thoughts on MediaWIKI philosophy: Things to consider as you seek to use this tool.
 
Think about what you are documenting and how to best present that information.  A series of textual instructions?  A diagram of some sort?  Simply a reference to another document or, say, an external URL (other website, in other words.)
 
What you want to share informs you on the correct work flow to make it all happen.
 
I quite often approach the issue similar to creating college notes Prominent sections, some paragraphs of stuff, lots of bullet notes.  Perhaps a diagram in there someplace.
 
Let's consider a simple case of information sharing:  "Learning about Foo Bar"; I looked here.  I did this.  The result was that.
 
To share this on a RCGRS MediaWIKI page, '''think HARD about an accurate page name''' - it's hard to change later, and meaningful in terms of people looking for information about Foo Bar later on.
 
Step One:  On the main page, in the "'''create page'''" input box, type a MEANINGFUL page name in and hit "'''create page'''".
 
Okay, now what?  I'm looking at an empty box and no clue how to proceed.
 
'''''Just start typing''''' in the box.  The default "'''edit'''" mode uses a WYSIWYG editor, just type away for now and what you see is how it will look on the web page.
 
Lets talk about the Foo Bar example; I looked here. I did this.  The result was that.  In the empty box, we type this:
 
<pre>
section one, I looked here
on the subject of foo bar, I looked for resources all over the place, and of course google.com provided some help.  One link I found was https://en.wiktionary.org/wiki/foobar and was very interesting details on the origin of foobar
 
section two, I did this
In order to do my own foobar, what I was take the following steps..  Some of the steps were multi-part.
List of steps
step one was to type the letter F
step two was typing the letter O
step three was to  type the letter O again
could we skip this step and just make the step before a U?
step four was to type a B
step five was to type an A
The sixth and final step was to type an R
 
section three, the result I got
When things FINALLY actually went all FOOBAR, well, let me show you.  (the intent is a photo here)
</pre>
 
So,there we go, a simple just plain typed in outline of the information you want to share.  '''This IS the actual lions share of the work'''.  But it does look a little plain and hard to decipher, just some raw text..  Now what?
 
NOW, we highlight the text of interest and start clicking format buttons..
 
==Example one: Sections==
 
Highlight the text then change the "paragraph" button to "HEADING 2"
 
Highlight the list of steps and click on the "list" icon, and choose bullet list.
 
Place the cursor at the beginning of "step one" and tab.
The beginning of step two, tab.
 
And so on.  You get the drift, right?
 
==Add a photo ==
Now, we want to add a photo..  Place the cursor near where we typed "the intent is a photo here".  Click "upload".  Answer a bunch of questions about how big, were on the page, caption, etc..
 
I don't like "Center", so I'm gonna go left...  Click "edit"
 
Now we have a photo.
 
== Save your work! ==


Click on the "Save Page.." button and if you want, makes some notes about this editing session.  It's TOTALLY COMMON to create pages a piece at a time, and as part of a team with other users!
Click on the "Save Page.." button and if you want, makes some notes about this editing session.  It's TOTALLY COMMON to create pages a piece at a time, and as part of a team with other users!
= summary =
You did it - you now have produced a page about foobar..
= editing after the fact =
HEY..  That URL I shared in the vary first section, what happened to that, anyway?  It's just text, I can't click on it!
== re-edit ==
Click the "Edit" tab.  Hightlight the URL.  Click on the "chain" icon that denotes you want to create link - both INTERNAL, ie; other wiki pages by their name, or an external URL like we all use everyday on the internet.
Using the same method, I added a HEADER 1 section heading at the top, then a "summary" section at the bottom.  This triggered the "minimum" number of levels, and NOW, you get a table of contents at the top!!  All auto generated without any work on your part.  Skip straight to your interest...GIG
== A visual aid to the process ==
== A visual aid to the process ==


[[File:Create a page.gif]]
[[File:Create a page.gif]]
 
Eric created an example page which you can visit, edit, and/or join the "DISCUSSION" on it if you have editorial suggestions, but don't want to actually change it.
== and the final result ==
 
During the above instructions I actually create the page in the diagrams, you can visit it, edit it, join the "DISCUSSION" on it if you have editorial suggestions, but don't want to actually change it..


CLick the following link: [[This is a tutorial about foobar]] ..to see the real thing..
CLick the following link: [[This is a tutorial about foobar]] ..to see the real thing..

Revision as of 11:41, 4 April 2023

a heading

This is a test page for DErik.

ĤêĂÄ crazy special chars for fun..😃😝


This is another test on a page that is just for that, testing. Using the WYSIWYG editor to just type stuff in...

  • Bullet, lust like it would be
    • tab to get a second indent..


A link? Amazone bold...


BIG..


th8is is a n edit by eric

In the main body, I (Eric) changed five things.

  • FileUpload to true
  • from: address for password requests (RCGRS_Wiki_Admins@rcgrs.com)
  • from: address for emegency contacts (RCGRS_Wiki_Admins@rcgrs.com)
  • mail when updated (this is why we didn’t get mail earilier in out test!)
  • mail when talk updated (another feature to test..)

Playing with

Section headings with anchor

<div id="Unique anchor name 1">optional text</div>

<span id="Unique anchor name 2">optional text</span>

Rendered block-level and inline, respectively. Doing this would allow for [[#Unique anchor name 1]] on the same page or [[Help:Links#Unique anchor name 1]] on a different page. Omit the "optional text" for an invisible anchor.

Setting an anchor in a section heading

==<span id="Alternate Section Title 1">Some anchor name here?</span>Section heading goes here==

Note the placement. This must be a "span" tag, not a "div". (Such anchors allow sections to be retitled without breaking incoming links.) DErik note: Note that the text line starts with a blank character, not the "==" characters that indicate a section start. Deleting that blank character results in the following:

<span id="Alternate Section Title 1">Some anchor name here?</span>Section heading goes here

Also note that, in both examples above, everything between the double equals sign pairs, that are the wiki markup for a section, is also wrapped in a "nowiki" tag section - that you cannot see without editing this page.


Creating a table with special formatting

The following was copied from the Help:Links help page. Generally, copying a page is not a good idea, but this is just a section of the formatting help, and taken from different parts of that page. So copying is necessary. But I actually copied rather than referenced because I wanted to see what the same stuff would do in my page versus their page. There are differences I have yet to explain. Not sure why the <translate> and other tags are here. They don't show up on the Help:Links page as they get interpreted by the MediaWiki, I assume to do language translation for <translate>, but what <tvar> is for I have no idea. I think <syntaxhighlight> should also be recognized to highlight various [computer programming] language keywords or sections. We may need to include some extension to get these to be properly recognized.

<translate> Name</translate>/<translate> Description</translate> <translate> Syntax</translate> <translate> Result</translate>
<translate> Link to an anchor on the same page</translate> <syntaxhighlight lang="moin">#See also</syntaxhighlight>

<translate> Anchors are provided automatically on [[<tvar name=formatting>Special:MyLanguage/Help:Formatting</tvar>|section headings]] and to the [[<tvar name=1>#top</tvar>|top]] (<tvar name=2>[[#top]]</tvar>) of the page.</translate>

#See also
<translate> Setting an anchor for incoming links</translate> <syntaxhighlight lang=html>
optional text

optional text </syntaxhighlight>

<translate> Rendered block-level and inline, respectively.</translate> <translate> Doing this would allow for [[#Unique anchor name 1]] on the same page or [[DErik's Test Page Renamed#Unique anchor name 1]] on a different page.</translate> <translate> Omit the "optional text" for an invisible anchor.</translate>

<translate> Setting an anchor in a section heading </translate>

<syntaxhighlight lang=html>

Section heading from source page

</syntaxhighlight>

<translate> Note the placement.</translate> <translate> This must be a "span" tag, not a "div".</translate> <translate> (Such anchors allow sections to be retitled without breaking incoming links.)</translate>

<div id="<translate nowrap> Unique anchor name 1</translate>"><translate> optional text</translate>

<span id="<translate nowrap> Unique anchor name 2</translate>"><translate> optional text</translate>

Section heading
<translate> Link to an anchor at another page</translate> <syntaxhighlight lang=moin>Help:Images#Supported media types for images</syntaxhighlight> Help:Images#Supported media types for images
<translate> Link to the current page's talk page</translate> <syntaxhighlight lang=moin>Discussion</syntaxhighlight>

<translate> See also [[<tvar name=page-names>Special:MyLanguage/Help:Magic_words#Page_names</tvar>|Help:Magic words#Page names]]</translate>

Discussion
Template:Anchor<translate> Link to a subpage</translate> <syntaxhighlight lang=moin>/example</syntaxhighlight>

<translate> Shortcut for <tvar name=1><syntaxhighlight lang="moin" inline>/example</syntaxhighlight></tvar>.</translate> <translate> See also <tvar name=1>Template:Ll</tvar>.</translate>

/example
<translate> Link to a subpage without the leading slash</translate> <syntaxhighlight lang=moin>/example/</syntaxhighlight>

<translate> Shortcut for <tvar name=1><syntaxhighlight lang="moin" inline>example</syntaxhighlight></tvar>.</translate>

example
<translate> Link to a subpage of parent page for current page.</translate> <translate> Can only be used on subpages.</translate> <syntaxhighlight lang=moin>[[../example2]]</syntaxhighlight>

<translate> Shortcut for <tvar name=1><syntaxhighlight lang="moin" inline>example2</syntaxhighlight></tvar> if you post the link on <tvar name=2><syntaxhighlight lang="moin" inline>example</syntaxhighlight></tvar> page.</translate>

example2
<translate> Visible link to a category page</translate> <syntaxhighlight lang=moin>Category:Help</syntaxhighlight>

<translate> Without the leading colon the link would not be visible and the page would instead be placed into the category; this is a very common mistake.</translate> <translate> See also <tvar name=1>Template:Ll</tvar>.</translate>

Category:Help
<translate> Visible link to an image or media file</translate>

File:Example.jpg

file label

Media:Example.jpg

file label


<translate> Mailto link</translate>
[mailto:info@example.org email me]
email me
<translate> Mailto named with subject line and body</translate>
[mailto:info@example.org?Subject=URL%20Encoded%20Subject&body=Body%20Text info]
info

Note the table ends here.

some thoughts on page creation

On the main page, in the "create page" input box, type a MEANINGFUL page name in and hit "create page". Be sure to pick a page name that really conveys the subject matter. That's probably obvious, but I mention it because changing the page name is hard to do.

Now you are looking at an empty box with perhaps no clue how to proceed. So just start typing in the box. The default "edit" mode uses a WYSIWYG editor, just type away for now and what you see is how it will look on the web page, for the most part. There are some formatting things, like changing the font style, or making a list, or inserting images that are handled by the tool bar above the text entry area. There are a lot of choices there, but not all choices are covered there. See the https://www.mediawiki.org/wiki/Help:Formatting link to get more details.

Click on the "Save Page.." button and if you want, makes some notes about this editing session. It's TOTALLY COMMON to create pages a piece at a time, and as part of a team with other users!

A visual aid to the process

Eric created an example page which you can visit, edit, and/or join the "DISCUSSION" on it if you have editorial suggestions, but don't want to actually change it.

CLick the following link: This is a tutorial about foobar ..to see the real thing..