wiki-archive/twiki/data/InvasiveSpecies/EditingHintsForThisWiki.txt,v

47 lines
2.6 KiB
Plaintext
Raw Normal View History

head 1.1;
access;
symbols;
locks; strict;
comment @# @;
1.1
date 2005.11.19.15.18.29; author BobMorris; state Exp;
branches;
next ;
desc
@none
@
1.1
log
@none
@
text
@%META:TOPICINFO{author="BobMorris" date="1132413509" format="1.0" version="1.1"}%
%META:TOPICPARENT{name="WebHome"}%
---+ %TOPIC%
|[[%PUBURL%/%WEB%/SchemaAsHtml/IASProfile.html][Full schema as HTML]]|
|[[%PUBURL%/%WEB%/WebHome/IASProfileMaster.xsd][Full schema as XSD]]|
<img src="%ATTACHURLPATH%/%TOPIC%.gif" align="left">
New to Wiki technology? Read Main.ThreeEasySteps before reading this.
---++ Dealing with wiki links
There is always a tension in Wiki between the use of TWiki.WikiWords and use of standard words that might be easier for the readership to follow. A TWiki.WikiWord must have at least two "ordinary" words as part of it. If we bowed to the technology instead of the readers, we might write !PathwayElement instead of Pathway to permit a discussion of an invasion Pathway. Instead, we use the reader-friendly terminology and stick to natural words as much as possible, with some cost to those who are commenting upon or editing discussion topics.
Favoring readers over commentators and editors brings a cost that still leaves us bound to wiki technology for most effective use of wiki. Namely, a TWiki.WikiWord automatically creates a hypertext link to its definition (if there is one) and this makes wiki extremely powerful. (*NOTE:* if you see a '?' on a link that means nobody has started that topic yet! If you click on it, you will be the one that starts it! For words that correspond to IASPS elements this is best left to the IASPS wiki maintainers.). The cost of this is that if you _do_ want a link on an ordinary word--which you normally would for words that are part of the schema--you have to surround the word with double square brackets: =[<nop>[Facts]]=
A second common issue of linking arises when writing schema paths like [[Facts]]/[[LocationSpecificFacts]]. Because the !LocationSpecificFacts term is not preceded by a space, wiki does not recognize it as a TWiki.WikiWord. Therefore, if you wish a fully linked version of this as displayed in the preceding sentence, you need to write =[<nop>[Facts]]/[<nop>[LocationSpecificFacts]]= in any edit session containing such an expression.
The main cost of ignoring all this is that some convenient links will be missing. Nothing else serious will happen, and this can always be remedied by a subsequent edit.
-- Main.BobMorris - 19 Nov 2005
%META:TOPICMOVED{by="BobMorris" date="1132414160" from="IASPS.UsageHintsForThisWiki" to="IASPS.EditingHintsForThisWiki"}%
@