Ticket #1369 (closed task: wontfix)

Opened 10 years ago

Last modified 10 years ago

Update *.hlp files and other docs

Reported by: slavazanko Owned by: slavazanko
Priority: major Milestone: 4.7.0
Component: documentation Version: master
Keywords: TODO Cc: dmartina@…
Blocked By: Blocking:
Branch state: Votes for changeset:

Description (last modified by iNode) (diff)

Lot of new features added, in some places default behavior changed, therefore need to update documentation.

Also, need to review INSTALL, README etc.

TODO:

  • add section in mcedit.1.in about all search/replace methods
  • add the section in mc.1.in about advanced rename with regex/etc. methods
  • hlp - update english version to get work for translators
  • hints - new features should be added to hints

Attachments

zyv-doc.patch (2.4 KB) - added by zaytsev 10 years ago.
Small corrections
alt-i.diff (1.2 KB) - added by angel_il 10 years ago.
ru-alt-i.diff
mc-es.1.in.diff (15.5 KB) - added by dmartina 10 years ago.
Spanish man/help updated for 4.7.0pre3. Includes highlighting and skins stuff.
mc.1.in.diff (6.5 KB) - added by dmartina 10 years ago.
Small fixes for English help

Change History

comment:1 Changed 10 years ago by slavazanko

  • Blocking 1371 added

comment:2 Changed 10 years ago by slavazanko

  • Blocked By 346 added

comment:3 Changed 10 years ago by slavazanko

  • Keywords rework added

created branch 1369_update_docs (parent: master)

Branch under work, this message just for inform.

comment:4 Changed 10 years ago by slavazanko

  • Owner set to slavazanko
  • Status changed from new to accepted

comment:5 Changed 10 years ago by slavazanko

  • Keywords rework removed
  • severity set to on rework
  • Blocked By 346 removed

Changed 10 years ago by zaytsev

Small corrections

comment:7 Changed 10 years ago by slavazanko

Small corrections

Patch applied: changeset:e7d32015492791236a3f8d068e1eba13547020df

comment:8 Changed 10 years ago by slavazanko

  • severity changed from on review to on rework

comment:9 follow-up: ↓ 10 Changed 10 years ago by zaytsev

Todo: add modifier make MAN_IN_BZ2=1 install to make RPMLint happy & edit the SPEC.

comment:10 in reply to: ↑ 9 Changed 10 years ago by zaytsev

Replying to zaytsev:

Todo: add modifier make MAN_IN_BZ2=1 install to make RPMLint happy & edit the SPEC.

Please disregard, this is a rpmlint problem.

comment:11 Changed 10 years ago by iNode

TODO: add to FAQ description how to change keybindings. (Q2.8)

comment:12 Changed 10 years ago by iNode

in branch:

INSTALL, README, FAQ, mcedit.1.in updated, need check

TODO:

  • mcedit.1.in - need describe some config options
  • TODO - need transition to wiki version of page, and remove useless file
  • hints - new features should be added to hints
  • hlp - update english version to get work for translators

comment:13 Changed 10 years ago by iNode

  • Description modified (diff)

comment:14 Changed 10 years ago by iNode

  • Keywords TODO added

comment:15 Changed 10 years ago by angel_il

comment:16 Changed 10 years ago by angel_il

  • severity changed from on rework to no branch
  • Blocking 1371 removed
  • Milestone changed from 4.7.0-pre1 to 4.7.0-pre2

comment:17 Changed 10 years ago by dmartina

  • Cc dmartina@… added

comment:18 Changed 10 years ago by dmartina

  • Blocked By 1462 added

comment:19 Changed 10 years ago by slavazanko

  • Blocked By 1522 added

comment:20 Changed 10 years ago by andrew_b

  • Component changed from mc-core to documentation

comment:21 Changed 10 years ago by dmartina

  • Blocked By 1551 added

comment:22 Changed 10 years ago by dmartina

  • Blocked By 1551 removed

(In #1551) It's just to question developers about it. If nobody cares, it's fair to wrap it for future releases.

comment:23 Changed 10 years ago by slavazanko

  • Blocked By 1462 removed

Changed 10 years ago by angel_il

ru-alt-i.diff

comment:24 Changed 10 years ago by angel_il

  • Blocking 1566 added

comment:25 Changed 10 years ago by slavazanko

attachment mc-es.1.in.diff added
Patch to Spanish man and help source

changeset:2778021a65932f8985a52676bc8eb5df18951594

comment:26 Changed 10 years ago by slavazanko

attachment alt-i.diff added
ru-alt-i.diff

changeset:96f5e3523d2ee12ff64f991fabbde2587dad78a9

comment:27 Changed 10 years ago by slavazanko

  • Milestone changed from 4.7.0-pre2 to 4.7.0-pre3

comment:28 Changed 10 years ago by slavazanko

  • Blocking 1566 removed

comment:29 Changed 10 years ago by dmartina

English help file mc.1.in needs some review. Last changes about skins introduced some absolute path references for files that may be changed at compile time (--prefix). @prefix@ must be used for them.

Changed 10 years ago by dmartina

Spanish man/help updated for 4.7.0pre3. Includes highlighting and skins stuff.

Changed 10 years ago by dmartina

Small fixes for English help

comment:30 Changed 10 years ago by slavazanko

doc/man/mc.1.in

   3211 .BR /etc/mc/skins/default.ini
   3212 .br
   3213 5) File
   3214 .BR @prefix@/share/mc/skins/default.ini

Need to use @sysconfdir@ macro in /etc/... path, and @datadir@ instread of @prefix@/share

But these macros will expand to @prefix@/etc and @prefix@/share.

I don't know, how this handle... May be, need to create Makefile-targets for mc.1.in with eval'ing these macros? Like:

do_subst = sed \
 -e 's,[@]datadir[@],$(datadir),g' \
 -e 's,[@]pkgdatadir[@],$(pkgdatadir),g' \
 -e 's,[@]PACKAGE[@],$(PACKAGE),g' \
 -e 's,[@]VERSION[@],$(VERSION),g' \
 -e 's,[@]sysconfdir[@],$(sysconfdir),g'

mc.1: $(VPATH)/mc.1.in Makefile
      $(do_subst) <$(VPATH)/mc.1.in > mc.1

To all: Is this good idea?

comment:31 Changed 10 years ago by slavazanko

  • Blocked By 1522 removed

Now in master:

Spanish man/help updated for 4.7.0pre3. Includes highlighting and skins stuff.

changeset:9a87c9cedf44d1aaf330de2dedf428a47ce9caa7

Small fixes for English help

changeset:1a64b2a8ffa1345f0bba6c4698e4408128470fed

Thanks for fixies, my English is funny, I know :)

BTW, anyone feel free to add more descriptions into English man-files... :)

And another question: is someone wants to contribute in wiki-pages (in your language or in English)? Just contact with me (in our jabber room, via my jabber or my e-mail).

comment:32 Changed 10 years ago by slavazanko

  • Milestone changed from 4.7.0-pre3 to 4.7.0-pre4

comment:33 Changed 10 years ago by slavazanko

  • Milestone changed from 4.7.0-pre4 to 4.7.0

comment:34 Changed 10 years ago by slavazanko

  • Status changed from accepted to testing
  • Resolution set to wontfix

comment:35 Changed 10 years ago by slavazanko

  • Status changed from testing to closed
Note: See TracTickets for help on using tickets.