#5435 closed task (fixed)

localize cheatsheets

Reported by: robe Owned by: robe
Priority: medium Milestone: PostGIS 3.4.0
Component: documentation Version: master
Keywords: Cc:

Description

Pushing this for 3.5.0 no rush on it.

The cheatsheets are generated using xls style sheets.

https://postgis.net/docs//manual-3.4/postgis_cheatsheet.html https://postgis.net/docs//manual-3.4/topology_cheatsheet.html https://postgis.net/docs//manual-3.4/raster_cheatsheet.html https://postgis.net/docs//manual-3.4/sfcgal_cheatsheet.html https://postgis.net/docs//manual-3.4/tiger_geocoder_cheatsheet.html

Since all of it except the top footnote detail part (which can be moved into maybe the xls-conf.xml) or refactored to use existing text.

It should be doable.

Change History (19)

comment:1 by Sandro Santilli <strk@…>, 13 months ago

In f5fd56c/git:

Localize cheatsheets

References #5435

comment:2 by strk, 13 months ago

Type: defecttask

comment:3 by Sandro Santilli <strk@…>, 13 months ago

In 0e64e28/git:

Add cheatsheet-install rule and fix cheatsheet build/install off-tree

References #5435

comment:4 by Sandro Santilli <strk@…>, 13 months ago

In f5f62d7/git:

[debbie] install cheatsheets too

References #5435

comment:5 by strk, 13 months ago

Should the links to official documentation also be localized, at this point ? Right now we find links to https://postgis.net/docs/manual-3.4/PostGIS_Full_Version.html but in postgis_cheatsheet-fr.html it should probably go to https://postgis.net/docs/manual-3.4/fr/PostGIS_Full_Version.html

comment:6 by robe, 13 months ago

Milestone: PostGIS 3.5.0PostGIS 3.4.0

@strk it seems you are done with this task aside from the title at the top.

New in this release 1 Enhanced in this release 2 Requires GEOS 3.9 or higherg3.9 aggregate agg 2.5/3D support3d SQL-MMmm Supports geography G

That we can fix I guess by moving stuff to the xsl-config I think.

So I'm switching this back to 3.4, since seems we'll be done with it before 3.4 release. I'm tempted to just mark it done as it is.

comment:7 by strk, 13 months ago

I suspect there's more to do, like we're using the "Enhanced" text matching to find out enhanced, rather than the attributes. This should result in less item shown for non-english.

comment:8 by Sandro Santilli <strk@…>, 13 months ago

In 4c7fc01/git:

Use html output rather than text for postgis_cheatsheet

Moves toward easier internationalization of headers
References #5435

comment:9 by Sandro Santilli <strk@…>, 13 months ago

In 6c9adfa/git:

Make postgis cheatsheet legend translatable

See #5435

comment:10 by Sandro Santilli <strk@…>, 13 months ago

In f33f2fb/git:

Refactor topology cheatsheet to also share templates

References #5435

comment:11 by Sandro Santilli <strk@…>, 13 months ago

In b7e9771/git:

Refactor tiger geocoder cheatsheet to use shared templates

References #5435

comment:12 by Sandro Santilli <strk@…>, 13 months ago

In d92ef78/git:

Refactor sfcgal cheatsheet to use shared templates

References #5435

comment:13 by strk, 13 months ago

As of [77dc645cfc9b252f768fdf14499a421b92b20f0f/git] the header is translatable. The problem I reported in comment:7 is confirmed:

$ grep -c '<sup>1</sup>' html/postgis_cheatsheet-{en,fr}.html
html/postgis_cheatsheet-en.html:15
html/postgis_cheatsheet-fr.html:2

Once that is fixed we can close this ticket

comment:14 by Sandro Santilli <strk@…>, 13 months ago

In 2c159bc/git:

Fix cheatsheet conformance labeling for translated versions

References #5435

comment:15 by strk, 13 months ago

With [2c159bc11da0a5e62c4f8a68f07dbf3815e39dbc/git] the extraction of those tags is also fixed. I guess we could add a testing rule to verify the count is the same for all tags in all translations, compared to the english version

comment:16 by strk, 13 months ago

I've added a check-cheatsheets-localized makefile target which currently finds some problem with the G tag (geography support) being inconsistent between languages. It's currently NOT run automatically by any bot, might be eventually

comment:17 by strk, 13 months ago

Next issue we have is formalization of the requires GEOS > 3.9 snippet, which is currently used by cheatsheet xsl and broken when translated.

Formalization would also be useful to really specify what it means. Right now it's sometimes associated with "availability" and sometimes with "enhanced" tag:

reference_overlay.xml:        <para role="enhanced" conformance="3.1.0">Enhanced: 3.1.0 accept a gridSize parameter - requires GEOS &gt;= 3.9.0</para>
reference_overlay.xml:        <para role="enhanced" conformance="3.1.0">Enhanced: 3.1.0 accept a gridSize parameter - requires GEOS &gt;= 3.9.0</para>
reference_overlay.xml:        <para role="enhanced" conformance="3.1.0">Enhanced: 3.1.0 accept a gridSize parameter, requires GEOS &gt;= 3.9.0 to use this new feature.</para>
reference_overlay.xml:        <para role="enhanced" conformance="3.1.0">Enhanced: 3.1.0 accept a gridSize parameter - requires GEOS &gt;= 3.9.0</para>
reference_overlay.xml:        <para role="enhanced" conformance="3.1.0">Enhanced: 3.1.0 accept a gridSize parameter - requires GEOS &gt;= 3.9.0</para>
reference_overlay.xml:    <para role="enhanced" conformance="3.1.0">Enhanced: 3.1.0 accept a gridSize parameter - requires GEOS &gt;= 3.9.0</para>
reference_processing.xml:        <para role="availability" conformance="3.1.0">Availability: 3.1.0 - requires GEOS &gt;= 3.9.0.</para>
reference_processing.xml:        <para role="availability" conformance="3.4.0">Availability: 3.4.0 - requires GEOS &gt;= 3.9.0.</para>
reference_processing.xml:        <para role="availability" conformance="3.1.0">Availability: 3.1.0 - requires GEOS &gt;= 3.9.0. </para>

I guess it means it requires that version of GEOS _only_ to use that specific new feature ?

How about completely dropping this indication from the cheatsheets ?

comment:18 by strk, 13 months ago

For the record, current GEOS stable release is 3.12: http://libgeos.org/usage/download/

comment:19 by strk, 13 months ago

Resolution: fixed
Status: newclosed

With 351ebe16f001a51a87fdc41fac459eebe5c240e0 we have formalized geos_requirement role attribute, which makes the check-cheatsheets-localized makefile target turn green !

I'm closing this ticket as completed. Any further bug is worth its own ticket.

Note: See TracTickets for help on using tickets.