[mapguide-commits] r10067 - in branches/4.0/MgDev/Doc: . landing landing/topics mdpreprocess
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Fri Nov 10 11:16:00 PST 2023
Author: jng
Date: 2023-11-10 11:15:59 -0800 (Fri, 10 Nov 2023)
New Revision: 10067
Added:
branches/4.0/MgDev/Doc/landing/topics/TODO.md
branches/4.0/MgDev/Doc/landing/topics/toc.yml
Removed:
branches/4.0/MgDev/Doc/landing/TODO.md
Modified:
branches/4.0/MgDev/Doc/build.bat
branches/4.0/MgDev/Doc/landing/toc.yml
branches/4.0/MgDev/Doc/landing/topics/
branches/4.0/MgDev/Doc/landing/topics/collections.md.tpl
branches/4.0/MgDev/Doc/landing/topics/cs-testvalues.md.tpl
branches/4.0/MgDev/Doc/landing/topics/geom-collections.md.tpl
branches/4.0/MgDev/Doc/mdpreprocess/Program.cs
Log:
#2877:
- Re-org conceptual topic TOC and fix up some of the migrated topic content
- Run mdpreprocess before the landing site docfx build
Modified: branches/4.0/MgDev/Doc/build.bat
===================================================================
--- branches/4.0/MgDev/Doc/build.bat 2023-11-10 18:55:22 UTC (rev 10066)
+++ branches/4.0/MgDev/Doc/build.bat 2023-11-10 19:15:59 UTC (rev 10067)
@@ -11,6 +11,9 @@
REM TODO: These errors will go away by fixing the comments in question at the C++ source
javadoc -d ..\..\..\..\Doc\landing\_site\java_api org.osgeo.mapguide -overview ..\..\..\..\Doc\java_api\overview.html -windowtitle "MapGuide Java API reference (%LABEL%)"
popd
+pushd mdpreprocess
+dotnet run -- ..\landing\topics
+popd
pushd landing
docfx build
popd
Deleted: branches/4.0/MgDev/Doc/landing/TODO.md
===================================================================
--- branches/4.0/MgDev/Doc/landing/TODO.md 2023-11-10 18:55:22 UTC (rev 10066)
+++ branches/4.0/MgDev/Doc/landing/TODO.md 2023-11-10 19:15:59 UTC (rev 10067)
@@ -1,3 +0,0 @@
-# TODO
-
-Oops! If you got here it means we haven't updated the original link
\ No newline at end of file
Modified: branches/4.0/MgDev/Doc/landing/toc.yml
===================================================================
--- branches/4.0/MgDev/Doc/landing/toc.yml 2023-11-10 18:55:22 UTC (rev 10066)
+++ branches/4.0/MgDev/Doc/landing/toc.yml 2023-11-10 19:15:59 UTC (rev 10067)
@@ -1,35 +1,3 @@
# TODO: Link to conceptual topics once they've all been migrated to markdown and copied into this dir
-#- name: Introduction
-# href: introduction.md
-#- name: Getting Started
-# href: getting-started.md
-- name: Collections
- href: collections.md
-- name: Feature Service
- items:
- - name: Feature Properties
- href: feature-properties.md
-- name: Geometry
- items:
- - name: Collections
- href: geom-collections.md
-- name: Coordinate System
- items:
- - name: Test values
- href: cs-testvalues.md
- - name: WKT to SRS
- href: cs-wkttosrs.md
-- name: Bibliography
- items:
- - name: Dana99
- href: bib-dana99.md
- - name: Egenhofer91
- href: bib-egenhofer91.md
- - name: OGC96015R1
- href: bib-ogc96-015r1.md
- - name: OGC99049
- href: bib-ogc99-049.md
- - name: OSUGR
- href: bib-osugr.md
- - name: Peat
- href: bib-peat.md
+- name: Conceptual Topics
+ href: topics/toc.yml
\ No newline at end of file
Index: branches/4.0/MgDev/Doc/landing/topics
===================================================================
--- branches/4.0/MgDev/Doc/landing/topics 2023-11-10 18:55:22 UTC (rev 10066)
+++ branches/4.0/MgDev/Doc/landing/topics 2023-11-10 19:15:59 UTC (rev 10067)
Property changes on: branches/4.0/MgDev/Doc/landing/topics
___________________________________________________________________
Added: svn:ignore
## -0,0 +1 ##
+*.md
Copied: branches/4.0/MgDev/Doc/landing/topics/TODO.md (from rev 10066, branches/4.0/MgDev/Doc/landing/TODO.md)
===================================================================
--- branches/4.0/MgDev/Doc/landing/topics/TODO.md (rev 0)
+++ branches/4.0/MgDev/Doc/landing/topics/TODO.md 2023-11-10 19:15:59 UTC (rev 10067)
@@ -0,0 +1,3 @@
+# TODO
+
+Oops! If you got here it means we haven't updated the original link
\ No newline at end of file
Modified: branches/4.0/MgDev/Doc/landing/topics/collections.md.tpl
===================================================================
--- branches/4.0/MgDev/Doc/landing/topics/collections.md.tpl 2023-11-10 18:55:22 UTC (rev 10066)
+++ branches/4.0/MgDev/Doc/landing/topics/collections.md.tpl 2023-11-10 19:15:59 UTC (rev 10067)
@@ -1,18 +1,14 @@
# Collections
-<p>
- One of the functions of collections is to serve as a repository for
- intermediate results. In this role, a collection is a helper class. An
- example is the construction of an MgLineString geometry. From the
- perspective of construction, this geometry is a set of coordinates. The
- sequence of construction is:
-</p>
-<ol>
- <li>create a coordinate</li>
- <li>add coordinate to coordinate collection</li>
- <li>do 1 and 2 until all coordinates created</li>
- <li>create the line string using coordinate collection</li>
-</ol>
-<p>
- See [Geometry Collections](geom-collections.md) for the list of collections used in the construction of geometries.
-</p>
\ No newline at end of file
+One of the functions of collections is to serve as a repository for
+intermediate results. In this role, a collection is a helper class. An
+example is the construction of an `MgLineString` [!doclinkclass MgLineString] geometry. From the
+perspective of construction, this geometry is a set of coordinates. The
+sequence of construction is:
+
+1. create a coordinate
+2. add coordinate to coordinate collection
+3. do 1 and 2 until all coordinates created
+4. create the line string using coordinate collection
+
+See [Geometry Collections](geom-collections.md) for the list of collections used in the construction of geometries.
\ No newline at end of file
Modified: branches/4.0/MgDev/Doc/landing/topics/cs-testvalues.md.tpl
===================================================================
--- branches/4.0/MgDev/Doc/landing/topics/cs-testvalues.md.tpl 2023-11-10 18:55:22 UTC (rev 10066)
+++ branches/4.0/MgDev/Doc/landing/topics/cs-testvalues.md.tpl 2023-11-10 19:15:59 UTC (rev 10067)
@@ -64,6 +64,7 @@
0.01745329251994330.
</p>
+
```
GEOGCS [
"LL83",
@@ -105,6 +106,7 @@
be converted to meters by applying the scalar factor of
1.000000000000.
</p>
+
```
SQL\> select cs_name,srid, wktext from mdsys.cs_srs where srid = 82217;
cs_name=UTM Zone 11 (NAD 83)
@@ -151,6 +153,7 @@
]
]
```
+
<h3>Used in the C# Sample Code</h3>
<p>
The following well-known text represents a projected
@@ -168,6 +171,7 @@
The unit of measurement is a linear type whose name is "Meter", which can
be converted to meters by applying the scalar factor of 1.000000000000.
</p>
+
```
PROJCS[
"UTM83-4",
@@ -219,6 +223,7 @@
]
]
```
+
<h2> Arbitrary Coordinate System </h2>
<p>
The following well-known text represents a local,
Modified: branches/4.0/MgDev/Doc/landing/topics/geom-collections.md.tpl
===================================================================
--- branches/4.0/MgDev/Doc/landing/topics/geom-collections.md.tpl 2023-11-10 18:55:22 UTC (rev 10066)
+++ branches/4.0/MgDev/Doc/landing/topics/geom-collections.md.tpl 2023-11-10 19:15:59 UTC (rev 10067)
@@ -2,16 +2,16 @@
The following collection classes are used by `MgGeometryFactory` methods in the construction of geometries and geometry components. See the `MgGeometryFactory` description [!doclinkclass MgGeometryFactory] for discussion and illustration of this use.
-| Class | |
-|-----------------------------|--------|
-|MgCoordinateCollection |[!doclinkclass MgCoordinateCollection]|
-|MgCurvePolygonCollection |[!doclinkclass MgCurvePolygonCollection]|
-|MgCurveRingCollection |[!doclinkclass MgCurveRingCollection]|
-|MgCurveSegmentCollection |[!doclinkclass MgCurveSegmentCollection]|
-|MgCurveStringCollection |[!doclinkclass MgCurveStringCollection]|
-|MgGeometryCollection |[!doclinkclass MgGeometryCollection]|
-|MgGeometryComponentCollection|[!doclinkclass MgGeometryComponentCollection]|
-|MgLinearRingCollection |[!doclinkclass MgLinearRingCollection]|
-|MgLineStringCollection |[!doclinkclass MgLineStringCollection]|
-|MgPointCollection |[!doclinkclass MgPointCollection]|
-|MgPolygonCollection |[!doclinkclass MgPolygonCollection]|
\ No newline at end of file
+| Class | |
+|-------------------------------|--------|
+|`MgCoordinateCollection` |[!doclinkclass MgCoordinateCollection]|
+|`MgCurvePolygonCollection` |[!doclinkclass MgCurvePolygonCollection]|
+|`MgCurveRingCollection` |[!doclinkclass MgCurveRingCollection]|
+|`MgCurveSegmentCollection` |[!doclinkclass MgCurveSegmentCollection]|
+|`MgCurveStringCollection` |[!doclinkclass MgCurveStringCollection]|
+|`MgGeometryCollection` |[!doclinkclass MgGeometryCollection]|
+|`MgGeometryComponentCollection`|[!doclinkclass MgGeometryComponentCollection]|
+|`MgLinearRingCollection` |[!doclinkclass MgLinearRingCollection]|
+|`MgLineStringCollection` |[!doclinkclass MgLineStringCollection]|
+|`MgPointCollection` |[!doclinkclass MgPointCollection]|
+|`MgPolygonCollection` |[!doclinkclass MgPolygonCollection]|
\ No newline at end of file
Added: branches/4.0/MgDev/Doc/landing/topics/toc.yml
===================================================================
--- branches/4.0/MgDev/Doc/landing/topics/toc.yml (rev 0)
+++ branches/4.0/MgDev/Doc/landing/topics/toc.yml 2023-11-10 19:15:59 UTC (rev 10067)
@@ -0,0 +1,35 @@
+# TODO: Link to conceptual topics once they've all been migrated to markdown and copied into this dir
+#- name: Introduction
+# href: introduction.md
+#- name: Getting Started
+# href: getting-started.md
+- name: Collections
+ href: collections.md
+- name: Feature Service
+ items:
+ - name: Feature Properties
+ href: feature-properties.md
+- name: Geometry
+ items:
+ - name: Collections
+ href: geom-collections.md
+- name: Coordinate System
+ items:
+ - name: Test values
+ href: cs-testvalues.md
+ - name: WKT to SRS
+ href: cs-wkttosrs.md
+- name: Bibliography
+ items:
+ - name: Dana99
+ href: bib-dana99.md
+ - name: Egenhofer91
+ href: bib-egenhofer91.md
+ - name: OGC96015R1
+ href: bib-ogc96-015r1.md
+ - name: OGC99049
+ href: bib-ogc99-049.md
+ - name: OSUGR
+ href: bib-osugr.md
+ - name: Peat
+ href: bib-peat.md
Modified: branches/4.0/MgDev/Doc/mdpreprocess/Program.cs
===================================================================
--- branches/4.0/MgDev/Doc/mdpreprocess/Program.cs 2023-11-10 18:55:22 UTC (rev 10066)
+++ branches/4.0/MgDev/Doc/mdpreprocess/Program.cs 2023-11-10 19:15:59 UTC (rev 10067)
@@ -12,7 +12,7 @@
return 1;
}
var files = Directory.GetFiles(args[0], "*.md.tpl");
-var macroRegex = new Regex(@"\[(!doclinkclass )?([^]]+)\]");
+var macroRegex = new Regex(@"\[(!doclinkclass ){1}([^]]+)\]");
var evaluator = new MatchEvaluator(GenerateFragment);
foreach (var f in files)
{
@@ -30,5 +30,6 @@
static string GenerateFragment(Match match)
{
// Groups[2] contains the class name
- return $"([.net](dotnet_api/api/OSGeo.MapGuide.{match.Groups[2].Value}.html),[Java](java_api/org/osgeo/mapguide/{match.Groups[2].Value}.html),[PHP](TODO.md))";
+ var relPrefix = "../"; // Currently assuming that we're processing everything under ../landing/topics
+ return $"([.net]({relPrefix}dotnet_api/api/OSGeo.MapGuide.{match.Groups[2].Value}.html), [Java]({relPrefix}java_api/org/osgeo/mapguide/{match.Groups[2].Value}.html), [PHP](TODO.md))";
}
\ No newline at end of file
More information about the mapguide-commits
mailing list