Help:Editing: Difference between revisions
(What a great page to start with!) |
mNo edit summary |
||
Line 54: | Line 54: | ||
! What it looks like !! What you type | ! What it looks like !! What you type | ||
|- | |- | ||
| The <nowiki><highlight-x></nowiki> provides ability for codes to have syntax highlight. The letter "x" indicates the language of your code. This is a list of languages added/changed from [http://qbnz.com/highlighter/index.php GeSHi]'s original languages: | | The <nowiki><highlight-x></nowiki> tag provides ability for codes to have syntax highlight. The letter "x" indicates the language of your code. This is a list of languages added/changed from [http://qbnz.com/highlighter/index.php GeSHi]'s original languages: | ||
*nsis | *nsis | ||
Line 92: | Line 92: | ||
</highlight-nsis></pre> | </highlight-nsis></pre> | ||
|- | |- | ||
|The <nowiki><attach></nowiki> tag can be used to link your page to a file directly. | |The <nowiki><attach></nowiki> tag can be used to link your page to a file directly in this {{SITENAME}}. | ||
It will show the "{{ns:2}}:Zip.gif" image, the link to the file and its size in KB's or Bytes rounded downwards (depends on file size). Because of the image, the recommended format is .zip. | It will show the "[[{{ns:2}}:Zip.gif]]" image, the link to the file and its size in KB's or Bytes rounded downwards (depends on file size). Because of the image, the recommended format is .zip. | ||
Inside the tag, you have to specify the name of the file from the {{ns:6}} namespace to be linked, without the namespace and with the exact capitalization as shown by the name of the page. | Inside the tag, you have to specify the name of the file from the {{ns:6}} namespace to be linked, without the namespace and with the exact capitalization as shown by the name of the page. |
Revision as of 05:48, 2 May 2005
Minor Edits
NSIS Wiki has pages with codes or for plugins or NSIS related programs. For those pages, a major edit has a purpose for reporting a change to the code, or if talking about NSIS related plug-ins or programs, a new version of the plug-in or program. For the rest of the pages, follow the default rule.
Summarizing a Change
When summarizing a page, you may want to consider putting one the prefixes below, so everyone could organize themselves easily. These are not required:
Bx: | Bug report to the script, DLL or program. |
Fx: | Feature request to the script, DLL or program. |
Px: | Patch to the script, DLL or program. |
PSx: | Page spelling. |
PFx: | Page format. |
More to come... |
The "x" can be "o" for the opening of a report, "c" for the closing, "d" for deletion, "f" for fix, and whatever you invent.
Tips on editing NSIS Wiki articles
- Always post something related to NSIS. Pages that are not NSIS related will be deleted.
- Don't put the version of your script on page titles. Pages with this will be renamed to their names without the version number. One exception to this case is relating to scripts that work only in specified versions of a program.
- You can watch your pages by clicking on "Watch" tab at the top of the page of your choice, or by checking "Watch this page" when editing the page of your choice. Every change that happens on the page will appear on "my watchlist" link on the top of any page.
- Before clicking on Save page button, always consider to Preview the page. Every change you do to the page will be marked in the History tab.
- Post scripts that are updated to the latest version of NSIS. If a script only works for a version of NSIS, and this is not the latest, you should mention that it won't work for the current NSIS version.
- More to come...
Wiki Markup
Additionally to the original wiki markup, the following apply:
Images
What it looks like | What you type |
---|---|
Typing the url to a page with an image shows the image itself. Example:
|
http://www.iespana.es/lsmonki/NSIS/Orange/Sets.png |
Sometimes an image is not directly linkable. You can try firstly to put an image extention to the end of the url, like ".gif", to make it show normally as a picture.
Example using deguix's avatar:
|
http://forums.winamp.com/avatar.php?userid=98070&dateline=1093710924.gif |
Extensions
What it looks like | What you type |
---|---|
The <highlight-x> tag provides ability for codes to have syntax highlight. The letter "x" indicates the language of your code. This is a list of languages added/changed from GeSHi's original languages:
An example of usage using the "nsis" language: /* An huge comment describing the code */ Name "blah" OutFile "blah.exe" #a comment Section SetOutPath $INSTDIR File "blah.txt" ;a comment SectionEnd |
<highlight-nsis> /* An huge comment describing the code */ Name "blah" OutFile "blah.exe" #a comment Section SetOutPath $INSTDIR File "blah.txt" ;a comment SectionEnd </highlight-nsis> |
The <attach> tag can be used to link your page to a file directly in this NSIS Wiki.
It will show the "User:Zip.gif" image, the link to the file and its size in KB's or Bytes rounded downwards (depends on file size). Because of the image, the recommended format is .zip. Inside the tag, you have to specify the name of the file from the File namespace to be linked, without the namespace and with the exact capitalization as shown by the name of the page. Example: Nopey.zip (54 KB) If the file doesn't exist, it is replaced with "file.ext not found". Example: MyFile.zip not found |
<attach>Nopey.zip</attach> <attach>MyFile.zip</attach> |