diff --git a/guidelines/declaring/index.html b/guidelines/declaring/index.html index 7089d08a..83f37eb4 100644 --- a/guidelines/declaring/index.html +++ b/guidelines/declaring/index.html @@ -2,7 +2,7 @@ EN
FR

This document presents practical guidelines, is edited collaboratively and is not normative. Normative constraints are exposed in Contributing Terms.

Declaring documents

Service name

Casing

  • In order to find the service name casing, rely first on the page title (easily found in search results). Do not rely on the logo as it can be stylized differently. Example with Facebook: +Close

This document presents practical guidelines, is edited collaboratively and is not normative. Normative constraints are exposed in Contributing Terms.

Declaring documents

Service name

Casing

  • In order to find the service name casing, rely first on the page title (easily found in search results). Do not rely on the logo as it can be stylized differently. Example with Facebook: facebook search
  • If it is still ambiguous, rely on Wikipedia as a source. However, make sure to differentiate the service from the provider company’s name. Example with “DeviantArt”, a service (which used to be stylized deviantArt until 2014) by the limited liability company “deviantArt”: deviantArt search

Service ID

Normalisation

  1. For non-roman alphabets (Cyrillic, ideograms…), use the service-provided transliteration.
  2. For diacritics: normalise the string to its NFD normal UTF form, then remove the entire combining character class. Details.
  3. As a last resort, use the domain name.

Provider prefixing

  • If you encounter a document you want to add to a service, yet find that it would override an already-declared document for this service such as Terms of Service or Privacy Policy, and that the only solution you see would be to create a new terms type that would contain the name of the feature, then it is likely you should declare a new service, potentially duplicating existing documents.

Example: the Facebook Community Payments terms are Terms of Service. The only way to declare them in the Facebook service would be to add a “Community Payments Terms” terms type as they would otherwise conflict with Facebook’s Terms of Service. It is better to declare a new service called “Facebook Payments” with its own Terms of Service. It turns out that this service also has a developer agreement, independent from the main Facebook service.

Facebook Community Payments

  • As a last resort, rely on the trademark.

Example: Apple’s App Store uses only generic terms (“app” and “store”). However, it is of common use to mention “the App Store” as Apple’s. To help us decide whether it should be prefixed or not, we can check that Apple has trademarked “App Store”. The service can thus be named “App Store”, without prefixing.


Usual noise

Noise is unwanted content in versions.

Irrelevant content

The first type of noise we try to remove is content that is not relevant legally speaking, and that harms document readability.

CSS selectors are a first step as they permit to select an area instead of the whole page, but they let pass through content such as headers, footers, buttons, drop-down lists…

Filtering permits to get rid of the remaining irrelevant content.

A drop-down list let user select which document he would like to see but this list doesn’t interest us in the final document.

HTML file :

<div class="filter-holder">
   <select class="filter-options">
@@ -54,6 +54,6 @@
 We found that those contents are usually hypertext links, since two links can point to the same website yet they can be written differently. A case in point are links passing parameters : a change in parameters will not change where the link point at.

A link has a parameter ‘h=’ changing too frequently and irrelevant to the adress the link point to.

HTML file :

You can only use our copyrights or <a href="https://l.facebook.com/l.php?u=https%3A%2F%2Fen.facebookbrand.com%2Ftrademarks%2F&amp;h=AT0_izDHO3yJuXJuJJeWQyJFVilQqIDOA3oMwr51t6gEq1q4UbyH2VtU7UhNzhg1LH0YzUHAjw0TADuoufWgb_YEuzoFpvyIR8_4rkUfjDXxUw3q1KmpsYL_H3C4OIm3xHzrUZRatmWQ6PAk">trademarks (or any similar marks)</a>
 

Markdown file :

You can only use our copyrights or [trademarks (or any similar marks)](https://l.facebook.com/l.php?u=https%3A%2F%2Fen.facebookbrand.com%2Ftrademarks%2F&h=AT1XEFWtw25SbFSSD7W2MOS1LQIsUwaUrq4qh5dNmI21qm42JE5lUiv9g8MsTSnvi3DjYfJxOPoBxEKyBQjo7qkxfcUkDzedQzBLWgGJYWC6CwDBI0S5pefB4oiuh8Jo63phreoUKQ3BF4O5)
 

Wished Markdown file :

You can only use our copyrights or [trademarks (or any similar marks)](https://l.facebook.com/l.php?u=https%3A%2F%2Fen.facebookbrand.com%2Ftrademarks%2F)
-

Solution

Write a filter in the declaration.

+

Solution

Write a filter in the declaration.


Using the graphical contribution interface

Blank page when contacting support

While using the graphical user interface for contribution, you may come across a blank page when trying to contact the team.

This may be caused by the lack of a mail program being set up in your browser.

Solution

If you use Gmail, for example, these instructions explain how to add Gmail as the default mailto handler in Chrome. Try following them and trying again.


\ No newline at end of file diff --git a/jsdoc/Record.html b/jsdoc/Record.html index 6edc3254..60bbac2a 100644 --- a/jsdoc/Record.html +++ b/jsdoc/Record.html @@ -161,7 +161,7 @@

Home

Classes