Difference between revisions of "Template:AppAntifeature"

From postmarketOS
Jump to navigation Jump to search
m (Grammar fixes)
m (Shuffle things around.)
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
{{note|Be careful when editing this template since it may break existing uses and even [[Template:App]]!}}
 
{{note|Be careful when editing this template since it may break existing uses and even [[Template:App]]!}}
 
== Usage ==
 
== Usage ==
<pre>
 
{{AppAntifeature|2|Syncing}}
 
{{AppAntifeature|1}}
 
{{AppAntifeature|0|This App uses some antifeature that isn't contained in the template.| Some stuff}}
 
</pre>
 
 
# arg. &ndash; Number identifying the antifeature type.
 
# arg. &ndash; Number identifying the antifeature type.
#* 0: Describe your own antifeature! '''When it may be used more than once, consider including it in this template.'''
+
::{| class="wikitable"
#* 1: This app needs to be installed from a third-party [[Flatpak]] repository.
+
! ID
#* 2: This app depends on non-free network services.
+
! Antifeature Text
#* 3: This app includes tracking services.
+
! Further Explanation
#* 4: This app seems to no longer be maintained. ''(either the project explicitly states this or there is no noticeable recent activity)''
+
|-
#* 5: This app doesn't work out of the box well on mobile. ''(i.e. manual tweaks by the user are required)''
+
|0
#* 6: This app may use non-free network services if you choose to. ''(i.e. explicit opt-in is required!)''
+
| ''Your Text of choice''
 +
| Describe your own custom antifeature (that matches specific formatting)! Try to keep it as concise and terse as possible. '''When it may be used more than once, consider including it in this template.''' Or start a discussion about a new antifeature in [https://gitlab.com/postmarketOS/wiki/-/issues the wiki's issues].
 +
|-
 +
|1
 +
|{{Appaf|1}}
 +
|Since postmarketOS doesn't control such 3rd-party repositories, every app distributed on those should be flagged with this antifeature. Right now, there is only one for Flatpak distribution, but please add an antifeature for your (supported) 3rd-party distribution channel of choice if needed (e.g. for AppImages).
 +
|-
 +
|2
 +
|{{Appaf|2}}
 +
|Such apps use those services as an integral part of their functionality, e.g. open clients for proprietary services. ''Do not mistake this with No.6!''
 +
|-
 +
|3
 +
|{{Appaf|3}}
 +
|The term ''tracking'' is a little bit vague here. It should mean something along the lines of ''Online Behavioral Tracking'' [https://www.eff.org/issues/online-behavioral-tracking as defined by the EFF]; not necessarily harmless opt-in metrics collection.
 +
|-
 +
|4
 +
|{{Appaf|4}}
 +
|Either the project explicitly states this or there is no noticeable recent activity.
 +
|-
 +
|5
 +
|{{Appaf|5}}
 +
|This is used for apps that work on mobile, but to do so the user needs to apply manual tweaks (i.e. mobile support is neither managed by the upstream application nor pmOS / Alpine). If you add this antifeature to your app, it would be greatly appreciated to add a separate app wiki page describing the required tweaks.
 +
|-
 +
|6
 +
|{{Appaf|6}}
 +
|Non-free network services might be used by the app to serve additional features, but they are not required for core functionality. '''Explicit opt-in''' to use those services is required. ''Do not mistake this with No.2!''
 +
|}
 
# Depends on value of first argument:
 
# Depends on value of first argument:
#* <code>if {{{1}}} !=0</code> ''opt'' arg. &ndash; Optional comment, describing which components of the app use this antifeature.
+
#* <code>if {{{1}}} !=0</code> ''opt'' arg. &ndash; Optional comment on the chosen antifeature. ''Please keep it short & simple!''
 
#* <code>if {{{1}}} == 0</code> arg. &ndash; Your own text describing the antifeature.
 
#* <code>if {{{1}}} == 0</code> arg. &ndash; Your own text describing the antifeature.
# Only usable <code>if {{{1}}} == 0</code> ''opt'' arg. &ndash; Optional comment, describing which components of the app use this antifeature.
+
# Only usable <code>if {{{1}}} == 0</code> ''opt'' arg. &ndash; Optional comment on your custom defined antifeature. ''Please keep it short & simple!''
  
 
== Examples ==
 
== Examples ==
{{AppAntifeature|2|Syncing}} <br />
+
<pre>
{{AppAntifeature|1}} <br />
+
{{AppAntifeature|2|For Syncing}}
{{AppAntifeature|0|This App uses some antifeature that isn't contained in the template.| Some stuff}} <br />
+
{{AppAntifeature|1}}
 +
{{AppAntifeature|0|This App uses some antifeature that isn't contained in the template.|Some stuff}}
 +
</pre>
 +
:{{AppAntifeature|2|For Syncing}} <br />
 +
:{{AppAntifeature|1}} <br />
 +
:{{AppAntifeature|0|This App uses some antifeature that isn't contained in the template.|Some stuff}} <br />
  
 
== See also ==
 
== See also ==

Latest revision as of 21:17, 28 June 2021

This page is a template. It contains no postmarketOS-related information, but should be used as part of other articles.

Check out all pages using this template and feel free to discuss it in the gitlab issues.

For more information, read Templates and Template:Template.

Simple template to insert descriptions of antifeatures (i.e. properties of applications that do not align with postmarketOS' principles). Can also be referenced by Template:appaf. Inspired by F-Droid's Anti-Features.

Be careful when editing this template since it may break existing uses and even Template:App!

Usage

  1. arg. – Number identifying the antifeature type.
ID Antifeature Text Further Explanation
0 Your Text of choice Describe your own custom antifeature (that matches specific formatting)! Try to keep it as concise and terse as possible. When it may be used more than once, consider including it in this template. Or start a discussion about a new antifeature in the wiki's issues.
1 This app needs to be installed from a third-party Flatpak repository. Since postmarketOS doesn't control such 3rd-party repositories, every app distributed on those should be flagged with this antifeature. Right now, there is only one for Flatpak distribution, but please add an antifeature for your (supported) 3rd-party distribution channel of choice if needed (e.g. for AppImages).
2 This app depends on non-free network services. Such apps use those services as an integral part of their functionality, e.g. open clients for proprietary services. Do not mistake this with No.6!
3 This app includes tracking services. The term tracking is a little bit vague here. It should mean something along the lines of Online Behavioral Tracking as defined by the EFF; not necessarily harmless opt-in metrics collection.
4 This app seems to be no longer maintained. Either the project explicitly states this or there is no noticeable recent activity.
5 This app doesn't work out of the box well on mobile. This is used for apps that work on mobile, but to do so the user needs to apply manual tweaks (i.e. mobile support is neither managed by the upstream application nor pmOS / Alpine). If you add this antifeature to your app, it would be greatly appreciated to add a separate app wiki page describing the required tweaks.
6 This app may use non-free network services if you choose to. Non-free network services might be used by the app to serve additional features, but they are not required for core functionality. Explicit opt-in to use those services is required. Do not mistake this with No.2!
  1. Depends on value of first argument:
    • if {{{1}}} !=0 opt arg. – Optional comment on the chosen antifeature. Please keep it short & simple!
    • if {{{1}}} == 0 arg. – Your own text describing the antifeature.
  2. Only usable if {{{1}}} == 0 opt arg. – Optional comment on your custom defined antifeature. Please keep it short & simple!

Examples

{{AppAntifeature|2|For Syncing}}
{{AppAntifeature|1}}
{{AppAntifeature|0|This App uses some antifeature that isn't contained in the template.|Some stuff}} 
This app depends on non-free network services. For Syncing
This app needs to be installed from a third-party Flatpak repository.
This App uses some antifeature that isn't contained in the template.  Some stuff

See also