Difference between revisions of "Neocron Wiki:Map Plugin Guide"

From Neocron Wiki
Jump to: navigation, search
Line 26: Line 26:
 
Ok you come across one of the fantastic map page, but it's missing something you know. Lets look at sector [[A 06]]. You know [[Mrs Sung]] is in this sector, but the NPC isn't shown there and you want to add it. Here is the sector without the NPC marked.
 
Ok you come across one of the fantastic map page, but it's missing something you know. Lets look at sector [[A 06]]. You know [[Mrs Sung]] is in this sector, but the NPC isn't shown there and you want to add it. Here is the sector without the NPC marked.
  
(Example)
+
<ncw:map class="right">
 +
Image:A_06.png|
 +
 
 +
point:genrep 118 84 [[Genrep]]
 +
point:city_entrance_nc 164 136 [[Neocron]]
 +
rect:factory 57 89 92 122 [[Simmons Factory]]
 +
 
 +
rect 10 0 217 10 [[B_06]]
 +
rect 217 10 227 227 [[A_07]]
 +
rect 217 0 227 10 [[B_07]]
 +
</ncw:map>
  
 
=== Get the URL of the Image ===
 
=== Get the URL of the Image ===
  
If you are using Firefox Right click on the image, and select Copy Image Location
+
If you are using Firefox Right click on the image, and select '''Copy Image''' Location
  
 
(Image needed: Right clicking on graphic and selecting the right option.)
 
(Image needed: Right clicking on graphic and selecting the right option.)
Line 44: Line 54:
 
=== Adding points ===  
 
=== Adding points ===  
  
It is recommended you only add circles, however please see the advanced editing section for doing rectangles and polygons. The size of the circle isn't important, as the map plug-in will automatically correct the size of the circle .
+
It is recommended you only add circles, however please see the advanced editing section for doing rectangles and polygons. The size of the circle isn't important, as the map plug-in will automatically correct the size of the circle.
  
 
So lets add where Mrs Sung is. I select Circle, click on the map. Then I add the name of the Wiki page which the spot should link to, which is Mrs Sung.
 
So lets add where Mrs Sung is. I select Circle, click on the map. Then I add the name of the Wiki page which the spot should link to, which is Mrs Sung.
Line 70: Line 80:
 
(Image of previewed map)
 
(Image of previewed map)
  
Now the image of your point is (Image default) a which means you not given the circle a type. The type allows you to specify what sort of point your point it is. Since Mrs Sung is a NPC we add the npc type. For a list of types, and the recommended usage, please see the [[Map Plugin Types Guide]]. The format for adding the type is the '''shape name''' followed by a '''colon''' and then the '''type name'''.
+
Now the image of your point is (Image default) a which means you not given the circle a type. The type allows you to specify what sort of point your point it is. Since Mrs Sung is a NPC we add the npc type. For a list of types, and the recommended usage, please see the [[Project:Map Plugin (Types guide)|Map Plugin types guide]]. The format for adding the type is the '''shape name''' followed by a '''colon''' and then the '''type name'''.
  
 
So
 
So
  
(Example}
+
<nowiki>circle:npc 49 77 20 [[Mrs Sung]</nowiki>]
  
 
Becomes
 
Becomes
  
(Example)
+
<nowiki>circle 49 77 20 [[Mrs Sung]]</nowiki>
  
 
Click on save...and Mrs Sung is now added to the map.
 
Click on save...and Mrs Sung is now added to the map.
 +
 +
<ncw:map class="right">
 +
Image:A_06.png|
 +
 +
circle 92 150 20 [[Mrs Sung]]
 +
point:genrep 118 84 [[Genrep]]
 +
point:city_entrance_nc 164 136 [[Neocron]]
 +
rect:factory 57 89 92 122 [[Simmons Factory]]
 +
 +
rect 10 0 217 10 [[B_06]]
 +
rect 217 10 227 227 [[A_07]]
 +
rect 217 0 227 10 [[B_07]]
 +
</ncw:map>

Revision as of 13:14, 9 June 2008

About

The NC-Wiki Map plug-in is based on a Imagemap Mediawiki plug-in written by, except a lot of enhancements have been added by, such as.

  • Spot highlighting when you hover over an area (This was achieved using the JQuery Maphighlight plug-in)
  • Extra functions to overlay new symbols onto an existing map, while keeping the original intact
  • Ability to customise each area on the map with different colours and sizes
  • Dynamic key generation

Browser Compatibility

The Map Plug-in is compatible with IE7 and Firefox 2. For best results please use Firefox.

There is no support for IE6. (Seriously if you are using IE6, upgrade to IE7 or use Firefox) If you use any other browser, support is limited but we will try and address any bugs, however please don't be offended if you are told to upgrade or change your browser.

Future enhancements

Do you have an idea to improve the plug-in? Please leave your ideas on the Talk page.

How to add new points

Please note: At some point we will have a Special Page, so please check back regularly for updates. (Tip use the Watch page function)

The wiki has had all the sector pages populated with the basic map information.

Ok you come across one of the fantastic map page, but it's missing something you know. Lets look at sector A 06. You know Mrs Sung is in this sector, but the NPC isn't shown there and you want to add it. Here is the sector without the NPC marked.

GenrepNeocronSimmons FactoryB 06A 07B 07
A 06.png

Key:

  • Map Icon Zone.png Wasteland Zone
  • Map Icon Outpost.png Outpost Zone
  • Map Icon Outpost Factory.png Outpost Zone (Factory)
  • Map Icon Outpost Lab.png Outpost Zone (Lab)
  • Map Icon Outpost Mine.png Outpost Zone (Mine)
  • Map Icon Outpost Fortress.png Outpost Zone (Fortress)
  • Map Icon Zone City.png City
  • Map Icon Factory.png Outpost (Factory)
  • Map Icon Lab.png Outpost (Lab)
  • Map Icon Mine.png Outpost (Mine)
  • Map Icon Fortress.png Outpost (Fortress)
  • Map Icon Gogo.png Go-Guardian
  • Map Icon Genrep.png Genrep
  • Map Icon Asg.png ASG
  • Map Icon Ceres Lab.png Ceres Lab Entrance
  • Map Icon Doy Tunnel.png DoY Tunnel Entrance
  • Map Icon Doy Tunnel.png DoY Tunnel (Up)
  • Map Icon Doy Tunnel.png DoY Tunnel (Down)
  • Map Icon Doy Tunnel.png DoY Tunnel Exit to surface
  • Map Icon Cave.png Entrance to a Dungeon
  • Map Icon Cave.png Entrance to Regants Legacy
  • Map Icon Cave.png Entrance to Gaia Mine
  • Map Icon Interest.png Area of Interest
  • Map Icon Zone Entrance.png Entrance to a City
  • Map Icon Zone Entrance.png Entrance to Neocron
  • Map Icon Zone Entrance.png Entrance to Techhaven
  • Map Icon Zone Entrance.png Entrance to Military Base
  • Map Icon Zone Entrance.png Entrance to Twilight Guardian
  • Map Icon Zone Entrance.png Entrance to Dome Of York
  • Map Icon Npc.png NPC
  • Map Icon Vendor.png Vendor
  • Map Icon Smuggler.png Smuggler

Get the URL of the Image

If you are using Firefox Right click on the image, and select Copy Image Location

(Image needed: Right clicking on graphic and selecting the right option.)

(Need to add IE7 options)

Starting the map editor

Open this link in a new browser

Put the image URL in the "Lorad from URL - URL" box and click on the load button. The map should be loaded into the editor for you to add points.

Adding points

It is recommended you only add circles, however please see the advanced editing section for doing rectangles and polygons. The size of the circle isn't important, as the map plug-in will automatically correct the size of the circle.

So lets add where Mrs Sung is. I select Circle, click on the map. Then I add the name of the Wiki page which the spot should link to, which is Mrs Sung.

Sometimes the page you are linking to may not exist. Don't worry, this is perfectly normal and acceptable. The wiki allows you or anyone else to write a new article at any time.

(Image of Circle added in the wrong place!)

Note: for example purposes only, I've put Mrs Sung south of the Op, which isn't her current correct position.

Copying the information back to the wiki page

At the bottom of the page there is a box with your generated points. Copy the bits between <imagemap> and </imagemap> tags only.

(Image of selected elements)

Then paste the information just after the <ncw:map> tag

{Image of information inserted into the wiki editor}

Now it's time to see the results. Click on Preview, and your new point should appear.

Adding the type to the point

(Image of previewed map)

Now the image of your point is (Image default) a which means you not given the circle a type. The type allows you to specify what sort of point your point it is. Since Mrs Sung is a NPC we add the npc type. For a list of types, and the recommended usage, please see the Map Plugin types guide. The format for adding the type is the shape name followed by a colon and then the type name.

So

circle:npc 49 77 20 [[Mrs Sung]]

Becomes

circle 49 77 20 [[Mrs Sung]]

Click on save...and Mrs Sung is now added to the map.

Mrs SungGenrepNeocronSimmons FactoryB 06A 07B 07
A 06.png

Key:

  • Map Icon Zone.png Wasteland Zone
  • Map Icon Outpost.png Outpost Zone
  • Map Icon Outpost Factory.png Outpost Zone (Factory)
  • Map Icon Outpost Lab.png Outpost Zone (Lab)
  • Map Icon Outpost Mine.png Outpost Zone (Mine)
  • Map Icon Outpost Fortress.png Outpost Zone (Fortress)
  • Map Icon Zone City.png City
  • Map Icon Factory.png Outpost (Factory)
  • Map Icon Lab.png Outpost (Lab)
  • Map Icon Mine.png Outpost (Mine)
  • Map Icon Fortress.png Outpost (Fortress)
  • Map Icon Gogo.png Go-Guardian
  • Map Icon Genrep.png Genrep
  • Map Icon Asg.png ASG
  • Map Icon Ceres Lab.png Ceres Lab Entrance
  • Map Icon Doy Tunnel.png DoY Tunnel Entrance
  • Map Icon Doy Tunnel.png DoY Tunnel (Up)
  • Map Icon Doy Tunnel.png DoY Tunnel (Down)
  • Map Icon Doy Tunnel.png DoY Tunnel Exit to surface
  • Map Icon Cave.png Entrance to a Dungeon
  • Map Icon Cave.png Entrance to Regants Legacy
  • Map Icon Cave.png Entrance to Gaia Mine
  • Map Icon Interest.png Area of Interest
  • Map Icon Zone Entrance.png Entrance to a City
  • Map Icon Zone Entrance.png Entrance to Neocron
  • Map Icon Zone Entrance.png Entrance to Techhaven
  • Map Icon Zone Entrance.png Entrance to Military Base
  • Map Icon Zone Entrance.png Entrance to Twilight Guardian
  • Map Icon Zone Entrance.png Entrance to Dome Of York
  • Map Icon Npc.png NPC
  • Map Icon Vendor.png Vendor
  • Map Icon Smuggler.png Smuggler