New Draft Main Page

This is a back-up of the WIKI.
Not all links might work
We're working on a new wiki.

Main Page | Recent changes | View source | Page history | Log in / create account |

Printable version | Disclaimers | Privacy policy

Categories:

New Draft Main Page updated: 20-July-2010

Page under construction

Note: Any user supported Wiki eventually will grow to finally become unwieldy, requiring re-organization. We feel, it is time to re-organize and update the MapWindow Wiki.

Your help is very much appreciated (and required) to meet our goals.

Please post your comments and suggestions in the MapWindow Forum thread

Thank you for your patience in the past, present and future.



Page Design Status:
Currently page layout, navigation tools and page templates are under design/testing.

Page content at this stage is just a place holder for most pages.

Contents

Goals

General Principles

Goto Top of Page

Design Approach

  • Use tree structure approach allocating (dividing) pages into node, branch, twigg, ... categories
  • Use this tree structure as a framework for page navigation aids (text menus, imagemaps).


Content

File:MW_FLOW_Products.jpg
(Graph needs to be checked/updated
/replaced/imagemaped)

Goto Top of Page

Wiki Page Design (concept, hints, etc.)

These Wiki pages make use of

Each page starts with the Template:New Header and ends with Template:NewFooter

An empty page should look like this

<div>
{{New Header|lastdate=9-July-2010}} <!-- edit the date string -->
<!-- the two lines above must be kept -->
<!-- ============= Page Content =================== -->

<!-- insert page content here -->

<!-- ============= End of Page Content =================== -->
<!-- ======The two lines below must be kept=============== -->
</div>
{{NewFooter}}

The code in Template:New Header looks like this:

<!-- Template to show page Page under Construction notice
     usage:
     {{New Header|lastdate=date of creation/update of page}}
-->
<div style="float: right; color: Blue; background-color : White; border: 1px solid #0000CD; padding: 0px 5px 5px 5px; margin : 0.5em 0.5em 0.5em 1.5em; padding-left:1.5em; text-align: left; font-family : Verdana, Geneva, Arial, Helvetica, sans-serif; background-color: #F5F5DC"> 
<b>Categories:</b> <br>
<ul>
  <li>[[MapWindow Concepts]]</li>
  <li>[[MapWindow Products]]</li>
  <li>[[MapWindow Documentation]]</li>
  <li>[http://www.mapwindow.org/download.php MapWindow Downloads]</li>
  <li>[[MapWindow_GIS:Community_Portal]]</li>
  <li><span style="color:black;">Back to</span> [[New Draft Main Page]]</li>
</ul>
</div>

{{PAGENAME}} updated: {{{lastdate}}}
<!-- Keep the above and delete the below when all page are stable or close to stable -->

[[File:search.gif|thumb|110px|left]] '''Page under construction''' 

<!-- Keep the above and delete next line when pages are stable or close to stable -->

{{Template:Construction}}

----

Note: Template:New Header takes one argument when used on a page, the date of the last page update.

The user must enter the date as text string in the call to
{{New Header|lastdate=date of update}}
by hand.

For example, if the last page update happened on 10-07-2010, enter this date in any convienient form, for example

{{New Header|lastdate=July-10-2010}}


The code for Template:Construction looks like this

[[File:search.gif|thumb|110px|left]] '''Page under construction''' 

'''<span style="color:red">Note</span>:''' Any user supported Wiki eventually will grow to finally become unwieldy, requiring re-organization. We feel, it is time to re-organize and update the <b>MapWindow</b> Wiki.

'''<span style="color:red"> Your help is very much appreciated (and required) to meet our goals.</span>'''

Please post your comments and suggestions in the [http://www.mapwindow.org/phorum/read.php?5,19102 MapWindow Forum thread]

Thank you for your patience in the past, present and future.


The code for Template:NewFooter looks like this

<div style="clear : both;border-bottom : 1px #595959;"> </div>
----
Goto [[#top]]  |  [[New Draft Main Page]] | Old [[Main Page]] | [http://www.mapwindow.org MapWindow Home Page]
----


If you need to change any of these templates, use the toolbox/Special pages on the left of the screen. Look for All pages with prefix, select the Namespace Template and find the name of the template you want to edit. Double click on it, then edit and save it.


User defined HTML text menu:

For example:

Content

Code for above example:

<div style="float: right; color: Blue; border: 1px solid #0000CD; padding: 5px 5px 5px 5px; margin : 0.5em 0.5em 0.5em 1.5em; padding-left:1.5em; margin-right:1.5em; text-align: left; font-family : Verdana, Geneva, Arial, Helvetica, sans-serif; background-color: #F5F5DC;"> 
<b>Content</b> <br><ul>
  <li>[[MapWindow Software]]
    <ul>
       <li>[[MapWindow Desktop Application]]</li>
       <li>[[Programming Applications with MapWindow ActiveX]]</li>
       <li>[[Programming Plug-ins for MapWindow Desktop]]</li>
    </ul>  
</li>
  <li>[http://www.mapwindow.org/phorum/ MapWindow User Forum] (#</li>
  <li>[http://www.mapwindow.org/wiki/index.php/Main_Page MapWindow Wiki] (#</li>
  <li>[[Programming Tutorials]]</li>
</ul>
</div>

style="... ..." defines style properties of the menu (see 1st line in code window above).

style="float: left; color: Blue; ...
sets the text color to blue and lets the box float to the left of the screen.
style="float: right; color: Green; ...
sets the text color to green and lets the box float to the right of the screen.


You can change any of the style property paramters or insert others (see CSS properties documentation).

If you want to use a similar text menu on your wiki page, copy the code and paste it into your page code, then edit it to your needs.




For a semi dynamic table see examples Template:TableCol4 and Template:TableCol4Row

A Table using the Template TableCol4

Item 1 Item 2 Item 3 Item 4
Mr. Blue 555-1212 blue@company.org Last Col
Stones Water Trees Grass

The page code for this example table is

{{TableCol4
 | Rows =

{{TableCol4Row
 | Col1 = Mr. Blue
 | Col2 = 555-1212
 | Col3 = blue@company.org
 | Col4 = Last Col
}}

{{TableCol4Row
 | Col1 = Stones
 | Col2 = Water
 | Col3 = Trees
 | Col4 = Grass
}}
}}

Use these examples to modify into new templates for your needs (for example for class, properties, methods, etc. tables).

You can change the number of columns and the column titles in, e.g. Template:TableCol4 --> Template:DocuCol2 You then also must change Template:TableCol4Row to Template:DocuCol2Row and you should also change the cell names to something more explanatory.

Using these tnew templates on your page should be like the following:

{{DocuCol2
 | Rows =

{{DocuCol2Row
 | Name = AddLayer
 | Syntax = Function AddLayer(Object As Object, Visible As Boolean) As Integer
}}

{{DocuCol2Row
 | Name = ApplyLegendColors
 | Syntax = Function ApplyLegendColors(Legend As Object) As Boolean
}}

}}

To add new table rows, add blocks of the type

{{DocuCol2Row
 | Name = ApplyLegendColors
 | Syntax = Function ApplyLegendColors(Legend As Object) As Boolean
}}

See Template:DocuCol2 and Template:DocuCol2Row

and the resulting table below:

AddLayer Function AddLayer(Object As Object, Visible As Boolean) As Integer
ApplyLegendColors Function ApplyLegendColors(Legend As Object) As Boolean




Testing ActiveX Docu Detail template

Goto edit page: Template:ActiveX_Docu_Detail



Example of Documentation using this Template:


GetBounds_Example

Gets the bounds of the extents object.


VB.NET Usage

Sub GetBounds(ByRef xMin As Double, ByRef yMin As Double, ByRef zMin As Double, ByRef xMax As Double, ByRef yMax As Double, ByRef zMax As Double)


 Parameters

xMin Reference parameter. Returns the minimum x value for the extents object.
yMin Reference parameter. Returns the minimum y value for the extents object.
zMin Reference parameter. Returns the minimum z value for the extents object.
xMax Reference parameter. Returns the maximum x value for the extents object.
yMax Reference parameter. Returns the maximum y value for the extents object.
zMax Reference parameter. Returns the maximum z value for the extents object.
ReturnValue none


 Sample Code

    Private Sub ExtentsGetBounds()
        Dim extents As New MapWinGIS.Extents()
        Dim xMin As Double, yMin As Double, zMin As Double, xMax As Double, yMax As Double, zMax As Double
        'Get the bounds of the extents object
        extents.GetBounds(xMin, yMin, zMin, xMax, yMax, zMax)
    End Sub

VB 6 Usage

Sub GetBounds(ByRef xMin As Double, ByRef yMin As Double, ByRef zMin As Double, ByRef xMax As Double, ByRef yMax As Double, ByRef zMax As Double)


 Parameters

xMin Reference parameter. Returns the minimum x value for the extents object.
yMin Reference parameter. Returns the minimum y value for the extents object.
zMin Reference parameter. Returns the minimum z value for the extents object.
xMax Reference parameter. Returns the maximum x value for the extents object.
yMax Reference parameter. Returns the maximum y value for the extents object.
zMax Reference parameter. Returns the maximum z value for the extents object.
ReturnValue none


 Sample Code

    Private Sub ExtentsGetBounds()
        Dim extents As New MapWinGIS.extents
        Dim xMin As Double, yMin As Double, zMin As Double, xMax As Double, yMax As Double, zMax As Double
        'Get the bounds of the extents object
        extents.GetBounds xMin, yMin, zMin, xMax, yMax, zMax
    End Sub

C# Usage

{{{C#UsageSyntax}}}


 Parameters

{{{C#ParamTable}}}


 Sample Code

{{{C#SampleCode}}}



C++ Usage

{{{VC++tUsageSyntax}}}


 Parameters

{{{C++ParamTable}}}


 Sample Code

{{{C++SampleCode}}}




The code for this is in the box below. You can copy, paste and modify it into your documentation page.

Required modification: Remove the '!' from <!pre> and <!/pre> tags and change text between these tags.

In order to change this template call for your documentation, change text after |variablename=. For example change GetBounds in the line |FunctionName=GetBounds to the name of the function/sub you want to document.

Also, change, delete or add text blocks starting with DocuCol2Row, including the empty line before and after the block. For example text block


{{DocuCol2Row
 | Name = xMin
 | Syntax = Reference parameter. Returns the minimum x value for the extents object.
}}

could be changed to

{{DocuCol2Row
 | Name = Scale
 | Syntax = Sets/Returns Scale of shape file.
}}


Below, the wiki page code used for the GetBounds example above:


{{ActiveX Docu Detail
|FunctionName=GetBounds_Example
|FunctionDescription=Gets the bounds of the extents object.
|VBNetUsageSyntax=Sub GetBounds(ByRef xMin As Double, ByRef yMin As Double, ByRef zMin As Double, ByRef xMax As Double, ByRef yMax As Double, ByRef zMax As Double)

|VBNetParamTable=
{{DocuCol2
 | Rows =

{{DocuCol2Row
 | Name = xMin
 | Syntax = Reference parameter. Returns the minimum x value for the extents object.
}}

{{DocuCol2Row
 | Name = <font color=Green>yMin
 | Syntax = <font color=Green>Reference parameter. Returns the minimum y value for the extents object.
}}

{{DocuCol2Row
 | Name = zMin
 | Syntax = Reference parameter. Returns the minimum z value for the extents object.
}}

{{DocuCol2Row
 | Name = xMax
 | Syntax = Reference parameter. Returns the maximum x value for the extents object.
}}

{{DocuCol2Row
 | Name = yMax
 | Syntax = Reference parameter. Returns the maximum y value for the extents object.
}}

{{DocuCol2Row
 | Name = zMax
 | Syntax = Reference parameter. Returns the maximum z value for the extents object.
}}

{{DocuCol2Row
 | Name = ReturnValue
 | Syntax = none
}}

}}

|VBNetSampleCode=<!pre>
    Private Sub ExtentsGetBounds()
        Dim extents As New MapWinGIS.Extents()
        Dim xMin As Double, yMin As Double, zMin As Double, xMax As Double, yMax As Double, zMax As Double
        'Get the bounds of the extents object
        extents.GetBounds(xMin, yMin, zMin, xMax, yMax, zMax)
    End Sub
<!/pre>

|VB6UsageSyntax=Sub GetBounds(ByRef xMin As Double, ByRef yMin As Double, ByRef zMin As Double, ByRef xMax As Double, ByRef yMax As Double, ByRef zMax As Double)

|VB6ParamTable=
{{DocuCol2
 | Rows =

{{DocuCol2Row
 | Name = xMin
 | Syntax = Reference parameter. Returns the minimum x value for the extents object.
}}

{{DocuCol2Row
 | Name = yMin
 | Syntax = Reference parameter. Returns the minimum y value for the extents object.
}}

{{DocuCol2Row
 | Name = zMin
 | Syntax = Reference parameter. Returns the minimum z value for the extents object.
}}

{{DocuCol2Row
 | Name = xMax
 | Syntax = Reference parameter. Returns the maximum x value for the extents object.
}}

{{DocuCol2Row
 | Name = yMax
 | Syntax = Reference parameter. Returns the maximum y value for the extents object.
}}

{{DocuCol2Row
 | Name = zMax
 | Syntax = Reference parameter. Returns the maximum z value for the extents object.
}}

{{DocuCol2Row
 | Name = ReturnValue
 | Syntax = none
}}

}}

|VB6SampleCode=<!pre>
    Private Sub ExtentsGetBounds()
        Dim extents As New MapWinGIS.extents
        Dim xMin As Double, yMin As Double, zMin As Double, xMax As Double, yMax As Double, zMax As Double
        'Get the bounds of the extents object
        extents.GetBounds xMin, yMin, zMin, xMax, yMax, zMax
    End Sub
<!/pre>
|
}}


Goto #top | New Draft Main Page | Old Main Page | MapWindow Home Page

Retrieved from "http://mapwindow.org/wiki/index.php/New_Draft_Main_Page"

This page has been accessed 3,654 times. This page was last modified on 20 July 2010, at 11:13.