Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS Update: Documentation Macros.tid #3767

Closed
wants to merge 72 commits into from

Conversation

00SS
Copy link
Contributor

@00SS 00SS commented Feb 14, 2019

Reformatting, additions etc. as detailed in Issue #3711

bimlas and others added 30 commits December 10, 2018 09:20
The core module tiddlers are not blocked, they are only marked.
Fix outdated external-js template.

Add the missing raw markup sections:
  * the top of the head
  * the top of the body
  * the bottom of the body
* Create howto.tid

Howto explains customising the languages supported by the highlight plugin. This involves:

* Using the highlight.js download page to get a zip archive containing the files for a highlight.js server which supports a set of languages selected by the user
* Replacing the highlight plugin's `highlight.pack.js` file with the `highlight.pack.js` file from the downloaded archive

* Update plugin.info

Add howto.
It turns out that we don't need to disable any scroll anchoring done by the browser as our implementation of scroll anchoring will adapt itself.

Also removing an unneeded paragraph tag from the view template.
From the readme:

This plugin enables TiddlyWiki to embed a modified copy of itself (an "innerwiki"). The primary motivation is to be able to produce screenshot illustrations that are automatically up-to-date with the appearance of TiddlyWiki as it changes over time, or to produce the same screenshot in different languages
Made this new PR for for the master branch, and closed TiddlyWiki#3697 
This PR is needed for text shown in the update PR TiddlyWiki#3680 which is for the tiddlywiki-com branch
* get-index: Enable deflate and gzip compression

* Spaces -> Tabs

* listen: Add optional `gzip=yes` parameter (defaults to "no")

* get-index: Add comment explaining the usage of `zlib.*Sync` instead of async.
We were getting some problems on Firefox/Safari whereby tiddlers would flicker between visible and invisible, spinning up my laptop fan.
…ki#3745)

in the group this bug was reported

when the stateTitle is missing it tries to get a field string of an undefined tiddler ...
…Wiki#3654)

* fixing 3648 - now non updated references are shown only when non zero

Signed-off-by: Diego Mesa <[email protected]>

* change to list widget

As per @Jermolene comments I changed to the list widget

* Putting back the accidently removed title (will no longer use github interface).

Signed-off-by: Diego Mesa <[email protected]>

* making sure I dont overwrite currentTiddler

Signed-off-by: Diego Mesa <[email protected]>
So that they are available to code running earlier in the boot process
Simon Huber and others added 8 commits February 8, 2019 16:11
…yWiki#3756)

* add optional tabindex attribute to factory.js

* add changedAttributes.tabindex to refresh mechanic

* add optional tabindex attribute to edit widget

* remove some extra whitespace

* remove some trailing whitespace

* add optional tabindex attribute to simple engine

* add optional tabindex attribute to framed engine

* add optional tabindex attribute to cm engine
* Add advanced search canned filter for "tiddlers modified this session"
Reformatting, additions etc. as detailed in Issue TiddlyWiki#3711
@00SS
Copy link
Contributor Author

00SS commented Feb 14, 2019

I've been steadily working on these for a few months. Please see Issue #3711 for the background.

These 3 modified tiddlers can be seen & tested here: https://00ss.github.io/documentation/tiddlywiki.html

I kept track of most changes, but there were many and I have missed noting down a few. The changes that have a possibility of breaking something are in the doc-macros tiddler but the changes there can easily be seen when comparing the old and new versions.

One pleasant improvement is how icons/image buttons are displayed. Their SVG size and vertical alignment style has been adjusted to sit more naturally in their surrounding text.
.doc-button svg { height: 1.3em; vertical-align: text-bottom; }

To get an idea, compare these two versions of Creating and editing tiddlers: Original vs New Look

00SS added 3 commits February 14, 2019 18:07
Corrected .flink & .wlink macros
Corrected the tooltip text for `<<.image-button ...>>` macro
Added missing parameter is the display Example for <<.link ...>>
@00SS
Copy link
Contributor Author

00SS commented Apr 7, 2019

@Jermolene
It would be useful if this PR could be merged so that I can begin the next phase of Documentation for Beginners.
A preview of them can be seen here:
https://00ss.github.io/documentation/tiddlywiki.html

@Jermolene
Copy link
Member

Hi @00SS thanks for this.

I notice that this PR targets the "master" branch, and just wondering if that's what we want. It would mean that all other dependent PRs will have to be merged to "master" rather than "tiddlywiki-com", which means that they won't be published until the next release. As long as you're only modifying files under editions/tw5.com perhaps we'd be better off targetting "tiddlywiki-com"?

@Jermolene
Copy link
Member

Hi @00SS some of the new styles seem a bit low contrast:

Screenshot 2019-04-10 09 35 59

We should be trying to observe the WCAG guidelines on colour contrast, although there are certainly places where we break them.

@00SS
Copy link
Contributor Author

00SS commented Apr 10, 2019

some of the new styles seem a bit low contrast:

I thought about the contrast colour carefully before choosing this one.
This Documentation Macros tiddler has become quite large and intimidating.
If the maro examples are also black text, finding the right macro to use becomes even harder.
The macro examples are really a last resort - and basically for very new writers of Documentation who still haven't got the hang on how to use them. Once they have been used a few times, those are really not going to be looked at much again. But if they are not available, it makes a new contributor quite lost.

Thus I wanted them to be un-intrusive and almost background info.

perhaps we'd be better off targetting "tiddlywiki-com"?

Thanks for spotting that! I will change them to the tiddlywiki-com branch.

Thank you also for making the time to get these going!

@Jermolene
Copy link
Member

Thus I wanted them to be un-intrusive and almost background info.

I sympathise! This is a dense tiddler with lots of information and it is hard to get it right. Nonetheless, I think we should increase the contrast a little.

@00SS 00SS changed the base branch from master to tiddlywiki-com April 10, 2019 11:06
Changed the display colour of the macro examples from very light gray to a darker gray #696969 for .doc-code-disp
@00SS
Copy link
Contributor Author

00SS commented Apr 11, 2019

Hope I have correctly changed the base branch!
I darkened the code display from very light gray to #696969 - It looks better now!

The change can be seen in the preview: https://00ss.github.io/documentation/tiddlywiki.html

@00SS
Copy link
Contributor Author

00SS commented Apr 19, 2019

@Jermolene
I made the change suggested.
Changing the base branch did some strange things above.
Can this be safely merged? Or should I resubmit this?

@00SS 00SS closed this Apr 22, 2019
@00SS 00SS deleted the patch-7 branch April 22, 2019 15:46
@Jermolene
Copy link
Member

Hi @00SS I noticed that you've closed quite a few PRs. My apologies for my slow progress in merging them -- you'll have noticed that I'm slow on everything, not just yours! I appreciate the frustration that results from this, and would like to reassure you that my slowness in merging is entirely my fault, and doesn't reflect on the high quality of your work. If you've the time, perhaps we can schedule a chat in the next few days to discuss things?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.