Code Monkey home page Code Monkey logo

ios-tldr-viewer's People

Contributors

mflint avatar pixelcmtd avatar simplydanny avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

ios-tldr-viewer's Issues

Text size changes on "detail" scene

Small problem in Slideover:

- open Tldr, view a man page
- open other app
- open slideover and select Tldr 
=> your app opens and shows the previous man page, but the font has the same size as in fullscreen mode. You have to zoom to fit the man-page manually

(Reported by Michael Schmidt via email)

Brew-cask addition

Add

Uninstall given cask and remove all related files of that cask
'Brew cask zap cask_name'

App shows commands which have been deleted/renamed

Just now I noticed that the command brew-mas is still present in the app, although it has been renamed to mas here. Updating the app data didn't change anything.

Digging a little bit through the code I found two issues which might cause this bug (in combination):

  • Zip.unzipFile just copies the files and overwrites existing ones. Files which already exist in the destination directory but are not present anymore in the ZIP archive will stay there "forever".
  • The DataSource extracts the commands to present in the app from the index.json file but does not consider the language tag.

Now, in this concrete case: The file brew-mas.md still exists on the device because it has not been cleaned up somehow. This fact alone would not show it in the UI. However, DataSource also finds it in the index.json file for the zh language, since it has only been renamed for the primary (en) language. Thus, all prerequisites are fulfilled to actually show the command in the app.

In landscape mode, app could use the available space better with a UICollectionView

It looks like this app uses a tableview and supports landscape orientation.
I opened this on my iPhone 6, rotated to landscape, and saw a lot of
unused space in the center of the screen. If you instead used a
collectionview and made a table-like cell, you could display two or more
cells per row in landscape orientation. This is something I plan to do
eventually in an app I develop. Of course there may be reasons why
this wouldn't work in your case, but I thought I'd offer the suggestion.

(Suggested by Brett Neely via email)

Spotlight search

Spotlight search would be great.

Depends on the tl;dr pages being cached for offline use / searching.

(Reported by Michael Schmidt via email)

Use the new index.json file in favor of the deprecated pages/index.json

Hello, I'm from the tldr-pages/tldr repository, and I'm here to inform you that we recently changed the content of the ZIP archive your client relies upon. Here's a link to the merged PR: #2862.

Inside the generated ZIP archive, a new /index.json file has been created, to be used in favor of the now deprecated /pages/index.json file, as you can see here. Once all the clients are updated, or enough time has passed, we will completely remove the /pages/index.json file from the generated ZIP archive, and only keep the top-level /index.json.

If your client does not rely on the mentioned file to work, you can close this right away, sorry for the trouble! Otherwise, in order to support the upcoming change, this client should be updated to either:

  1. Use the index.json file served by the static site itself, that is: https://tldr.sh/assets/index.json.
  2. Or use the new top-level /index.json file inside the ZIP file served by the static site, which is: https://tldr.sh/assets/tldr.zip.

Once the above is taken care of, you can close this issue and your client will be marked as up to date in our tracking issue here. This change should be trivial, but if there's any problem, please do let me know.

Thank you for your work and time you put into creating this client and supporting the TLDR pages project!

arguments in {{moustache braces}} could be styled differently

In the tl;dr text, arguments are shown in {{moustache braces}}.

They could (probably should) be styled differently, so it's clear that they are semantically different pieces of text.

Maybe italicised with <em></em> tags?

(Reported by Frederic Barthelemy on Twitter)

UITableView index on list scene

The index would show the alphabet on the right-side of the screen, to enable fast scrolling.

(Reported by Ruurd Pels via email)

"Back" button always returns to command list

Pressing the "Back" button always returns to the commands list. This is the correct behavior in case a command details view is opened. But if one taps a link and jumps to a website, "Back" implies "back to the command details". Instead, the command list appears, which is not what I would expect.

Rendering issue on PowerShell dict variables

Hello, I'm the writer of the Invoke-WebRequest tldr page.

The documentation includes placing PowerShell dictionary (e.g. @{Foo='bar'} inside the tldr's variable container ({{}}) which causes the dict variable to be rendered incomplete, i.e. "@{Foo='bar'}" instead of "@{Foo='bar'}".

telegram-cloud-photo-size-5-6296170809395360688-y

The issue can be seen more clearly on another tldr-pages website made by myself, see reinhart1010/nix#1 for details.

Issue in Nix

Info popover on iPad

On iPad, the info popover isn't positioned at an exact center of the
info button, and the popover UI isn't distinct from the background
underneath it. The popover could also be taller and/or wider to
eliminate the need to scroll.

Yes.

(Suggested by Brett Neely via email)

Enable proper language support

tl;dr pages can now be localised into multiple languages. (Some people are actively adding Italian and Simplified Chinese localisations)

The app should display the tl;dr page in the user's language, if available, before falling-back to English.

Doesn't work anymore

You get the following error at the start:

Could not unzip the download

Deleting and reinstalling doesn't help, except the app is now even more useless, because completely empty.

Search by platform

There isn't a way to filter/search by platform

Correct. I'm not sure about searching by platform, but it may be useful to ignore platforms. (Eg, "Sun OS", for example)

(Suggested by Brett Neely via email)

Siri search

We might be able to do something nice with Siri search:

Hey Siri, tldr date
macOS or common?
macOS
OK, here's your tldr for macOS date
{displays tldr for macOS date}

Rotation issues on iPad

Start in portrait, view one of the pages, rotate to landscape, and back to portrait.
First, the back navigation button is labeled "Master" which I consider an
implementation detail rather than a user interface label. Second, the detail
page is now partially covered by the master list.

OMG, UISplitViewController raises its ugly head again.

(Suggested by Brett Neely via email)

Links to variants of a command, not just a command

Wherever the app refers to a command, it uses just the command-name.

Consider adding an optional platform in there too. So if I favourite the macOS version of date, then that version should be opened if I tap the favourite.

Missing content

I didn't get any results for "perl", "ruby"... a user of the app may not understand the missing result.

True. I should add something which explains why there are no search results.

(Suggested by Brett Neely via email)

New lines are not honoured

In the description for a command that has multiple lines e.g. curl, a new line just follows on from the existing line rather than starting on the next line.

Suggested description for โ€˜lsโ€™

I wish it said something like "List contents of the specified directory, or if none specified, of the current directory."

Because when I first used it with -R, I was confused about what to expect. At that "crawling" stage, when I said "ls -R afile" then I expected it to report all occurrences of afile in the directory tree.

I now realise (from forum help) that when used in that way, the name should be that of a directory, not a file. Then it will find all directories/subdirectories having that name.

Support multiple commands with same name

We might get a situation where there are duplicate commands with the same name. (eg: fc for Linux/macOS is different from fc for Windows)

The app should handle that.

In particular:

  • "dynamic quick actions" (created by the Shortcuts class, and appear when 3D-touching the app icon) be able to identify the correct command, even if two commands have the same name
  • this means the Preferences class also needs to identify the correct command when it keeps a list of the latest commands seen
  • ... which implies that we need a way of uniquely identifying a command, not by its name

Potential solutions

  • maybe change the app so it identifies commands by command-name and platform-name, instead of just command-name

Implications

  • "See Also" finds related commands by name, so if there are multiple commands with that name, it might need to show them all
  • Spotlight search will show multiple commands with the same name - tapping on a result should open the correct command
  • Favourites will need to change too

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.