standardize on italized field names, they are a "foreign language"

Italics are a standard way in many spoken languages for denoting words that
come from another language.  The YAML metadata field names are like another
language, so when field names are used within English text, they should be
italics rather than code blocks.  When there are used in snippets of code,
then they should be in a code block.
parent d6d5892b
......@@ -55,9 +55,9 @@ release, they will not be included.
The last important detail is that the texts in the app's metadata file
will override all other descriptive texts from
_Fastlane_/_Triple-T_. That is specifically
[Name](../Build_Metadata_Reference/#Name)/[AutoName](../Build_Metadata_Reference/#AutoName),
[Summary](../Build_Metadata_Reference/#Summary), and
[Description](../Build_Metadata_Reference/#Description). Once an
[_Name_](../Build_Metadata_Reference/#Name)/[_AutoName_](../Build_Metadata_Reference/#AutoName),
[_Summary_](../Build_Metadata_Reference/#Summary), and
[_Description_](../Build_Metadata_Reference/#Description). Once an
app's descriptive texts have been moved into the source repo, then
file a
[merge request](https://gitlab.com/fdroid/fdroiddata/merge_requests)
......
This diff is collapsed.
......@@ -27,16 +27,16 @@ common source code websites. For complicated apps that rebase code and
use many branches, I'll often visit the source code site too).
- Take a note of the current version according to the developer
– a clue is often written above the CurrentVersion in
– a clue is often written above the _CurrentVersion_ in
the metadata. To visit Google Play quickly to get the version name
there, install w3m and add this function `gplay() { w3m
play.google.com/store/apps/details/?id="$@" ;}` to
your bashrc. Then you can just do
`gplay package-name`. If you find that the
version is greater than the CurrentVersion in the metadata, update
version is greater than the _CurrentVersion_ in the metadata, update
it right away (unless there are any beta or test builds
currently activated)
- If the CurrentVersion in the metadata (especially in the case of
- If the _CurrentVersion_ in the metadata (especially in the case of
the update check mode RepoManifest) is greater than on Google Play
or the download page, you may not need to update and can just add a
dummy build version e.g `Build Version:1.2,34,!not
......@@ -68,7 +68,7 @@ use many branches, I'll often visit the source code site too).
checksums to compare with. Take a note of jars such as bugsense or
acra which are used for bugreports
- If you find proprietary files add a dummy build version to the
metadata with a few words about the reason, add NoSourceSince to
metadata with a few words about the reason, add _NoSourceSince_ to
the bottom and a line to the descripion beginning with Status: to
the description explaining the reason that the app can't be updated
- `find . -type f -executable` to locate any
......
......@@ -99,7 +99,7 @@ This is a nonexhaustive list of what a reviewer would do:
uses non-Free dependencies, shows advertisements, tracks users,
promotes non-Free services/applications, or does anything that is
harmful or otherwise undesirable for users.
- They will list a summary of any [AntiFeatures](https://f-droid.org/wiki/page/Antifeatures) in
- They will list a summary of any [_AntiFeatures_](https://f-droid.org/wiki/page/Antifeatures) in
your application.
- They will try patching your application to remove usage of
third-party proprietary software (if there is any).
......
......@@ -25,7 +25,7 @@ Notably:
about an untainted build flavor (either using a FLOSS analytics
software like ACRA or by removing non-free dependencies completely).
- We cannot build apps using proprietary ad libraries. We have nothing
against advertisments (see [AntiFeatures](https://f-droid.org/wiki/page/Antifeatures)),
against advertisments (see [_AntiFeatures_](https://f-droid.org/wiki/page/Antifeatures)),
but they must be provided by a FLOSS compatible way.
- We cannot build apps requiring non-free buildtools, including
Oracle's JDK or some pre-release toolchains.
......@@ -63,7 +63,7 @@ Ideally:
Some software, while being Free and Open Source, may engage in practices
which are undesirable to some or all users. Where possible, we still
include these applications in the repository, but they are flagged with
the appropriate [AntiFeatures](https://f-droid.org/wiki/page/Antifeatures). Even though
the appropriate [_AntiFeatures_](https://f-droid.org/wiki/page/Antifeatures). Even though
such software can be included, when appropriately flagged, it is
frequently the case that other "FLOSS" software with these features is
actually not entirely free. For example, advertising and spying on user
......
......@@ -131,7 +131,7 @@ encourage the developers to create a dedicate page if possible.
In addition some software, even being Free and Open Source software, may
do practices which can be considered undesirable and that we consider
[AntiFeatures](https://f-droid.org/wiki/page/Antifeatures)". Where possible the F-Droid
[_AntiFeatures_](https://f-droid.org/wiki/page/Antifeatures)". Where possible the F-Droid
community still include these applications in the repository but
flagging and cataloging these antifeatures in order to warn users (on
the F-Droid client and on the web repository browser) by any
......
......@@ -75,7 +75,7 @@ to verify that a downloaded APK can be built reproducibly, the
downloaded APK will be published. Otherwise F-Droid will skip
publishing this version of the app.
Here is an example for a `Binaries` directive:
Here is an example for a _Binaries_ directive:
```yaml
Binaries: https://foo.com/path/to/myapp-%v.apk
......
......@@ -156,9 +156,9 @@ donation links, bug tracker, license, home page, etc. See the
[Build Metadata Reference](../Build_Metadata_Reference) for more info
on what all the options are.
`CurrentVersionCode` provides a handy way to
_CurrentVersionCode_ provides a handy way to
deploy beta releases in the same stream as your full releases. You can
set `CurrentVersionCode` to your current stable
set _CurrentVersionCode_ to your current stable
release, then add APKs to your repo. Users will only be updated
automatically to the version code you specify. Any APKs for a given app
in your repo that have a newer version code will not be automatically
......
......@@ -10,13 +10,13 @@ and packages.
### Detecting<a name="Detecting"></a>
There are various mechanisms in place for automatically detecting that
updates are available for applications, with the `UpdateCheckMode`
updates are available for applications, with the _UpdateCheckMode_
field in the metadata determining which method is used for a particular
application.
Running the `fdroid checkupdates` command will apply this method to each
application in the repository and update the `CurrentVersion` and
`CurrentVersionCode` fields in the metadata accordingly.
application in the repository and update the _CurrentVersion_ and
_CurrentVersionCode_ fields in the metadata accordingly.
As usual, the `-p` option can be used with this, to restrict processing
to a particular application.
......@@ -32,7 +32,7 @@ Adding updates (i.e. new versions of applications already included in
the repository) happens in two ways. The simple case is applications
where the APK files are binaries, retrieved from a developer’s published
build. In this case, all that’s required is to place the new binary in
the `Repo` directory, and the next run of `fdroid update` will pick it
the _Repo_ directory, and the next run of `fdroid update` will pick it
up.
For applications built from source, it is necessary to add a new
......
#!/bin/sh
#
# grep -Eo "'[A-Z][A-Za-zn ]+'," ../server/fdroidserver/metadata.py|grep ' ' | sort -ru
basedir=`cd $(dirname $0)/..; pwd`
for f in 'Web Site' 'Vercode Operation' 'Update Check Name' 'Update Check Mode' 'Update Check Ignore' 'Update Check Data' 'Source Code' 'Requires Root' 'Repo Type' 'No Source Since' 'Maintainer Notes' 'Issue Tracker' 'Current Version Code' 'Current Version' 'Auto Update Mode' 'Auto Name' 'Author Web Site' 'Author Name' 'Author Email' 'Archive Policy'; do
aname=`echo $f | sed 's, ,-,g'`
new=`echo $f | sed 's, ,,g'`
backtick='`'$new'`'
echo "'$f' '$new'"
sed -i \
-e "s,$f,$new,g" \
-e "s,$aname,$new,g" \
-e "s, ${new}<, _${new}_<," \
-e "s, ${new} , _${new}_ ,g" \
-e "s,^${new} ,_${new}_ ,g" \
-e "s, ${new}$, _${new}_,g" \
-e "s,${backtick},_${new}_,g" \
$basedir/*/*.md
done
for f in AntiFeatures ArchivePolicy AuthorEmail AuthorName AuthorWebSite AutoName AutoUpdateMode Binaries Bitcoin Builds Categories Changelog CurrentVersion CurrentVersionCode Description Disabled Donate FlattrID IssueTracker LiberapayID License Litecoin MaintainerNotes Name NoSourceSince Provides Repo RepoType RequiresRoot SourceCode Summary Translation UpdateCheckData UpdateCheckIgnore UpdateCheckMode UpdateCheckName VercodeOperation WebSite; do
backtick='`'$f'`'
sed -i \
-e "s,${backtick},_${f}_,g" \
-e "s,\[${f}\],[_${f}_],g" \
$basedir/*/*.md
done
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment