Code Monkey home page Code Monkey logo

cgeo-guide's Introduction

cgeo-guide

Snapshot of the c:geo DokuWiki user guide.

This repository is only for backup purposes. Updates to the user guide are done directly on its website https://manual.cgeo.org

Background

This repository is used as a backup of the relevant content and DokuWiki configuration files of the c:geo user guide installation running at https://manual.cgeo.org As the current server installation is owned and maintained privately by a c:geo team member (Lineflyer) it might be wise to have a backup available in case of need.

Content of this repository

  • /data/pages - Contains the current content pages
  • /data/meta - Contains meta information of the pages
  • /data/media - Contains the current media files (Images and other files uploaded to the Wiki)
  • /data/media_meta - Meta data for the media
  • /data/attic - All old versions of the content pages
  • /data/media_attic - All the old versions of media files
  • /conf - Some relevant configuration data (without confidential information)

Update of the repository

The repository is updated manually from time to time by pushing a snapshot of the current state of the server content as a backup. This backup follows the guide for content backup as described here: https://www.dokuwiki.org/start?id=faq:backup

Usage of Issues for this repository

The issue section of this repository is used (primarily by c:geo team members) to document needed corrections or additions to the user guide. It serves as a kind of ToDo list for maintainers of the user guide. The available issue labels should be used to classify the issue (e.g. Correction, Addition). Additionally milestones can be assigned to issues as a marker what release of c:geo is triggering the needed change (e.g. a new feature should only be added once the c:geo release, where it is contained is about to be or has been released).

Restoring data to DokuWiki

In case of need the content of this repository can be used to restore the content data (texts, media) and their meta data and history. Configuration details (such as styles and themes) and user accounts are however not covered by this repository and need to be set up manually. Corresponding installation and configuration guides and the DokuWiki software itself can be found on https://www.dokuwiki.org

Useful information

Other useful information to restore a working DokuWiki with similar functions and styles. Not all of this is needed to restore basic functionality. Information considered relevant to restore (e.g. as it might be used on page syntax) is marked by an asterik (*).

  • Used sytle templates:
    • adoradark
  • Used plugins:
    • Anchor(*)
    • Batchedit
    • Bookcreator
    • Color
    • dw2pdf(*)
    • goto(*)
    • oauth (for Github)
    • orphanswanted
    • revert
    • wrap(*)
    • indexmenu(*)
    • enforcesummary
    • anonip

cgeo-guide's People

Contributors

lineflyer avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cgeo-guide's Issues

DNF support

DNF smiley is already mentioned in the user guide (but refered to as only available for offline logged DNF).
Meanwhile we support online DNF on map and in cache details

Update compact icon description

The compact iconmode on map now provides more info than before.
Need to check whether this is described in the user guide (so it might need change). If its not yet described, its probably enough to just leave it like it is and only have the information, that "enabling compact mode shows smaller cache/waypoint icons with bit less information".

Language selection

Instead of "force english" it is now possible to explicitly set the desired app language in settings

Include new filter

  • Old filter needs to be removed from manual
  • New filter needs to be added. It might not be needed to explain all filters (as this is much effort and might change frequently) but the construction methods of adding elements, the interworking (AND), the options (like negation) and save/load filters.

While the old filter is AFAIR described as element on the page describing cache lists, the new filter deservers an own page in the guide (to be linked from list and map).

Describe basic map downloader

The usage guide currently only describes manual download and installation.
Now that we have the basic download function this should also be described on that very page (two options to get offline maps: Manual or use built-in downloader)

User guide for device replacement

Menus have slightly changed
User can now also migrate settings

Alternatively this topic should move to the users manual, instead of an even longer FAQ entry.
The FAQ should then just link to the users manual.

Have a page for help on login issues

Some months ago I changed https://manual.cgeo.org/en/firststeps as a guide through our wizard, which makes sense.

But I also linked to that page if (new) users contacted us and it was visible from system information, that they did not authorize to any geocaching platform. the old version was very suitable for that, the new wizard help is not matching this problem case.

I could imagine a page which includes the following items:
How to login if the main screen shows, that I am not connected, which includes initial authorization as well as handling of the possible error messages (currently only explained in FAQ)

Improve "Cache markers" page

Several idea for https://manual.cgeo.org/en/cachemarkers

  • add a cache marker with all 4 positions used (e.g. mystery with found log, note, corrected coords, stored) to explain about markers and positions in general (related to 2)

  • structure the table by icon position
    image

upper-left: Log and Offline log icons
upper-right: Stored / Owned
lower-right: Coordinate info
lower-left: Note

  • add missing "will attend" marker
  • for "Final existing" in "Marker (old)" column add the red flag
  • Change texts:
    "Modified coordinates" text: "The coordinates of this cache have been modified from the original listing coordinates (either from within c:geo when defining a waypoint or from the geocaching services website). The cache is now shown at the new coordinates on the map. A useful feature for solved mysteries or multis."
    "Final existing" -> "Has "Final" waypoint": "This cache has a "Final" waypoint defined but no modified coordinates. The cache is shown at the original coordinates on the map."

Supersizing of distances on map

New feature should be reflected somewhere in the user guide

In fact the map part of the guide does not mention the distance fields (could be added in general)
Alternatively or additionally it could be added on the page about using brouter

List markers replaced by free choice of emojis

It mentions 6 colored list markers (which don't exist anymore), but nowadays there's a huge list of emojis to choose from. But yes, a new page/additional content in https://manual.cgeo.org/de/mainmenu/lists#manage_lists would probably be better than removing it.

Oh, yes. Will move that topic into just another issue, so it does not get lost.
Will probably do that along with replacing the overlay images.

Originally posted by @Lineflyer in #42 (comment)

Open user manual editing for the crowd

Background:
The c:geo user manual was created about a year ago to simply have a new user manual for the c:geo app. It currently runs on my webspace with a reverse proxy set up to the above mentioned URL.
I created it myself and over time invited other users to collaborate or translate. Up to now its configured as a closed system, meaning that accounts cannot be self created.

As I learned from recent changes to the c:geo app functionality I cannot manage myself to keep the manual up to date with new features and changed views in c:geo.

So I would suggest to open it up to the public (=our users) to get it hopefully self maintained by the crowd.
Thats actually what a wiki system is designed for.

So basically I would reconfigure it to allow user registration and add authoring rights to all users. Afterwards invite users to participate via our channels.
What still remains for us is to monitor and moderate and maybe to somehow collect the parts of the manual, which need changes due to our changes to the app.

I do not have experience with public wiki pages...anything we should pay attention to?

Should new accounts have the need to be approved by us?

Where could we collect topics, pages, which need to be updated?

Update maaanny pictures

With the new design most pictures within the guide are outdated.
Most of them are still valid contentwise, only users might be confused by the different look when comparing.

So this issue is non-urgent, except if/where we have views also changed from their content?!

Map settings menu reduced in favor of quick settings

Currently not yet released:
Some map menu items have been moved into quick settings dialog reachable via quick settings button on the map.
The corresponding pages in the wiki need to be adapted accordingly after this feature has been released.

Include SAF related procedures

At some place there might be references/screenshots in the user guide which refer to our previous file explorer or other descriptions no longer matching.
Needs to be checked especially for:

  • GPX directory settings
  • Map/Theme selection
  • Export menus and dialogs for GPX and other files
  • Attachment of pictures

Additionally the setting to change the base folder needs to be added

Update all cache icons/overlays, etc.

After release of the c:geo version with new cache icons, the icons on the user guide need to be replaced as well.

@ztNFny
Could you provide plain svg versions (not the Android xml) of all icons?

@murggel
Or did we/did you find a better solution?
Do wa want to store SVG versions in the cgeo/cgeo repository as well or did we drop this idea?

Add parsing formula to parsing waypoint section

In the section of parsing waypoint from note / export waypoint to note the syntax for the formula should be added.
(taken from the PR 9633 (cgeo/cgeo#9633, related to cgeo/cgeo#9211)

Supported syntax:
Like the "normal" waypoint-syntax, use (F-PLAIN) to indicate the plain-formula (like (NO-COORD) for empty coords), then the formula string with both coordinates and (optional) already known variables / equations separated with "|".
If all variables are known, the coordinates of the waypoint are calculated and stored in the waypoint.

An existing formula will be exported to the PN, if not all variables are defined. Otherwise only the coordinates are exported like a "normal" waypoint.

Example:
@Final (F) (F-PLAIN) N48 AB.(C*D/2) E 9 (C-D).(A+B) |A=a+b|a=5|

Only upper-case letters are allowed in the formula.

Have user guide backed in a Github repo

Currently the user guide is a standalone installation of DokuWiki on my server.
A plugin already provides Oauth via Github (after manual registration of the mail address used on Github) to provide access rights.

There seems to be a plugin available here which provides integration of a git repository to sync local (server) and remote (Github) and allow changes on both sides AFAICS.

I don't know the effort to get this up and running and whether it will be useful or not. It might be not needed given the low frequency of changes, but at least the user guide content would be available outside my server (e.g. in case I get unavailable for the team).

I am not planning to look into this, if however someone wants to try it out, you are welcome.
Just contact me for server access.

Update menu icons in users manual

Due to the recent redesign our icons (on action bar) now look different.

Theoretically all those icon resources are stored on the main namespace of the Dokuwiki.
This means just replacing these files should replace all icons used throughout the pages if all languages sticked to that resource.

Not sure though if the icon name have changed? This would then require manual work on all pages (or batch Search&Replace).

Replace "click" by "tap"

Same as cgeo/cgeo#9845 but also for the user guide:

Some native-speaking english users made us aware over the past years, that while using "click" is understandable it however sound kind of "old school" on mobile devices.

Also recently a crowdin translator raised similar issues on the source strings. I found an interesting article on this in a blog: https://uiux.blog/stop-using-the-term-click-in-a-mobile-experience-479b8ed4f567

I think we can more or less 1:1 replace "click" by tap" (respectively "long click" by "long tap") in our strings.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.