Bug #16221

Stop using DocBook-style CSS classes

Added by sajolida 2018-12-13 16:16:59 . Updated 2020-05-04 16:39:13 .

Status:
In Progress
Priority:
Normal
Assignee:
sajolida
Category:
Internationalization
Target version:
Tails_4.7
Start date:
2018-12-13
Due date:
% Done:

0%

Feature Branch:
Type of work:
Discuss
Blueprint:

Starter:
Affected tool:
Deliverable for:

Description

See http://lists.autistici.org/message/20181118.155100.286e6cc2.en.html.

We should remove this from our documentation guidelines.

From the W3C standard, I think that we should use and when writing full HMTL and not and : http://html5doctor.com/i-b-em-strong-element/

But since ikiwiki uses and , I think that we should also use them for consistency across the website.

Subtasks

Related issues

Related to Tails - Feature #16279: Research how to isolate the [[!meta directives that need translation in PO files Resolved 2019-01-04
Related to Tails - Bug #6568: Mention Seahorse in documentation Confirmed 2014-01-05
Blocked by Tails - Feature #10034: Translation web platform Resolved 2015-08-14
Blocked by Tails - Bug #16943: Upgrade to Weblate 3.x Resolved
Blocked by Tails - Feature #17358: Enable Markdown checks on Weblate Resolved
Blocks Tails - Feature #17247: Core work 2020Q1 → 2020Q2: Technical writing Confirmed

History

#1 Updated by sajolida 2018-12-13 16:17:28

  • blocks Feature #15941: Core work 2018Q4 → 2019Q2: Technical writing added

#2 Updated by sajolida 2018-12-13 16:32:26

  • Subject changed from Stop using DocBook-style CSS classes to Consider stopping to use DocBook-style CSS classes

#3 Updated by sajolida 2018-12-13 16:44:05

  • Type of work changed from Contributors documentation to Discuss

#4 Updated by sajolida 2019-01-04 19:31:51

  • related to Feature #16279: Research how to isolate the [[!meta directives that need translation in PO files added

#5 Updated by sajolida 2019-01-04 19:45:09

emmapeel summarized the issue very well on the thread:

**Applications > Tails > Configure persistent storage**

Instead of:

<span class="guimenu">Applications</span>&nbsp;>
  <span class="guisubmenu">Tails</span>&nbsp;>
  <span class="guimenuitem">Configure persistent storage</span>
</span>
  • Markdown seems to be much more understandable.
  • Translators are less likely to make errors with the first version. But if they do make errors, Weblate will be able to spot the HTML errors better than the markdown ones.

#6 Updated by sajolida 2019-01-04 19:55:37

  • Description updated

#7 Updated by sajolida 2019-01-16 16:21:23

  • Target version changed from Tails_3.12 to Tails_3.13

We’ll discuss at FOSDEM with Weblate whether they could implement validation of Markdown as this would solve the concerns raised by emmapeel and ignifugo about translators messing up with Markdown. Other projects looking into Weblate to translate markdown are also really interested in this.

#8 Updated by sajolida 2019-01-18 12:01:39

Weblate upstream ticket: https://github.com/WeblateOrg/weblate/issues/2495

#9 Updated by sajolida 2019-02-20 20:13:41

#10 Updated by sajolida 2019-02-20 20:13:48

The checks will make sure that the same Markdown are used in the original string and the translations, so this will solve our problem.

I’m marking this as blocked by the translation platform.

#11 Updated by sajolida 2019-02-20 20:14:11

  • blocked by deleted (Feature #15941: Core work 2018Q4 → 2019Q2: Technical writing)

#12 Updated by sajolida 2019-03-18 11:30:55

  • Target version changed from Tails_3.13 to Tails_3.14

#13 Updated by CyrilBrulebois 2019-05-23 21:23:29

  • Target version changed from Tails_3.14 to Tails_3.15

#14 Updated by sajolida 2019-07-09 09:06:58

  • blocks Feature #16711: Core work 2019Q3 → 2019Q4: Technical writing added

#15 Updated by CyrilBrulebois 2019-07-10 10:34:10

  • Target version changed from Tails_3.15 to Tails_3.16

#16 Updated by sajolida 2019-07-30 16:32:07

  • Target version changed from Tails_3.16 to Tails_3.17

If I understand correctly:

So I’ll bump this ticket into to the future.

#17 Updated by sajolida 2019-08-09 14:13:44

  • blocked by Bug #16943: Upgrade to Weblate 3.x added

#18 Updated by sajolida 2019-08-28 13:01:38

  • Target version deleted (Tails_3.17)

#19 Updated by sajolida 2019-12-16 16:00:47

  • Subject changed from Consider stopping to use DocBook-style CSS classes to Stop using DocBook-style CSS classes

#20 Updated by sajolida 2019-12-16 16:06:56

#21 Updated by sajolida 2020-01-05 16:22:56

  • blocks Feature #17247: Core work 2020Q1 → 2020Q2: Technical writing added

#22 Updated by sajolida 2020-01-05 16:23:00

  • blocked by deleted (Feature #16711: Core work 2019Q3 → 2019Q4: Technical writing)

#23 Updated by sajolida 2020-03-18 16:50:39

  • Status changed from Confirmed to In Progress
  • Target version set to Tails_4.5

Now that Feature #17358 is solved we should move this forward. I’ll start using Markdown only in my writing from now on and I’ll update the guidelines at some point.

#24 Updated by sajolida 2020-03-18 16:59:20

  • related to Bug #6568: Mention Seahorse in documentation added

#25 Updated by sajolida 2020-03-21 23:23:59

  • Description updated

#26 Updated by sajolida 2020-04-06 21:58:01

  • Target version changed from Tails_4.5 to Tails_4.6

#27 Updated by sajolida 2020-05-04 16:39:13

  • Target version changed from Tails_4.6 to Tails_4.7