[Qgis-community-team] Doc images and github

Wed Jan 27 01:00:39 PST 2016

Others?

Else I think I'll start to do all whole rst files in working_with_vector
directory and commit in one go. So it can be reversed if we hit problems.

@Alexandre: putting ALL rst file in one dir would indeed help, but I
think we need the structure to be able to eventually build partial
documentation sets.
We could put the substitutions maybe in the index.rst files in the
directory where the images dir also is, but that would also scatter the
substitutions. Then I think having them in de file where you need them
is easiest, also because then you can move around the rst file in the
directory structure without fixing relative paths... (as long as you
copy the images also to the right place off course :-) ).

Anyway: proceed?

Richard

On 26-01-16 14:08, Otto Dassau wrote:
> Hi Richard,
> 
> thanks a lot for this grep/count. In this case I would vote for option 2: 
> 
> ..."define figures locally in the rst file where you use them. This has as
> drawback that very often used inline images (like the checkbox) are defined
> + image copied very often. BUT the nice thing about it is that IF you define
> them in the rst file, Github is able to resolve those SO they show up as
> inline images there."
> 
> Regards
> Otto
> 
> Am Mon, 25 Jan 2016 21:34:51 +0100
> schrieb Richard Duivenvoorde <richard at duif.net>:
> 
>> On 25-01-16 11:06, Alexandre Neto wrote:
>>> Not an easy choice... I'm not very fond of duplicating substitutions
>>> images as I believe it will lead to pages with different icons because
>>> someone just update one place. Maybe it would be possible to have a
>>> common place with all  images and some kind of script to copy the icons
>>> to a child forder near the rst?
>>
>> FYI, I did a quick grep/count on all substitutions over ALL docs (so not
>> only manual).
>>
>> While I agree with your point... there are not so many images used > 2
>> times...
>>
>> |nix| 45
>> |win| 15
>> |osx| 9
>> |action| 2
>> |analysis| 1
>> |attributes| 4
>> |basic_statistics| 2
>> |browsebutton| 10
>> |buffer| 2
>> |calendarwidget| 0
>> |checkbox| 41
>> |checkbox_checked| 1
>> |checkbox_unchecked| 1
>> |check_geometry| 2
>> |centroids| 2
>> |clip| 2
>> |color| 0
>> |colormap| 0
>> |columnview| 0
>> |combobox| 0
>> |commandlinkbutton| 0
>> |convex_hull| 2
>> |coordinate_capture| 2
>> |copyright_label| 2
>> |CRS| 1
>> |create_gpx| 1
>> |dateedit| 0
>> |datetimeedit| 0
>> |dbmanager| 2
>> |define_projection| 2
>> |delaunay| 2
>> |delimited_text| 2
>> |dem_analysis| 1
>> |diagram| 2
>> |dial| 0
>> |dialogbuttonbox| 0
>> |difference| 2
>> |digitising| 0
>> |dissolve| 2
>> |dockwidget| 0
>> |doublespinbox| 0
>> |dxf2shp_converter| 3
>> |edit| 4
>> |eliminate| 1
>> |event_browser| 1
>> |event_id| 3
>> |evis_connect| 2
>> |evis_file| 2
>> |export_geometry| 2
>> |export_projection| 1
>> |extract_nodes| 2
>> |fontcombobox| 0
>> |frame| 0
>> |ftools| 2
>> |fullCumulativeStretch| 1
>> |FullHistogramStretch| 1
>> |gdal| 1
>> |gdal_about| 0
>> |gdal_assign_projection| 1
>> |gdal_contour| 1
>> |gdal_dem| 1
>> |gdal_edit| 0
>> |gdal_extract_projection| 1
>> |gdal_fillnodata| 1
>> |gdal_grid| 1
>> |gdal_merge| 1
>> |gdal_nearblack| 1
>> |gdal_polygonize| 1
>> |gdal_proximity| 1
>> |gdal_raster-clip| 1
>> |gdal_raster-overview| 1
>> |gdal_raster-paletted| 0
>> |gdal_raster-rgb| 1
>> |gdal_rasterize| 1
>> |gdal_reset| 0
>> |gdal_sieve| 1
>> |gdal_tileindex| 1
>> |gdal_tooltip| 0
>> |gdal_translate| 1
>> |gdal_vrt| 1
>> |gdal_warp| 1
>> |general| 2
>> |gentlelogo| 10
>> |geographic| 3
>> |geometry| 1
>> |geometrychecker| 2
>> |geometrysnapper| 2
>> |geoprocessing| 2
>> |georeferencer| 1
>> |geRasterometry| 0
>> |gps_importer| 2
>> |gpstrack_barchart| 2
>> |gpstrack_polarchart| 2
>> |graphicsview| 0
>> |grass| 2
>> |grass_close_mapset| 2
>> |grass_location| 1
>> |grass_new_mapset| 3
>> |grass_open_mapset| 2
>> |grass_region| 2
>> |grass_set_region| 1
>> |grass_region_edit| 1
>> |grass_tools| 3
>> |groupbox| 0
>> |groupboxcollapsible| 0
>> |heatmap| 4
>> |histogram| 0
>> |hscrollbar| 0
>> |hslider| 0
>> |hsplit| 0
>> |iconAboutConsole| 0
>> |iconClassBrowserConsole| 0
>> |iconClassConsole| 0
>> |iconClassTreeWidgetConsole| 0
>> |iconClearConsole| 0
>> |iconCloseTabEditorConsole| 0
>> |iconCodepadConsole| 0
>> |iconCommentEditorConsole| 0
>> |iconCopyEditorConsole| 0
>> |iconCutEditorConsole| 0
>> |iconFileTabsMenuConsole| 0
>> |iconFunctionTreeWidgetConsole| 0
>> |iconHelpConsole| 0
>> |iconHideToolConsole| 0
>> |iconIfaceConsole| 0
>> |iconMethodTreeWidgetConsole| 0
>> |iconNewTabEditorConsole| 0
>> |iconOpenConsole| 0
>> |iconPasteEditorConsole| 0
>> |iconQtCoreConsole| 0
>> |iconQtGuiConsole| 0
>> |iconRestoreTabsConsole| 0
>> |iconRunConsole| 0
>> |iconRunScriptConsole| 0
>> |iconSaveAsConsole| 0
>> |iconSaveConsole| 0
>> |iconScriptConsole| 0
>> |iconSettingsConsole| 0
>> |icon_newgpx| 1
>> |icon_dbmanager| 3
>> |icon_zonal_statistics| 1
>> |import_gpx| 1
>> |inputtext| 2
>> |interpolation| 2
>> |intersect| 2
>> |intersections| 2
>> |join| 2
>> |join_location| 2
>> |labels| 1
>> |layer_extent| 2
>> |locale| 1
>> |locked| 2
>> |mAction| 3
>> |mActionAdd| 1
>> |mActionAddAllToOverview| 2
>> |mActionAddArrow| 3
>> |mActionAddBasicShape| 3
>> |mActionAddDelimitedTextLayer| 0
>> |mActionAddGCPPoint| 1
>> |mActionAddHtml| 2
>> |mActionAddImage| 3
>> |mActionAddLayer| 1
>> |mActionAddLegend| 5
>> |mActionAddMap| 6
>> |mActionAddMssqlLayer| 2
>> |mActionAddNonDbLayer| 1
>> |mActionAddOgrLayer| 4
>> |mActionAddOracleLayer| 1
>> |mActionAddPart| 4
>> |mActionAddPostgisLayer| 2
>> |mActionAddRasterLayer| 7
>> |mActionAddRing| 4
>> |mActionAddSpatiaLiteLayer| 3
>> |mActionAddWmsLayer| 3
>> |mActionAlignBottom| 2
>> |mActionAlignHCenter| 2
>> |mActionAlignLeft| 4
>> |mActionAlignRight| 2
>> |mActionAlignTop| 2
>> |mActionAlignVCenter| 2
>> |mActionAllEdits| 2
>> |mActionAnnotation| 2
>> |mActionArrowDown| 1
>> |mActionArrowLeft| 0
>> |mActionArrowRight| 1
>> |mActionArrowUp| 0
>> |mActionAtlasFirst| 2
>> |mActionAtlasLast| 2
>> |mActionAtlasNext| 2
>> |mActionAtlasPrev| 2
>> |mActionAtlasSettings| 1
>> |mActionCancelEdits| 1
>> |mActionCalculateField| 6
>> |mActionCaptureBoundary| 1
>> |mActionCaptureCentroid| 1
>> |mActionCaptureLine| 4
>> |mActionCapturePoint| 4
>> |mActionCapturePolygon| 5
>> |mActionChangeLabelProperties| 2
>> |mActionCheckQgisVersion| 2
>> |mActionCollapseTree| 2
>> |mActionComposerManager| 4
>> |mActionContextHelp| 1
>> |mActionCopySelected| 3
>> |mActionCustomProjection| 3
>> |mActionDeleteAttribute| 3
>> |mActionDeleteGCPPoint| 1
>> |mActionDeletePart| 4
>> |mActionDeleteRing| 4
>> |mActionDeleteSelected| 4
>> |mActionDeselectAll| 2
>> |mActionDraw| 5
>> |mActionDupComposer| 2
>> |mActionDuplicateLayer| 1
>> |mActionEditCopy| 5
>> |mActionEditCut| 4
>> |mActionEditPaste| 4
>> |mActionExpandNewTree| 2
>> |mActionExpandTree| 2
>> |mActionExportMapServer| 1
>> |mActionFileExit| 2
>> |mActionFileNew| 3
>> |mActionFileOpen| 6
>> |mActionFilePrint| 5
>> |mActionFileSave| 6
>> |mActionFileSaveAs| 9
>> |mActionFillRing| 2
>> |mActionFilter| 1
>> |mActionFolder| 2
>> |mActionFormAnnotation| 2
>> |mActionFullHistogramStretch| 1
>> |mActionGDALScript| 2
>> |mActionGroupItems| 2
>> |mActionHelpAbout| 2
>> |mActionHelpContents| 2
>> |mActionHelpSponsors| 2
>> |mActionHideAllLayers| 2
>> |mActionmIconExpressionEditorOpen| 1
>> |mActionIdentify| 6
>> |mActionInOverview| 2
>> |mActionInvertSelection| 2
>> |mActionLabel| 4
>> |mActionLabeling| 4
>> |mActionLink| 1
>> |mActionLinkGeorefToQGis| 2
>> |mActionLinkQGisToGeoref| 2
>> |mActionLoadGCPpoints| 1
>> |mActionLocalHistogramStretch| 1
>> |mActionLowerItems| 2
>> |mActionMapTips| 3
>> |mActionMeasure| 3
>> |mActionMeasureAngle| 2
>> |mActionMeasureArea| 2
>> |mActionMergeFeatAttributes| 3
>> |mActionMergeFeatures| 3
>> |mActionMoveFeature| 4
>> |mActionMoveGCPPoint| 1
>> |mActionMoveItemContent| 4
>> |mActionMoveItemsToBottom| 2
>> |mActionMoveItemsToTop| 2
>> |mActionMoveLabel| 2
>> |mActionNewAttribute| 3
>> |mActionNewBookmark| 2
>> |mActionNewComposer| 6
>> |mActionNewSpatiaLiteLayer| 2
>> |mActionNewVectorLayer| 3
>> |mActionNodeTool| 4
>> |mActionOffsetCurve| 4
>> |mActionOpenRaster| 0
>> |mActionOpenTable| 7
>> |mActionOptions| 9
>> |mActionPan| 6
>> |mActionPinLabels| 1
>> |mActionProjectProperties| 3
>> |mActionPropertyItem| 2
>> |mActionQgisHomePage| 2
>> |mActionRaiseItems| 3
>> |mActionRedo| 5
>> |mActionRemove| 1
>> |mActionRemoveAllFromOverview| 1
>> |mActionRemoveLayer| 3
>> |mActionReshape| 4
>> |mActionRollbackEdits| 1
>> |mActionRotateFeature| 1
>> |mActionRotateLabel| 1
>> |mActionRotatePointSymbols| 3
>> |mActionSaveAsPDF| 4
>> |mActionSaveAsSVG| 5
>> |mActionSaveEdits| 3
>> |mActionSaveGCPpointsAs| 1
>> |mActionSaveMapAsImage| 6
>> |mActionScaleBar| 4
>> |mActionSelect| 10
>> |mActionSelectFreehand| 2
>> |mActionSelectPan| 1
>> |mActionSelectPolygon| 2
>> |mActionSelectRadius| 2
>> |mActionSelectRectangle| 2
>> |mActionSelectedToTop| 2
>> |mActionShowAllLayers| 3
>> |mActionShowBookmarks| 2
>> |mActionShowHideLabels| 1
>> |mActionShowPinnedLabels| 1
>> |mActionShowPluginManager| 6
>> |mActionShowPresets| 3
>> |mActionSignMinus| 3
>> |mActionSignPlus| 6
>> |mActionSimplify| 4
>> |mActionSplitFeatures| 5
>> |mActionSplitParts| 3
>> |mActionStartGeoref| 2
>> |mActionTextAnnotation| 2
>> |mActionToggleEditing| 6
>> |mActionTouch| 1
>> |mActionTransformSettings| 2
>> |mActionUndo| 5
>> |mActionUnGroupItems| 1
>> |mActionUnlink| 1
>> |mActionUnselectAttributes| 1
>> |mActionWhatsThis| 2
>> |mActionZoomActual| 3
>> |mActionZoomFullExtent| 5
>> |mActionZoomIn| 8
>> |mActionZoomLast| 3
>> |mActionZoomNext| 3
>> |mActionZoomOut| 8
>> |mActionZoomToLayer| 4
>> |mActionZoomToSelected| 4
>> |management| 1
>> |mapserver_export| 1
>> |matrix| 2
>> |mean| 2
>> |merge_shapes| 2
>> |metadata| 2
>> |metasearch| 2
>> |mGeorefRun| 1
>> |mIconAtlas| 3
>> |mIconColorBox| 2
>> |mIconColorPicker| 2
>> |mIconColorSwatches| 2
>> |mIconColorWheel| 2
>> |mIconDataDefine| 6
>> |mIconExpression| 1
>> |mIconExpressionSelect| 4
>> |mIconImport| 1
>> |mIconLock| 2
>> |mIconNew| 2
>> |mIconProjectionDisabled| 2
>> |mIconProjectionEnabled| 3
>> |mIconRasterGroup| 1
>> |mIconRasterLink| 1
>> |mIconStopRendering| 1
>> |mIconZip| 1
>> |multi_to_single| 2
>> |neighbor| 2
>> |north_arrow| 2
>> |offline_editing_copy| 3
>> |offline_editing_sync| 2
>> |oracle_raster| 3
>> |osm_addRelation| 1
>> |osm_createLine| 1
>> |osm_createPoint| 1
>> |osm_createPolygon| 1
>> |osm_createRelation| 1
>> |osm_download| 1
>> |osm_editRelation| 1
>> |osm_featureManager| 1
>> |osm_generateTags| 1
>> |osm_identify| 1
>> |osm_import| 1
>> |osm_load| 1
>> |osm_move| 1
>> |osm_questionMark| 1
>> |osm_removeFeat| 1
>> |osm_removeTag| 0
>> |osm_save| 1
>> |osm_upload| 0
>> |PanToSelected| 3
>> |pencil| 2
>> |plugin| 3
>> |plugin_installed| 1
>> |plugin_installer| 2
>> |plugin_upgrade| 1
>> |proc_commander| 1
>> |proc_history| 1
>> |proc_model| 1
>> |proc_option| 1
>> |proc_result| 1
>> |proc_toolbox| 1
>> |qgissplash| 0
>> |radiobuttonon| 15
>> |radiobuttonoff| 10
>> |random_points| 2
>> |random_selection| 2
>> |raster-info| 3
>> |raster-interpolate| 2
>> |raster-stats| 2
>> |raster_terrain| 2
>> |regular_points| 2
>> |RemoveAllOVerview| 2
>> |roadgraph| 1
>> |sampling| 1
>> |scale_bar| 2
>> |selectcolor| 3
>> |selectcreatelayer| 2
>> |selectnumber| 9
>> |selectstring| 17
>> |selectesubsetlayer| 2
>> |select_location| 2
>> |ShowRasterCalculator| 1
>> |single_to_multi| 2
>> |slider| 6
>> |spatialquery| 3
>> |spiticon| 2
>> |split_layer| 2
>> |sub_selection| 2
>> |sum_lines| 2
>> |sum_points| 2
>> |sym_difference| 2
>> |symbology| 1
>> |simplify| 2
>> |tab| 1
>> |to_lines| 2
>> |topologychecker| 2
>> |tracking| 2
>> |transformed| 1
>> |union| 2
>> |unique| 2
>> |unlocked| 2
>> |user| 1
>> |vector_grid| 2
>> |wcs| 1
>> |wfs| 4
>> _______________________________________________
>> Qgis-community-team mailing list for organizing community resources such
>> as documentation, translation etc.. Qgis-community-team at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
> 